value} public function __construct($sId) { $this->sId = $sId; $this->bRedrawNeeded = true; // By default: redraw each time a property changes $this->bFormRedrawNeeded = false; // By default: no need to redraw the form (independent fields) $this->aProperties = array(); // By default: there is no property } // Assuming that a property has the type of its default value, set in the constructor // public function Str2Prop($sProperty, $sValue) { $refValue = $this->aProperties[$sProperty]; $sRefType = gettype($refValue); if ($sRefType == 'boolean') { $ret = ($sValue == 'true'); } else { $ret = $sValue; settype($ret, $sRefType); } return $ret; } public function Prop2Str($value) { if (gettype($value) == 'boolean') { $sRet = $value ? 'true' : 'false'; } else { $sRet = (string) $value; } return $sRet; } public function FromDOMNode($oDOMNode) { foreach ($this->aProperties as $sProperty => $value) { $this->oDOMNode = $oDOMNode->getElementsByTagName($sProperty)->item(0); if ($this->oDOMNode != null) { $newvalue = $this->Str2Prop($sProperty, $this->oDOMNode->textContent); $this->aProperties[$sProperty] = $newvalue; } } } public function ToDOMNode($oDOMNode) { foreach ($this->aProperties as $sProperty => $value) { $sXmlValue = $this->Prop2Str($value); $oPropNode = $oDOMNode->ownerDocument->createElement($sProperty, $sXmlValue); $oDOMNode->appendChild($oPropNode); } } public function FromXml($sXml) { $oDomDoc = new DOMDocument('1.0', 'UTF-8'); $oDomDoc->loadXml($sXml); $this->FromDOMNode($oDomDoc->firstChild); } public function FromParams($aParams) { foreach ($this->aProperties as $sProperty => $value) { if (array_key_exists($sProperty, $aParams)) { $this->aProperties[$sProperty] = $aParams[$sProperty]; } } } public function DoRender($oPage, $bEditMode = false, $aExtraParams = array()) { if ($bEditMode) { $sId = $this->GetID(); $oPage->add('
'); } else { $oPage->add('
'); } $this->Render($oPage, $bEditMode, $aExtraParams); $oPage->add('
'); if ($bEditMode) { $sClass = get_class($this); $oPage->add_ready_script( <<sId; } abstract public function Render($oPage, $bEditMode = false, $aExtraParams = array()); abstract public function GetPropertiesFields(DesignerForm $oForm); public function ToXml(DOMNode $oContainerNode) { } public function Update($aValues, $aUpdatedFields) { foreach($aUpdatedFields as $sProp) { if (array_key_exists($sProp, $this->aProperties)) { $this->aProperties[$sProp] = $aValues[$sProp]; } } return $this; } public function IsRedrawNeeded() { return $this->bRedrawNeeded; } public function IsFormRedrawNeeded() { return $this->bFormRedrawNeeded; } static public function GetInfo() { return array( 'label' => '', 'icon' => '', 'description' => '', ); } public function GetForm() { $oForm = new DesignerForm(); $oForm->SetPrefix("dashlet_". $this->GetID()); $oForm->SetParamsContainer('params'); $this->GetPropertiesFields($oForm); $oDashletClassField = new DesignerHiddenField('dashlet_class', '', get_class($this)); $oForm->AddField($oDashletClassField); $oDashletIdField = new DesignerHiddenField('dashlet_id', '', $this->GetID()); $oForm->AddField($oDashletIdField); return $oForm; } static public function IsVisible() { return true; } } class DashletEmptyCell extends Dashlet { public function __construct($sId) { parent::__construct($sId); } public function Render($oPage, $bEditMode = false, $aExtraParams = array()) { $oPage->add(' '); } public function GetPropertiesFields(DesignerForm $oForm) { } static public function GetInfo() { return array( 'label' => 'Empty Cell', 'icon' => 'images/dashlet-text.png', 'description' => 'Empty Cell Dashlet Placeholder', ); } static public function IsVisible() { return false; } } class DashletHelloWorld extends Dashlet { public function __construct($sId) { parent::__construct($sId); $this->aProperties['text'] = 'Hello World'; } public function Render($oPage, $bEditMode = false, $aExtraParams = array()) { $oPage->add('
'.$this->aProperties['text'].'
'); } public function GetPropertiesFields(DesignerForm $oForm) { $oField = new DesignerTextField('text', 'Text', $this->aProperties['text']); $oForm->AddField($oField); } static public function GetInfo() { return array( 'label' => 'Hello World', 'icon' => 'images/dashlet-text.png', 'description' => 'Hello World test Dashlet', ); } } class DashletObjectList extends Dashlet { public function __construct($sId) { parent::__construct($sId); $this->aProperties['title'] = 'Hardcoded list of "my requests"'; $this->aProperties['query'] = 'SELECT UserRequest AS i WHERE i.caller_id = :current_contact_id AND status NOT IN ("closed", "resolved")'; $this->aProperties['menu'] = false; } public function Render($oPage, $bEditMode = false, $aExtraParams = array()) { $sTitle = $this->aProperties['title']; $sQuery = $this->aProperties['query']; $sShowMenu = $this->aProperties['menu'] ? '1' : '0'; $oPage->add('
'); // C'est quoi ce paramètre "menu" ? $sXML = ''.$sQuery.''; $aParams = array(); $sBlockId = 'block_'.$this->sId.($bEditMode ? '_edit' : ''); // make a unique id (edition occuring in the same DOM) $oBlock = DisplayBlock::FromTemplate($sXML); $oBlock->Display($oPage, $sBlockId, $aParams); $oPage->add('
'); } public function GetPropertiesFields(DesignerForm $oForm) { $oField = new DesignerTextField('title', 'Title', $this->aProperties['title']); $oForm->AddField($oField); $oField = new DesignerTextField('query', 'Query', $this->aProperties['query']); $oForm->AddField($oField); $oField = new DesignerBooleanField('menu', 'Menu', $this->aProperties['menu']); $oForm->AddField($oField); } static public function GetInfo() { return array( 'label' => 'Object list', 'icon' => 'images/dashlet-object-list.png', 'description' => 'Object list dashlet', ); } } abstract class DashletGroupBy extends Dashlet { public function __construct($sId) { parent::__construct($sId); $this->aProperties['title'] = 'Hardcoded list of Contacts grouped by location'; $this->aProperties['query'] = 'SELECT Contact'; $this->aProperties['group_by'] = 'location_name'; $this->aProperties['style'] = 'table'; } public function Render($oPage, $bEditMode = false, $aExtraParams = array()) { $sTitle = $this->aProperties['title']; $sQuery = $this->aProperties['query']; $sGroupBy = $this->aProperties['group_by']; $sStyle = $this->aProperties['style']; if ($sQuery == '') { $oPage->add('

Please enter a valid OQL query

'); } elseif ($sGroupBy == '') { $oPage->add('

Please select the field on which the objects will be grouped together

'); } else { switch($sStyle) { case 'bars': $sXML = ''.$sQuery.''; $sHtmlTitle = ''; // done in the itop block break; case 'pie': $sXML = ''.$sQuery.''; $sHtmlTitle = ''; // done in the itop block break; case 'table': default: $sHtmlTitle = htmlentities(Dict::S($sTitle), ENT_QUOTES, 'UTF-8'); // done in the itop block $sXML = ''.$sQuery.''; break; } $oPage->add('
'); if ($sHtmlTitle != '') { $oPage->add('

'.$sHtmlTitle.'

'); } $aParams = array(); $sBlockId = 'block_'.$this->sId.($bEditMode ? '_edit' : ''); // make a unique id (edition occuring in the same DOM) $oBlock = DisplayBlock::FromTemplate($sXML); $oBlock->Display($oPage, $sBlockId, $aParams); $oPage->add('
'); // TEST Group By as SQL! //$oSearch = DBObjectSearch::FromOQL($this->aProperties['query']); //$sSql = MetaModel::MakeSelectQuery($oSearch); //$sHtmlSql = htmlentities($sSql, ENT_QUOTES, 'UTF-8'); //$oPage->p($sHtmlSql); } } public function GetPropertiesFields(DesignerForm $oForm) { $oField = new DesignerTextField('title', 'Title', $this->aProperties['title']); $oForm->AddField($oField); $oField = new DesignerTextField('query', 'Query', $this->aProperties['query']); $oForm->AddField($oField); // Group by field: build the list of possible values (attribute codes + ...) $oSearch = DBObjectSearch::FromOQL($this->aProperties['query']); $sClass = $oSearch->GetClass(); $aGroupBy = array(); foreach(MetaModel::ListAttributeDefs($sClass) as $sAttCode => $oAttDef) { if (!$oAttDef->IsScalar()) continue; // skip link sets if ($oAttDef->IsExternalKey(EXTKEY_ABSOLUTE)) continue; // skip external keys $aGroupBy[$sAttCode] = $oAttDef->GetLabel(); if ($oAttDef instanceof AttributeDateTime) { //date_format(start_date, '%d') $aGroupBy['date_of_'.$sAttCode] = 'Day of '.$oAttDef->GetLabel(); } } $oField = new DesignerComboField('group_by', 'Group by', $this->aProperties['group_by']); $oField->SetAllowedValues($aGroupBy); $oForm->AddField($oField); $aStyles = array( 'pie' => 'Pie chart', 'bars' => 'Bar chart', 'table' => 'Table', ); $oField = new DesignerComboField('style', 'Style', $this->aProperties['style']); $oField->SetAllowedValues($aStyles); $oForm->AddField($oField); } public function Update($aValues, $aUpdatedFields) { if (in_array('query', $aUpdatedFields)) { $sCurrQuery = $aValues['query']; $oCurrSearch = DBObjectSearch::FromOQL($sCurrQuery); $sCurrClass = $oCurrSearch->GetClass(); $sPrevQuery = $this->aProperties['query']; $oPrevSearch = DBObjectSearch::FromOQL($sPrevQuery); $sPrevClass = $oPrevSearch->GetClass(); if ($sCurrClass != $sPrevClass) { $this->bFormRedrawNeeded = true; // wrong but not necessary - unset($aUpdatedFields['group_by']); $this->aProperties['group_by'] = ''; } } $oDashlet = parent::Update($aValues, $aUpdatedFields); if (in_array('style', $aUpdatedFields)) { switch($aValues['style']) { // Style changed, mutate to the specified type of chart case 'pie': $oDashlet = new DashletGroupByPie($this->sId); break; case 'bars': $oDashlet = new DashletGroupByBars($this->sId); break; case 'table': $oDashlet = new DashletGroupByTable($this->sId); break; } $oDashlet->FromParams($aValues); $oDashlet->bRedrawNeeded = true; $oDashlet->bFormRedrawNeeded = true; } return $oDashlet; } static public function GetInfo() { return array( 'label' => 'Objects grouped by...', 'icon' => 'images/dashlet-object-grouped.png', 'description' => 'Grouped objects dashlet', ); } } class DashletGroupByPie extends DashletGroupBy { public function __construct($sId) { parent::__construct($sId); $this->aProperties['style'] = 'pie'; } static public function GetInfo() { return array( 'label' => 'Pie Chart', 'icon' => 'images/dashlet-pie-chart.png', 'description' => 'Pie Chart', ); } } class DashletGroupByBars extends DashletGroupBy { public function __construct($sId) { parent::__construct($sId); $this->aProperties['style'] = 'bars'; } static public function GetInfo() { return array( 'label' => 'Bar Chart', 'icon' => 'images/dashlet-bar-chart.png', 'description' => 'Bar Chart', ); } } class DashletGroupByTable extends DashletGroupBy { public function __construct($sId) { parent::__construct($sId); $this->aProperties['style'] = 'table'; } static public function GetInfo() { return array( 'label' => 'Group By (table)', 'icon' => 'images/dashlet-group-by-table.png', 'description' => 'List (Grouped by a field)', ); } } class DashletHeader extends Dashlet { public function __construct($sId) { parent::__construct($sId); $this->aProperties['title'] = 'Hardcoded header of contacts'; $this->aProperties['subtitle'] = 'Contacts'; $this->aProperties['class'] = 'Contact'; } public function Render($oPage, $bEditMode = false, $aExtraParams = array()) { $sTitle = $this->aProperties['title']; $sSubtitle = $this->aProperties['subtitle']; $sClass = $this->aProperties['class']; $sTitleReady = str_replace(':', '_', $sTitle); $sSubtitleReady = str_replace(':', '_', $sSubtitle); $sStatusAttCode = MetaModel::GetStateAttributeCode($sClass); if (($sStatusAttCode == '') && MetaModel::IsValidAttCode($sClass, 'status')) { // Based on an enum $sStatusAttCode = 'status'; $aStates = array_keys(MetaModel::GetAllowedValues_att($sClass, $sStatusAttCode)); } else { // Based on a state variable $aStates = array_keys(MetaModel::EnumStates($sClass)); } if ($sStatusAttCode == '') { // Simple stats $sXML = 'SELECT '.$sClass.''; } else { // Stats grouped by "status" $sStatusList = implode(',', $aStates); //$oPage->p('State: '.$sStatusAttCode.' states='.$sStatusList); $sXML = 'SELECT '.$sClass.''; } $oPage->add('
'); $aParams = array(); $sBlockId = 'block_'.$this->sId.($bEditMode ? '_edit' : ''); // make a unique id (edition occuring in the same DOM) $oBlock = DisplayBlock::FromTemplate($sXML); $oBlock->Display($oPage, $sBlockId, $aParams); $oPage->add('
'); } public function GetPropertiesFields(DesignerForm $oForm) { $oField = new DesignerTextField('title', 'Title', $this->aProperties['title']); $oForm->AddField($oField); $oField = new DesignerTextField('subtitle', 'Subtitle', $this->aProperties['subtitle']); $oForm->AddField($oField); $oField = new DesignerTextField('class', 'Class', $this->aProperties['class']); $oForm->AddField($oField); } static public function GetInfo() { return array( 'label' => 'Header with stats', 'icon' => 'images/dashlet-header-stats.png', 'description' => 'Header with stats (grouped by...)', ); } }