diff --git a/application/dashboard.class.inc.php b/application/dashboard.class.inc.php index fcc1cd4787..56e09abd62 100644 --- a/application/dashboard.class.inc.php +++ b/application/dashboard.class.inc.php @@ -100,10 +100,10 @@ abstract class Dashboard $oCellsList = $oCellsNode->getElementsByTagName('cell'); $aCellOrder = array(); $iCellRank = 0; + /** @var \DOMElement $oCellNode */ foreach($oCellsList as $oCellNode) { - $aDashletList = array(); - $oCellRank = $oCellNode->getElementsByTagName('rank')->item(0); + $oCellRank = $oCellNode->getElementsByTagName('rank')->item(0); if ($oCellRank) { $iCellRank = (float)$oCellRank->textContent; @@ -113,6 +113,7 @@ abstract class Dashboard $oDashletList = $oDashletsNode->getElementsByTagName('dashlet'); $iRank = 0; $aDashletOrder = array(); + /** @var \DOMElement $oDomNode */ foreach($oDashletList as $oDomNode) { $oRank = $oDomNode->getElementsByTagName('rank')->item(0); @@ -145,6 +146,11 @@ abstract class Dashboard } } + /** + * @param \DOMElement $oDomNode + * + * @return mixed + */ protected function InitDashletFromDOMNode($oDomNode) { $sId = $oDomNode->getAttribute('id'); @@ -152,7 +158,8 @@ abstract class Dashboard // Test if dashlet can be instanciated, otherwise (uninstalled, broken, ...) we display a placeholder $sClass = static::GetDashletClassFromType($sDashletType); - $oNewDashlet = new $sClass($this->oMetaModel, $sId); + /** @var \Dashlet $oNewDashlet */ + $oNewDashlet = new $sClass($this->oMetaModel, $sId); $oNewDashlet->SetDashletType($sDashletType); $oNewDashlet->FromDOMNode($oDomNode); @@ -163,8 +170,17 @@ abstract class Dashboard { return ($aItem1['rank'] > $aItem2['rank']) ? +1 : -1; } + /** * Error handler to turn XML loading warnings into exceptions + * + * @param $errno + * @param $errstr + * @param $errfile + * @param $errline + * + * @return bool + * @throws \DOMException */ public static function ErrorHandler($errno, $errstr, $errfile, $errline) { @@ -194,8 +210,12 @@ abstract class Dashboard return $sXml; } + /** + * @param \DOMElement $oDefinition + */ public function ToDOMNode($oDefinition) { + /** @var \DOMDocument $oDoc */ $oDoc = $oDefinition->ownerDocument; $oNode = $oDoc->createElement('layout', $this->sLayoutClass); @@ -227,6 +247,7 @@ abstract class Dashboard $iDashletRank = 0; $oDashletsNode = $oDoc->createElement('dashlets'); $oCellNode->appendChild($oDashletsNode); + /** @var \Dashlet $oDashlet */ foreach ($aCell as $oDashlet) { $oNode = $oDoc->createElement('dashlet'); @@ -256,6 +277,7 @@ abstract class Dashboard { $sDashletClass = $aDashletParams['dashlet_class']; $sId = $aDashletParams['dashlet_id']; + /** @var \Dashlet $oNewDashlet */ $oNewDashlet = new $sDashletClass($this->oMetaModel, $sId); if (isset($aDashletParams['dashlet_type'])) { @@ -318,17 +340,26 @@ abstract class Dashboard $this->iAutoReloadSec = max(MetaModel::GetConfig()->Get('min_reload_interval'), (int)$iAutoReloadSec); } + /** + * @param \Dashlet $oDashlet + */ public function AddDashlet($oDashlet) { $sId = $this->GetNewDashletId(); $oDashlet->SetId($sId); $this->aCells[] = array($oDashlet); } - + + /** + * @param \WebPage $oPage + * @param bool $bEditMode + * @param array $aExtraParams + */ public function Render($oPage, $bEditMode = false, $aExtraParams = array()) { $oPage->add('

'.htmlentities(Dict::S($this->sTitle), ENT_QUOTES, 'UTF-8', false).'

'); $oLayout = new $this->sLayoutClass; + /** @var \DashboardLayoutMultiCol $oLayout */ $oLayout->Render($oPage, $this->aCells, $bEditMode, $aExtraParams); if (!$bEditMode) { @@ -336,7 +367,12 @@ abstract class Dashboard $oPage->add_linked_script('../js/dashboard.js'); } } - + + /** + * @param \WebPage $oPage + * + * @throws \ReflectionException + */ public function RenderProperties($oPage) { // menu to pick a layout and edit other properties of the dashboard @@ -423,7 +459,7 @@ EOF ); } - public function RenderDashletsSelection($oPage) + public function RenderDashletsSelection(WebPage $oPage) { // Toolbox/palette to drag and drop dashlets $oPage->add('
'.Dict::S('UI:DashboardEdit:Dashlets').'
'); @@ -441,7 +477,7 @@ EOF $oPage->add_ready_script("$('.dashlet_icon').draggable({helper: 'clone', appendTo: 'body', zIndex: 10000, revert:'invalid'});"); } - public function RenderDashletsProperties($oPage) + public function RenderDashletsProperties(WebPage $oPage) { // Toolbox/palette to edit the properties of each dashlet $oPage->add('
'.Dict::S('UI:DashboardEdit:DashletProperties').'
'); @@ -449,10 +485,10 @@ EOF $oPage->add('
'); foreach($this->aCells as $aCell) { + /** @var \Dashlet $oDashlet */ foreach($aCell as $oDashlet) { $sId = $oDashlet->GetID(); - $sClass = get_class($oDashlet); if ($oDashlet->IsVisible()) { $oPage->add('