tyler.durden/icingaweb2-module-director
1
0
Fork 0
mirror of https://github.com/Icinga/icingaweb2-module-director.git synced 2025-07-28 08:14:04 +02:00
Code Issues Packages Projects Releases Wiki Activity

Dashlet: base code on ipl\BaseElement

Browse Source
This commit is contained in:
Thomas Gelf 2017-06-14 15:57:35 +02:00
parent 04bbe90adf
commit 9c45485b5b
1 changed files with 51 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

98
library/Director/Dashboard/Dashlet/Dashlet.php
View File

@ -4,20 +4,27 @@ namespace Icinga\Module\Director\Dashboard\Dashlet;
use DirectoryIterator; use DirectoryIterator;
use Icinga\Exception\ProgrammingError; use Icinga\Exception\ProgrammingError;
use Icinga\Web\View;
use Icinga\Module\Director\Acl; use Icinga\Module\Director\Acl;
use Icinga\Module\Director\Dashboard\Dashboard; use Icinga\Module\Director\Dashboard\Dashboard;
use ipl\Html\BaseElement;
use ipl\Html\Html;
use ipl\Html\Icon;
use ipl\Html\Link;
use ipl\Translation\TranslationHelper;
abstract class Dashlet abstract class Dashlet extends BaseElement
{ {
use TranslationHelper;
protected $tag = 'li';
protected $sectionName; protected $sectionName;
protected $icon = 'help'; protected $icon = 'help';
protected $supportsLegacyConfig; protected $supportsLegacyConfig;
protected $view; /** @var \Icinga\Module\Director\Db */
protected $db; protected $db;
protected $stats; protected $stats;
@ -26,7 +33,6 @@ abstract class Dashlet
public function __construct(Dashboard $dashboard) public function __construct(Dashboard $dashboard)
{ {
$this->view = $dashboard->getView();
$this->db = $dashboard->getDb(); $this->db = $dashboard->getDb();
} }
@ -43,6 +49,11 @@ abstract class Dashlet
$this->stats[$type] = $stats; $this->stats[$type] = $stats;
} }
/**
* @deprecated This is obsolete, should not be used
* @param Dashboard $dashboard
* @return array
*/
public static function loadAll(Dashboard $dashboard) public static function loadAll(Dashboard $dashboard)
{ {
$dashlets = array(); $dashlets = array();
@ -76,6 +87,7 @@ abstract class Dashlet
$dashlets = array(); $dashlets = array();
foreach ($names as $name) { foreach ($names as $name) {
$class = $prefix . $name . 'Dashlet'; $class = $prefix . $name . 'Dashlet';
/** @var Dashlet $dashlet */
$dashlet = new $class($dashboard); $dashlet = new $class($dashboard);
if ($dashlet->isAllowed()) { if ($dashlet->isAllowed()) {
@ -121,12 +133,26 @@ abstract class Dashlet
return $this->icon; return $this->icon;
} }
public function render() abstract public function getTitle();
abstract public function getUrl();
public function renderContent()
{ {
return $this->view->partial( $this->add(
'dashlets/' . $this->getViewScript() . '.phtml', Link::create(
array('dashlet' => $this) [
$this->getTitle(),
Icon::create($this->getIconName()),
Html::tag('p', null, $this->getSummary())
],
$this->getUrl(),
null,
['class' => $this->listCssClasses()]
)
); );
return parent::renderContent();
} }
public function listRequiredPermissions() public function listRequiredPermissions()
@ -134,11 +160,6 @@ abstract class Dashlet
return array($this->getUrl()); return array($this->getUrl());
} }
public function getViewScript()
{
return 'default';
}
public function isAllowed() public function isAllowed()
{ {
$acl = Acl::instance(); $acl = Acl::instance();
@ -166,18 +187,6 @@ abstract class Dashlet
return $result; return $result;
} }
public function getEscapedSummary()
{
return $this->view->escape(
$this->getSummary()
);
}
protected function translate($msg)
{
return $this->view->translate($msg);
}
public function getStats($type, $name = null) public function getStats($type, $name = null)
{ {
if ($name === null) { if ($name === null) {
@ -189,66 +198,61 @@ abstract class Dashlet
protected function getTemplateSummaryText($type) protected function getTemplateSummaryText($type)
{ {
$view = $this->view;
$stat = $this->stats[$type];
$cnt = (int) $this->stats[$type]->cnt_template; $cnt = (int) $this->stats[$type]->cnt_template;
if ($cnt === 0) { if ($cnt === 0) {
return $view->translate('No template has been defined yet'); return $this->translate('No template has been defined yet');
} }
if ($cnt === 1) { if ($cnt === 1) {
return $view->translate('One template has been defined'); return $this->translate('One template has been defined');
} }
return sprintf( return sprintf(
$view->translate('%d templates have been defined'), $this->translate('%d templates have been defined'),
$cnt $cnt
); );
} }
protected function getApplySummaryText($type) protected function getApplySummaryText($type)
{ {
$view = $this->view;
$stat = $this->stats[$type];
$cnt = (int) $this->stats[$type]->cnt_apply; $cnt = (int) $this->stats[$type]->cnt_apply;
if ($cnt === 0) { if ($cnt === 0) {
return $view->translate('No apply rule has been defined yet'); return $this->translate('No apply rule has been defined yet');
} }
if ($cnt === 1) { if ($cnt === 1) {
return $view->translate('One apply rule has been defined'); return $this->translate('One apply rule has been defined');
} }
return sprintf( return sprintf(
$view->translate('%d apply rules have been defined'), $this->translate('%d apply rules have been defined'),
$cnt $cnt
); );
} }
protected function statSummary($type) protected function statSummary($type)
{ {
$view = $this->view;
$stat = $this->stats[$type]; $stat = $this->stats[$type];
if ((int) $stat->cnt_total === 0) { if ((int) $stat->cnt_total === 0) {
return $view->translate('No object has been defined yet'); return $this->translate('No object has been defined yet');
} }
if ((int) $stat->cnt_total === 1) { if ((int) $stat->cnt_total === 1) {
if ($stat->cnt_template > 0) { if ($stat->cnt_template > 0) {
$msg = $view->translate('One template has been defined'); $msg = $this->translate('One template has been defined');
} elseif ($stat->cnt_external > 0) { } elseif ($stat->cnt_external > 0) {
$msg = $view->translate( $msg = $this->translate(
'One external object has been defined, it will not be deployed' 'One external object has been defined, it will not be deployed'
); );
} else { } else {
$msg = $view->translate('One object has been defined'); $msg = $this->translate('One object has been defined');
} }
} else { } else {
$msg = sprintf( $msg = sprintf(
$view->translate('%d objects have been defined'), $this->translate('%d objects have been defined'),
$stat->cnt_total $stat->cnt_total
); );
} }
@ -257,14 +261,14 @@ abstract class Dashlet
if ($stat->cnt_total !== $stat->cnt_object) { if ($stat->cnt_total !== $stat->cnt_object) {
if ($stat->cnt_template > 0) { if ($stat->cnt_template > 0) {
$extra[] = sprintf( $extra[] = sprintf(
$view->translate('%d of them are templates'), $this->translate('%d of them are templates'),
$stat->cnt_template $stat->cnt_template
); );
} }
if ($stat->cnt_external > 0) { if ($stat->cnt_external > 0) {
$extra[] = sprintf( $extra[] = sprintf(
$view->translate( $this->translate(
'%d have been externally defined and will not be deployed' '%d have been externally defined and will not be deployed'
), ),
$stat->cnt_external $stat->cnt_external
@ -275,12 +279,12 @@ abstract class Dashlet
if (array_key_exists($type . 'group', $this->stats)) { if (array_key_exists($type . 'group', $this->stats)) {
$groupstat = $this->stats[$type . 'group']; $groupstat = $this->stats[$type . 'group'];
if ((int) $groupstat->cnt_total === 0) { if ((int) $groupstat->cnt_total === 0) {
$extra[] = $view->translate('no related group exists'); $extra[] = $this->translate('no related group exists');
} elseif ((int) $groupstat->cnt_total === 1) { } elseif ((int) $groupstat->cnt_total === 1) {
$extra[] = $view->translate('one related group exists'); $extra[] = $this->translate('one related group exists');
} else { } else {
$extra[] = sprintf( $extra[] = sprintf(
$view->translate('%s related group objects have been created'), $this->translate('%s related group objects have been created'),
$groupstat->cnt_total $groupstat->cnt_total
); );
} }