require_once(APPROOT.'application/dashboardlayout.class.inc.php'); require_once(APPROOT.'application/dashlet.class.inc.php'); require_once(APPROOT.'core/modelreflection.class.inc.php'); /** * A user editable dashboard page * * @copyright Copyright (C) 2010-2012 Combodo SARL * @license http://opensource.org/licenses/AGPL-3.0 */ abstract class Dashboard { protected $sTitle; protected $bAutoReload; protected $iAutoReloadSec; protected $sLayoutClass; protected $aWidgetsData; protected $oDOMNode; protected $sId; protected $aCells; protected $oMetaModel; public function __construct($sId) { $this->sTitle = ''; $this->sLayoutClass = 'DashboardLayoutOneCol'; $this->bAutoReload = false; $this->iAutoReloadSec = MetaModel::GetConfig()->GetStandardReloadInterval(); $this->aCells = array(); $this->oDOMNode = null; $this->sId = $sId; } public function FromXml($sXml) { $this->aCells = array(); // reset the content of the dashboard set_error_handler(array('Dashboard', 'ErrorHandler')); $oDoc = new DOMDocument(); $oDoc->loadXML($sXml); restore_error_handler(); $this->FromDOMDocument($oDoc); } public function FromDOMDocument(DOMDocument $oDoc) { $this->oDOMNode = $oDoc->getElementsByTagName('dashboard')->item(0); if ($oLayoutNode = $this->oDOMNode->getElementsByTagName('layout')->item(0)) { $this->sLayoutClass = $oLayoutNode->textContent; } else { $this->sLayoutClass = 'DashboardLayoutOneCol'; } if ($oTitleNode = $this->oDOMNode->getElementsByTagName('title')->item(0)) { $this->sTitle = $oTitleNode->textContent; } else { $this->sTitle = ''; } $this->bAutoReload = false; $this->iAutoReloadSec = MetaModel::GetConfig()->GetStandardReloadInterval(); if ($oAutoReloadNode = $this->oDOMNode->getElementsByTagName('auto_reload')->item(0)) { if ($oAutoReloadEnabled = $oAutoReloadNode->getElementsByTagName('enabled')->item(0)) { $this->bAutoReload = ($oAutoReloadEnabled->textContent == 'true'); } if ($oAutoReloadInterval = $oAutoReloadNode->getElementsByTagName('interval')->item(0)) { $this->iAutoReloadSec = max(MetaModel::GetConfig()->Get('min_reload_interval'), (int)$oAutoReloadInterval->textContent); } } if ($oCellsNode = $this->oDOMNode->getElementsByTagName('cells')->item(0)) { $oCellsList = $oCellsNode->getElementsByTagName('cell'); $aCellOrder = array(); $iCellRank = 0; foreach($oCellsList as $oCellNode) { $aDashletList = array(); $oCellRank = $oCellNode->getElementsByTagName('rank')->item(0); if ($oCellRank) { $iCellRank = (float)$oCellRank->textContent; } $oDashletsNode = $oCellNode->getElementsByTagName('dashlets')->item(0); { $oDashletList = $oDashletsNode->getElementsByTagName('dashlet'); $iRank = 0; $aDashletOrder = array(); foreach($oDashletList as $oDomNode) { $sDashletClass = $oDomNode->getAttribute('xsi:type'); $oRank = $oDomNode->getElementsByTagName('rank')->item(0); if ($oRank) { $iRank = (float)$oRank->textContent; } $sId = $oDomNode->getAttribute('id'); $oNewDashlet = new $sDashletClass($this->oMetaModel, $sId); $oNewDashlet->FromDOMNode($oDomNode); $aDashletOrder[] = array('rank' => $iRank, 'dashlet' => $oNewDashlet); } usort($aDashletOrder, array(get_class($this), 'SortOnRank')); $aDashletList = array(); foreach($aDashletOrder as $aItem) { $aDashletList[] = $aItem['dashlet']; } $aCellOrder[] = array('rank' => $iCellRank, 'dashlets' => $aDashletList); } } usort($aCellOrder, array(get_class($this), 'SortOnRank')); foreach($aCellOrder as $aItem) { $this->aCells[] = $aItem['dashlets']; } } else { $this->aCells = array(); } } static function SortOnRank($aItem1, $aItem2) { return ($aItem1['rank'] > $aItem2['rank']) ? +1 : -1; } /** * Error handler to turn XML loading warnings into exceptions */ public static function ErrorHandler($errno, $errstr, $errfile, $errline) { if ($errno == E_WARNING && (substr_count($errstr,"DOMDocument::loadXML()")>0)) { throw new DOMException($errstr); } else { return false; } } public function ToXml() { $oDoc = new DOMDocument(); $oDoc->formatOutput = true; // indent (must be loaded with option LIBXML_NOBLANKS) $oDoc->preserveWhiteSpace = true; // otherwise the formatOutput option would have no effect $oMainNode = $oDoc->createElement('dashboard'); $oMainNode->setAttribute('xmlns:xsi', "http://www.w3.org/2001/XMLSchema-instance"); $oDoc->appendChild($oMainNode); $this->ToDOMNode($oMainNode); $sXml = $oDoc->saveXML(); return $sXml; } public function ToDOMNode($oDefinition) { $oDoc = $oDefinition->ownerDocument; $oNode = $oDoc->createElement('layout', $this->sLayoutClass); $oDefinition->appendChild($oNode); $oNode = $oDoc->createElement('title', $this->sTitle); $oDefinition->appendChild($oNode); $oAutoReloadNode = $oDoc->createElement('auto_reload'); $oDefinition->appendChild($oAutoReloadNode); $oNode = $oDoc->createElement('enabled', $this->bAutoReload ? 'true' : 'false'); $oAutoReloadNode->appendChild($oNode); $oNode = $oDoc->createElement('interval', $this->iAutoReloadSec); $oAutoReloadNode->appendChild($oNode); $oCellsNode = $oDoc->createElement('cells'); $oDefinition->appendChild($oCellsNode); $iCellRank = 0; foreach ($this->aCells as $aCell) { $oCellNode = $oDoc->createElement('cell'); $oCellNode->setAttribute('id', $iCellRank); $oCellsNode->appendChild($oCellNode); $oCellRank = $oDoc->createElement('rank', $iCellRank); $oCellNode->appendChild($oCellRank); $iCellRank++; $iDashletRank = 0; $oDashletsNode = $oDoc->createElement('dashlets'); $oCellNode->appendChild($oDashletsNode); foreach ($aCell as $oDashlet) { $oNode = $oDoc->createElement('dashlet'); $oDashletsNode->appendChild($oNode); $oNode->setAttribute('id', $oDashlet->GetID()); $oNode->setAttribute('xsi:type', get_class($oDashlet)); $oDashletRank = $oDoc->createElement('rank', $iDashletRank); $oNode->appendChild($oDashletRank); $iDashletRank++; $oDashlet->ToDOMNode($oNode); } } } public function FromParams($aParams) { $this->sLayoutClass = $aParams['layout_class']; $this->sTitle = $aParams['title']; $this->bAutoReload = $aParams['auto_reload'] == 'true'; $this->iAutoReloadSec = max(MetaModel::GetConfig()->Get('min_reload_interval'), (int) $aParams['auto_reload_sec']); foreach($aParams['cells'] as $aCell) { $aCellDashlets = array(); foreach($aCell as $aDashletParams) { $sDashletClass = $aDashletParams['dashlet_class']; $sId = $aDashletParams['dashlet_id']; $oNewDashlet = new $sDashletClass($this->oMetaModel, $sId); $oForm = $oNewDashlet->GetForm(); $oForm->SetParamsContainer($sId); $oForm->SetPrefix(''); $aValues = $oForm->ReadParams(); $oNewDashlet->FromParams($aValues); $aCellDashlets[] = $oNewDashlet; } $this->aCells[] = $aCellDashlets; } } public function Save() { } public function GetLayout() { return $this->sLayoutClass; } public function SetLayout($sLayoutClass) { $this->sLayoutClass = $sLayoutClass; } public function GetTitle() { return $this->sTitle; } public function SetTitle($sTitle) { $this->sTitle = $sTitle; } public function GetAutoReload() { return $this->bAutoReload; } public function SetAutoReload($bAutoReload) { $this->bAutoReload = $bAutoReload; } public function GetAutoReloadInterval() { return $this->iAutoReloadSec; } public function SetAutoReloadInterval($iAutoReloadSec) { $this->iAutoReloadSec = max(MetaModel::GetConfig()->Get('min_reload_interval'), (int)$iAutoReloadSec); } public function AddDashlet($oDashlet) { $sId = $this->GetNewDashletId(); $oDashlet->SetId($sId); $this->aCells[] = array($oDashlet); } public function Render($oPage, $bEditMode = false, $aExtraParams = array()) { $oPage->add('