/** * Helper class to build interactive forms to be used either in stand-alone * modal dialog or in "property-sheet" panes. * * @copyright Copyright (C) 2010-2012 Combodo SARL * @license http://opensource.org/licenses/AGPL-3.0 */ class DesignerForm { protected $aFieldSets; protected $sCurrentFieldSet; protected $sScript; protected $sReadyScript; protected $sFormId; protected $sFormPrefix; protected $sParamsContainer; protected $oParentForm; protected $aSubmitParams; protected $sSubmitTo; protected $bReadOnly; protected $sHierarchyPath; // Needed to manage the visibility of nested subform protected $sHierarchyParent; // Needed to manage the visibility of nested subform protected $sHierarchySelector; // Needed to manage the visibility of nested subform protected $bDisplayed; protected $aDefaultValues; protected $sFieldsSuffix; public function __construct() { $this->aFieldSets = array(); $this->sCurrentFieldSet = ''; $this->sScript = ''; $this->sReadyScript = ''; $this->sFormPrefix = ''; $this->sFieldsSuffix = ''; $this->sParamsContainer = ''; $this->sFormId = 'form_'.rand(); $this->oParentForm = null; $this->bReadOnly = false; $this->sHierarchyPath = ''; $this->sHierarchyParent = ''; $this->sHierarchySelector = ''; $this->StartFieldSet($this->sCurrentFieldSet); $this->bDisplayed = true; $this->aDefaultvalues = array(); } public function AddField(DesignerFormField $oField) { if (!is_array($this->aFieldSets[$this->sCurrentFieldSet])) { $this->aFieldSets[$this->sCurrentFieldSet] = array(); } $this->aFieldSets[$this->sCurrentFieldSet][] = $oField; $oField->SetForm($this); } public function StartFieldSet($sLabel) { $this->sCurrentFieldSet = $sLabel; if (!array_key_exists($this->sCurrentFieldSet, $this->aFieldSets)) { $this->aFieldSets[$this->sCurrentFieldSet] = array(); } } public function Render($oP, $bReturnHTML = false) { if ($this->oParentForm == null) { $sFormId = $this->sFormId; $sReturn = '

'; } else { $sReturn = ''; $sFormId = $this->oParentForm->sFormId; } $sHiddenFields = ''; foreach($this->aFieldSets as $sLabel => $aFields) { $aDetails = array(); if ($sLabel != '') { $sReturn .= '

'; $sReturn .= ''.$sLabel.''; } foreach($aFields as $oField) { $aRow = $oField->Render($oP, $sFormId); if ($oField->IsVisible()) { $sValidation = ' '.$this->GetValidationArea($oField->GetFieldId()).''; $sField = $aRow['value'].$sValidation; $aDetails[] = array('label' => $aRow['label'], 'value' => $sField); } else { $sHiddenFields .= $aRow['value']; } } $sReturn .= $oP->GetDetails($aDetails); if ($sLabel != '') { $sReturn .= '

'; } } $sReturn .= $sHiddenFields; if ($this->oParentForm == null) { $sReturn .= '

'; } if($this->sScript != '') { $oP->add_script($this->sScript); } if($this->sReadyScript != '') { $oP->add_ready_script($this->sReadyScript); } if ($bReturnHTML) { return $sReturn; } else { $oP->add($sReturn); } } public function GetFieldSets() { return $this->aFieldSets; } public function SetSubmitParams($sSubmitToUrl, $aSubmitParams) { $this->sSubmitTo = $sSubmitToUrl; $this->aSubmitParams = $aSubmitParams; } public function CopySubmitParams($oParentForm) { $this->sSubmitTo = $oParentForm->sSubmitTo; $this->aSubmitParams = $oParentForm->aSubmitParams; } public function GetSubmitParams() { return array( 'url' => $this->sSubmitTo, 'params' => $this->aSubmitParams); } /** * Helper to handle subforms hide/show */ public function SetHierarchyPath($sHierarchy) { $this->sHierarchyPath = $sHierarchy; } /** * Helper to handle subforms hide/show */ public function GetHierarchyPath() { return $this->sHierarchyPath; } /** * Helper to handle subforms hide/show */ public function SetHierarchyParent($sHierarchy) { $this->sHierarchyParent = $sHierarchy; } /** * Helper to handle subforms hide/show */ public function GetHierarchyParent() { return $this->sHierarchyParent; } public function RenderAsPropertySheet($oP, $bReturnHTML = false, $sNotifyParentSelector = null) { $sReturn = ''; $sActionUrl = addslashes($this->sSubmitTo); $sJSSubmitParams = json_encode($this->aSubmitParams); if ($this->oParentForm == null) { $sFormId = $this->sFormId; $sReturn = '

'; $sReturn .= ''; $sReturn .= ''; } else { $sFormId = $this->oParentForm->sFormId; } $sHiddenFields = ''; foreach($this->aFieldSets as $sLabel => $aFields) { $aDetails = array(); if ($sLabel != '') { $sReturn .= $this->StartRow().''.$this->EndRow(); } foreach($aFields as $oField) { $aRow = $oField->Render($oP, $sFormId, 'property'); if ($oField->IsVisible()) { $sFieldId = $this->GetFieldId($oField->GetCode()); $sValidation = $this->GetValidationArea($sFieldId, ''); $sValidationFields = ''.$this->EndRow(); $sPath = $this->GetHierarchyPath().'/'.$oField->GetCode(); if (is_null($aRow['label'])) { $sReturn .= $this->StartRow($sFieldId).''; $sReturn .= '

'.Dict::S('UI:Form:Property').'	'.Dict::S('UI:Form:Value').'
'.$sLabel.'				'.$sValidation.'		'.$aRow['value']; } else { $sReturn .= $this->StartRow($sFieldId).'		'.$aRow['label'].'	'.$aRow['value']; } if (!($oField instanceof DesignerFormSelectorField) && !($oField instanceof DesignerMultipleSubFormField)) { $sReturn .= $sValidationFields; } $sNotifyParentSelectorJS = is_null($sNotifyParentSelector) ? 'null' : "'".addslashes($sNotifyParentSelector)."'"; $sAutoApply = $oField->IsAutoApply() ? 'true' : 'false'; $sHandlerEquals = $oField->GetHandlerEquals(); $sHandlerGetValue = $oField->GetHandlerGetValue(); $this->AddReadyScript( <<oParentForm == null) { $sFormId = $this->sFormId; $sReturn .= '

'; $sReturn .= $sHiddenFields; $sReturn .= '

'; $sReturn .= '

'; // for the return of the submit operation } else { $sReturn .= $sHiddenFields; } $this->AddReadyScript( <<sScript != '') { $oP->add_script($this->sScript); } if($this->sReadyScript != '') { $oP->add_ready_script($this->sReadyScript); } if ($bReturnHTML) { return $sReturn; } else { $oP->add($sReturn); } } public function StartRow($sFieldId = null) { if ($sFieldId != null) { return ''; } return ''; } public function EndRow() { return ''; } public function RenderAsDialog($oPage, $sDialogId, $sDialogTitle, $iDialogWidth, $sOkButtonLabel, $sIntroduction = null) { $this->SetPrefix('dlg_'); // To make sure that the controls have different IDs that the property sheet which may be displayed at the same time $sDialogTitle = addslashes($sDialogTitle); $sOkButtonLabel = addslashes($sOkButtonLabel); $sCancelButtonLabel = Dict::S('UI:Button:Cancel'); $oPage->add("

"); if ($sIntroduction != null) { $oPage->add(''); } $this->Render($oPage); $oPage->add('

'); $oPage->add_ready_script( <<aFieldSets as $sLabel => $aFields) { foreach($aFields as $oField) { $oField->ReadParam($aValues); } } return $aValues; } public function SetPrefix($sPrefix) { $this->sFormPrefix = $sPrefix; } public function GetPrefix() { $sPrefix = ''; if ($this->oParentForm != null) { $sPrefix = $this->oParentForm->GetPrefix(); } return $sPrefix.$this->sFormPrefix; } public function SetSuffix($sSuffix) { $this->sFieldsSuffix = $sSuffix; } public function GetSuffix() { $sSuffix = ''; if ($this->oParentForm != null) { $sSuffix = $this->oParentForm->GetSuffix(); } return $sSuffix.$this->sFieldsSuffix; } public function SetReadOnly($bReadOnly = true) { $this->bReadOnly = $bReadOnly; } public function IsReadOnly() { if ($this->oParentForm == null) { return $this->bReadOnly; } else { return $this->oParentForm->IsReadOnly(); } } public function SetParamsContainer($sParamsContainer) { $this->sParamsContainer = $sParamsContainer; } public function GetParamsContainer() { if ($this->oParentForm == null) { return $this->sParamsContainer; } else { return $this->oParentForm->GetParamsContainer(); } } public function SetParentForm($oParentForm) { $this->oParentForm = $oParentForm; } public function SetDefaultValues($aDefaultValues) { if (!is_array($aDefaultValues)) return; foreach($this->aFieldSets as $sLabel => $aFields) { foreach($aFields as $oField) { $oField->SetDefaultValueFrom($aDefaultValues); } } } public function GetDefaultValues() { return $this->aDefaultValues; } public function GetParentForm() { return $this->oParentForm; } public function SetDisplayed($bDisplayed) { $this->bDisplayed = $bDisplayed; } public function IsDisplayed() { if ($this->oParentForm == null) { return $this->bDisplayed; } else { return ($this->bDisplayed && $this->oParentForm->IsDisplayed()); } } public function AddScript($sScript) { $this->sScript .= $sScript; } public function AddReadyScript($sScript) { $this->sReadyScript .= $sScript; } public function GetFieldId($sCode) { return $this->GetPrefix().'attr_'.$sCode; } public function GetFieldName($sCode) { return 'attr_'.$sCode.$this->GetSuffix(); } public function GetParamName($sCode) { return 'attr_'.$sCode.$this->GetSuffix(); } public function GetValidationArea($sId, $sContent = '') { return "$sContent"; } public function GetAsyncActionClass() { return $this->sAsyncActionClass; } public function FindField($sFieldCode) { $oFoundField = false; foreach($this->aFieldSets as $sLabel => $aFields) { foreach($aFields as $oField) { $oFoundField = $oField->FindField($sFieldCode); if ($oFoundField !== false) break; } if ($oFoundField !== false) break; } return $oFoundField; } } class DesignerTabularForm extends DesignerForm { protected $aTable; public function __construct() { parent::__construct(); $this->aTable = array(); } public function AddRow($aRow) { $this->aTable[] = $aRow; } public function RenderAsPropertySheet($oP, $bReturnHTML = false, $sNotifyParentSelector = null) { return $this->Render($oP, $bReturnHTML); } public function Render($oP, $bReturnHTML = false) { $sReturn = ''; if ($this->oParentForm == null) { $sFormId = $this->sFormId; $sReturn = '

'; } else { $sFormId = $this->oParentForm->sFormId; } $sHiddenFields = ''; $sReturn .= ''; foreach($this->aTable as $aRow) { $sReturn .= ''; foreach($aRow as $field) { if (!is_object($field)) { // Shortcut: pass a string for a cell containing just a label $sReturn .= ''; } else { $field->SetForm($this); $aFieldData = $field->Render($oP, $sFormId); if ($field->IsVisible()) { // put the label and value separated by a non-breaking space if needed $aData = array(); foreach(array('label', 'value') as $sCode ) { if ($aFieldData[$sCode] != '') { $aData[] = $aFieldData[$sCode]; } } $sReturn .= ''; } else { $sHiddenFields .= $aRow['value']; } } } $sReturn .= ''; } $sReturn .= '

'.$field.'

'.implode(' ', $aData).'

'; $sReturn .= $sHiddenFields; if($this->sScript != '') { $oP->add_script($this->sScript); } if($this->sReadyScript != '') { $oP->add_ready_script($this->sReadyScript); } if ($bReturnHTML) { return $sReturn; } else { $oP->add($sReturn); } } public function ReadParams(&$aValues = array()) { foreach($this->aTable as $aRow) { foreach($aRow as $field) { if (is_object($field)) { $field->SetForm($this); $field->ReadParam($aValues); } } } return $aValues; } } class DesignerFormField { protected $sLabel; protected $sCode; protected $defaultValue; protected $oForm; protected $bMandatory; protected $bReadOnly; protected $bAutoApply; protected $aCSSClasses; protected $bDisplayed; public function __construct($sCode, $sLabel, $defaultValue) { $this->sLabel = $sLabel; $this->sCode = $sCode; $this->defaultValue = $defaultValue; $this->bMandatory = false; $this->bReadOnly = false; $this->bAutoApply = false; $this->aCSSClasses = array(); $this->bDisplayed = true; } public function GetCode() { return $this->sCode; } public function SetForm($oForm) { $this->oForm = $oForm; } public function SetMandatory($bMandatory = true) { $this->bMandatory = $bMandatory; } public function SetReadOnly($bReadOnly = true) { $this->bReadOnly = $bReadOnly; } public function IsReadOnly() { return ($this->oForm->IsReadOnly() || $this->bReadOnly); } public function SetAutoApply($bAutoApply) { $this->bAutoApply = $bAutoApply; } public function IsAutoApply() { return $this->bAutoApply; } public function SetDisplayed($bDisplayed) { $this->bDisplayed = $bDisplayed; } public function IsDisplayed() { return $this->bDisplayed; } public function GetFieldId() { return $this->oForm->GetFieldId($this->sCode); } public function Render(WebPage $oP, $sFormId, $sRenderMode='dialog') { $sId = $this->oForm->GetFieldId($this->sCode); $sName = $this->oForm->GetFieldName($this->sCode); return array('label' => $this->sLabel, 'value' => "defaultValue, ENT_QUOTES, 'UTF-8')."\">"); } public function ReadParam(&$aValues) { if ($this->IsReadOnly()) { $aValues[$this->sCode] = $this->defaultValue; } else { if ($this->oForm->GetParamsContainer() != '') { $aParams = utils::ReadParam($this->oForm->GetParamsContainer(), array(), false, 'raw_data'); if (array_key_exists($this->oForm->GetParamName($this->sCode), $aParams)) { $aValues[$this->sCode] = $aParams[$this->oForm->GetParamName($this->sCode)]; } else { $aValues[$this->sCode] = $this->defaultValue; } } else { $aValues[$this->sCode] = utils::ReadParam($this->oForm->GetParamName($this->sCode), $this->defaultValue, false, 'raw_data'); } } } public function IsVisible() { return true; } public function AddCSSClass($sCSSClass) { $this->aCSSClasses[] = $sCSSClass; } /** * A way to set/change the default value after constructing the field */ public function SetDefaultValueFrom($aAllDefaultValue) { if (array_key_exists($this->GetCode(), $aAllDefaultValue)) { $this->defaultValue = $aAllDefaultValue[$this->GetCode()]; } } public function FindField($sFieldCode) { if ($this->sCode == $sFieldCode) { return $this; } return false; } public function GetHandlerEquals() { return 'null'; } public function GetHandlerGetValue() { return 'null'; } } class DesignerLabelField extends DesignerFormField { protected $sDescription; public function __construct($sLabel, $sDescription) { parent::__construct('', $sLabel, ''); $this->sDescription = $sDescription; } public function Render(WebPage $oP, $sFormId, $sRenderMode='dialog') { $sId = $this->oForm->GetFieldId($this->sCode); $sName = $this->oForm->GetFieldName($this->sCode); return array('label' => $this->sLabel, 'value' => $this->sDescription); } public function ReadParam(&$aValues) { } public function IsVisible() { return true; } } class DesignerTextField extends DesignerFormField { protected $sValidationPattern; protected $aForbiddenValues; protected $sExplainForbiddenValues; public function __construct($sCode, $sLabel = '', $defaultValue = '') { parent::__construct($sCode, $sLabel, $defaultValue); $this->sValidationPattern = ''; $this->aForbiddenValues = null; $this->sExplainForbiddenValues = null; } public function SetValidationPattern($sValidationPattern) { $this->sValidationPattern = $sValidationPattern; } public function SetForbiddenValues($aValues, $sExplain) { $this->aForbiddenValues = $aValues; $iDefaultKey = array_search($this->defaultValue, $this->aForbiddenValues); if ($iDefaultKey !== false) { // The default (current) value is always allowed... unset($this->aForbiddenValues[$iDefaultKey]); } $this->sExplainForbiddenValues = $sExplain; } public function Render(WebPage $oP, $sFormId, $sRenderMode='dialog') { $sId = $this->oForm->GetFieldId($this->sCode); $sName = $this->oForm->GetFieldName($this->sCode); if ($this->IsReadOnly()) { $sHtmlValue = "".htmlentities($this->defaultValue, ENT_QUOTES, 'UTF-8')."defaultValue, ENT_QUOTES, 'UTF-8')."\"/>"; } else { $sPattern = addslashes($this->sValidationPattern); if (is_array($this->aForbiddenValues)) { $sForbiddenValues = json_encode($this->aForbiddenValues); $sExplainForbiddenValues = addslashes($this->sExplainForbiddenValues); } else { $sForbiddenValues = 'null'; $sExplainForbiddenValues = 'null'; } $sMandatory = $this->bMandatory ? 'true' : 'false'; $oP->add_ready_script( <<aCSSClasses) > 0) { $sCSSClasses = 'class="'.implode(' ', $this->aCSSClasses).'"'; } $sHtmlValue = "defaultValue, ENT_QUOTES, 'UTF-8')."\">"; } return array('label' => $this->sLabel, 'value' => $sHtmlValue); } public function ReadParam(&$aValues) { parent::ReadParam($aValues); if (($this->sValidationPattern != '') &&(!preg_match('/'.$this->sValidationPattern.'/', $aValues[$this->sCode])) ) { $aValues[$this->sCode] = $this->defaultValue; } else if(($this->aForbiddenValues != null) && in_array($aValues[$this->sCode], $this->aForbiddenValues)) { // Reject the value... $aValues[$this->sCode] = $this->defaultValue; } } } class DesignerLongTextField extends DesignerTextField { public function Render(WebPage $oP, $sFormId, $sRenderMode='dialog') { $sId = $this->oForm->GetFieldId($this->sCode); $sName = $this->oForm->GetFieldName($this->sCode); $sPattern = addslashes($this->sValidationPattern); if (is_array($this->aForbiddenValues)) { $sForbiddenValues = json_encode($this->aForbiddenValues); $sExplainForbiddenValues = addslashes($this->sExplainForbiddenValues); } else { $sForbiddenValues = 'null'; $sExplainForbiddenValues = 'null'; } $sMandatory = $this->bMandatory ? 'true' : 'false'; $sReadOnly = $this->IsReadOnly() ? 'readonly' : ''; $oP->add_ready_script( <<aCSSClasses) > 0) { $sCSSClasses = 'class="'.implode(' ', $this->aCSSClasses).'"'; } return array('label' => $this->sLabel, 'value' => ""); } } class DesignerIntegerField extends DesignerFormField { protected $iMin; // Lower boundary, inclusive protected $iMax; // Higher boundary, inclusive public function __construct($sCode, $sLabel = '', $defaultValue = '') { parent::__construct($sCode, $sLabel, $defaultValue); $this->iMin = 0; // Positive integer is the default $this->iMax = null; } public function SetBoundaries($iMin = null, $iMax = null) { $this->iMin = $iMin; $this->iMax = $iMax; } public function Render(WebPage $oP, $sFormId, $sRenderMode='dialog') { $sId = $this->oForm->GetFieldId($this->sCode); $sName = $this->oForm->GetFieldName($this->sCode); if ($this->IsReadOnly()) { $sHtmlValue = "".htmlentities($this->defaultValue, ENT_QUOTES, 'UTF-8')."defaultValue, ENT_QUOTES, 'UTF-8')."\"/>"; } else { $sMin = json_encode($this->iMin); $sMax = json_encode($this->iMax); $sMandatory = $this->bMandatory ? 'true' : 'false'; $oP->add_ready_script( <<aCSSClasses) > 0) { $sCSSClasses = 'class="'.implode(' ', $this->aCSSClasses).'"'; } $sHtmlValue = "defaultValue, ENT_QUOTES, 'UTF-8')."\">"; } return array('label' => $this->sLabel, 'value' => $sHtmlValue); } public function ReadParam(&$aValues) { parent::ReadParam($aValues); if (!is_null($this->iMin) && ($aValues[$this->sCode] < $this->iMin)) { // Reject the value... $aValues[$this->sCode] = $this->defaultValue; } if (!is_null($this->iMax) && ($aValues[$this->sCode] > $this->iMax)) { // Reject the value... $aValues[$this->sCode] = $this->defaultValue; } } } class DesignerComboField extends DesignerFormField { protected $aAllowedValues; protected $bMultipleSelection; protected $bOtherChoices; protected $sNullLabel; public function __construct($sCode, $sLabel = '', $defaultValue = '') { parent::__construct($sCode, $sLabel, $defaultValue); $this->aAllowedValues = array(); $this->bMultipleSelection = false; $this->bOtherChoices = false; $this->sNullLabel = Dict::S('UI:SelectOne'); $this->bAutoApply = true; } public function SetAllowedValues($aAllowedValues) { $this->aAllowedValues = $aAllowedValues; } public function MultipleSelection($bMultipleSelection = true) { $this->bMultipleSelection = $bMultipleSelection; } public function OtherChoices($bOtherChoices = true) { $this->bOtherChoices = $bOtherChoices; } /** * An empty label will disable the default empty value */ public function SetNullLabel($sLabel) { $this->sNullLabel = $sLabel; } public function Render(WebPage $oP, $sFormId, $sRenderMode='dialog') { $sId = $this->oForm->GetFieldId($this->sCode); $sName = $this->oForm->GetFieldName($this->sCode); $sChecked = $this->defaultValue ? 'checked' : ''; $sMandatory = $this->bMandatory ? 'true' : 'false'; $sReadOnly = $this->IsReadOnly() ? 'disabled="disabled"' : ''; $sCSSClasses = ''; if (count($this->aCSSClasses) > 0) { $sCSSClasses = 'class="'.implode(' ', $this->aCSSClasses).'"'; } if ($this->IsReadOnly()) { $aSelected = array(); $aHiddenValues = array(); foreach($this->aAllowedValues as $sKey => $sDisplayValue) { if ($this->bMultipleSelection) { if(in_array($sKey, $this->defaultValue)) { $aSelected[] = $sDisplayValue; $aHiddenValues[] = ""; } } else { if ($sKey == $this->defaultValue) { $aSelected[] = $sDisplayValue; $aHiddenValues[] = ""; } } } $sHtml = "".htmlentities(implode(', ', $aSelected), ENT_QUOTES, 'UTF-8').implode($aHiddenValues).""; } else { if ($this->bMultipleSelection) { $sHtml = ""; if ($this->sNullLabel != '') { $sHtml .= ""; } } foreach($this->aAllowedValues as $sKey => $sDisplayValue) { if ($this->bMultipleSelection) { $sSelected = in_array($sKey, $this->defaultValue) ? 'selected' : ''; } else { $sSelected = ($sKey == $this->defaultValue) ? 'selected' : ''; } // Quick and dirty: display the menu parents as a tree $sHtmlValue = str_replace(' ', ' ', htmlentities($sDisplayValue, ENT_QUOTES, 'UTF-8')); $sHtml .= ""; } $sHtml .= ""; if ($this->bOtherChoices) { $sHtml .= '
Other: '; } $oP->add_ready_script( << $this->sLabel, 'value' => $sHtml); } public function ReadParam(&$aValues) { parent::ReadParam($aValues); if ($aValues[$this->sCode] == 'null') { $aValues[$this->sCode] = array(); } } } class DesignerBooleanField extends DesignerFormField { public function __construct($sCode, $sLabel = '', $defaultValue = '') { parent::__construct($sCode, $sLabel, $defaultValue); $this->bAutoApply = true; } public function Render(WebPage $oP, $sFormId, $sRenderMode='dialog') { $sId = $this->oForm->GetFieldId($this->sCode); $sName = $this->oForm->GetFieldName($this->sCode); $sChecked = $this->defaultValue ? 'checked' : ''; if ($this->IsReadOnly()) { $sLabel = $this->defaultValue ? Dict::S('UI:UserManagement:ActionAllowed:Yes') : Dict::S('UI:UserManagement:ActionAllowed:No'); //TODO use our own yes/no translations $sHtmlValue = "".htmlentities($sLabel)."defaultValue, ENT_QUOTES, 'UTF-8')."\"/>"; } else { $sCSSClasses = ''; if (count($this->aCSSClasses) > 0) { $sCSSClasses = 'class="'.implode(' ', $this->aCSSClasses).'"'; } $sHtmlValue = ""; } return array('label' => $this->sLabel, 'value' => $sHtmlValue); } public function ReadParam(&$aValues) { if ($this->IsReadOnly()) { $aValues[$this->sCode] = $this->defaultValue; } else { $sParamsContainer = $this->oForm->GetParamsContainer(); if ($sParamsContainer != '') { $aParams = utils::ReadParam($sParamsContainer, array(), false, 'raw_data'); if (array_key_exists($this->oForm->GetParamName($this->sCode), $aParams)) { $sValue = $aParams[$this->oForm->GetParamName($this->sCode)]; } else { $sValue = 'false'; } } else { $sValue = utils::ReadParam($this->oForm->GetParamName($this->sCode), 'false', false, 'raw_data'); } $aValues[$this->sCode] = ($sValue == 'true'); } } } class DesignerHiddenField extends DesignerFormField { public function __construct($sCode, $sLabel = '', $defaultValue = '') { parent::__construct($sCode, $sLabel, $defaultValue); } public function IsVisible() { return false; } public function Render(WebPage $oP, $sFormId, $sRenderMode='dialog') { $sId = $this->oForm->GetFieldId($this->sCode); $sName = $this->oForm->GetFieldName($this->sCode); $sChecked = $this->defaultValue ? 'checked' : ''; return array('label' =>'', 'value' => "defaultValue, ENT_QUOTES, 'UTF-8')."\">"); } } class DesignerIconSelectionField extends DesignerFormField { protected $sUploadUrl; protected $aAllowedValues; public function __construct($sCode, $sLabel = '', $defaultValue = '') { parent::__construct($sCode, $sLabel, $defaultValue); $this->bAutoApply = true; $this->sUploadUrl = null; } public function SetAllowedValues($aAllowedValues) { $this->aAllowedValues = $aAllowedValues; } public function EnableUpload($sIconUploadUrl) { $this->sUploadUrl = $sIconUploadUrl; } public function Render(WebPage $oP, $sFormId, $sRenderMode='dialog') { $sId = $this->oForm->GetFieldId($this->sCode); $sName = $this->oForm->GetFieldName($this->sCode); $idx = 0; foreach($this->aAllowedValues as $index => $aValue) { if ($aValue['value'] == $this->defaultValue) { $idx = $index; break; } } $sJSItems = json_encode($this->aAllowedValues); $sPostUploadTo = ($this->sUploadUrl == null) ? 'null' : "'{$this->sUploadUrl}'"; if (!$this->IsReadOnly()) { $sValue = "defaultValue}\"/>"; $oP->add_ready_script( <<MakeFileUrl($this->defaultValue).'" />'; } $sReadOnly = $this->IsReadOnly() ? 'disabled' : ''; return array('label' => $this->sLabel, 'value' => $sValue); } } class RunTimeIconSelectionField extends DesignerIconSelectionField { public function __construct($sCode, $sLabel = '', $defaultValue = '') { parent::__construct($sCode, $sLabel, $defaultValue); $aAllIcons = self::FindIconsOnDisk(APPROOT.'env-'.utils::GetCurrentEnvironment()); ksort($aAllIcons); $aValues = array(); foreach($aAllIcons as $sFilePath) { $aValues[] = array('value' => $sFilePath, 'label' => basename($sFilePath), 'icon' => utils::GetAbsoluteUrlModulesRoot().$sFilePath); } $this->SetAllowedValues($aValues); } static protected function FindIconsOnDisk($sBaseDir, $sDir = '') { $aResult = array(); // Populate automatically the list of icon files if ($hDir = @opendir($sBaseDir.'/'.$sDir)) { while (($sFile = readdir($hDir)) !== false) { $aMatches = array(); if (($sFile != '.') && ($sFile != '..') && ($sFile != 'lifecycle') && is_dir($sBaseDir.'/'.$sDir.'/'.$sFile)) { $sDirSubPath = ($sDir == '') ? $sFile : $sDir.'/'.$sFile; $aResult = array_merge($aResult, self::FindIconsOnDisk($sBaseDir, $sDirSubPath)); } if (preg_match("/\.(png|jpg|jpeg|gif)$/i", $sFile, $aMatches)) // png, jp(e)g and gif are considered valid { $aResult[$sFile.'_'.$sDir] = $sDir.'/'.$sFile; } } closedir($hDir); } return $aResult; } public function ValueFromDOMNode($oDOMNode) { return $oDOMNode->textContent; } public function ValueToDOMNode($oDOMNode, $value) { $oTextNode = $oDOMNode->ownerDocument->createTextNode($value); $oDOMNode->appendChild($oTextNode); } public function MakeFileUrl($value) { return utils::GetAbsoluteUrlModulesRoot().$value; } public function GetDefaultValue($sClass = 'Contact') { $sIconPath = MetaModel::GetClassIcon($sClass, false); $sIcon = str_replace(utils::GetAbsoluteUrlModulesRoot(), '', $sIconPath); return $sIcon; } } class DesignerSortableField extends DesignerFormField { protected $aAllowedValues; public function __construct($sCode, $sLabel = '', $defaultValue = '') { parent::__construct($sCode, $sLabel, $defaultValue); $this->aAllowedValues = array(); } public function SetAllowedValues($aAllowedValues) { $this->aAllowedValues = $aAllowedValues; } public function Render(WebPage $oP, $sFormId, $sRenderMode='dialog') { $bOpen = false; $sId = $this->oForm->GetFieldId($this->sCode); $sName = $this->oForm->GetFieldName($this->sCode); $sReadOnly = $this->IsReadOnly() ? 'readonly="readonly"' : ''; $aResult = array('label' => $this->sLabel, 'value' => "defaultValue, ENT_QUOTES, 'UTF-8')."\">"); $sJSFields = json_encode(array_keys($this->aAllowedValues)); $oP->add_ready_script( "$('#$sId').sortable_field({aAvailableFields: $sJSFields});" ); return $aResult; } } class DesignerFormSelectorField extends DesignerFormField { protected $aSubForms; protected $defaultRealValue; // What's stored as default value is actually the index public function __construct($sCode, $sLabel = '', $defaultValue = '') { parent::__construct($sCode, $sLabel, 0); $this->defaultRealValue = $defaultValue; $this->aSubForms = array(); } public function AddSubForm($oSubForm, $sLabel, $sValue) { $idx = count($this->aSubForms); $this->aSubForms[] = array('form' => $oSubForm, 'label' => $sLabel, 'value' => $sValue); if ($sValue == $this->defaultRealValue) { // Store the index of the selected/default form $this->defaultValue = count($this->aSubForms) - 1; } } public function Render(WebPage $oP, $sFormId, $sRenderMode='dialog') { $sId = $this->oForm->GetFieldId($this->sCode); $sName = $this->oForm->GetFieldName($this->sCode); $sReadOnly = $this->IsReadOnly() ? 'disabled="disabled"' : ''; $this->aCSSClasses[] = 'formSelector'; $sCSSClasses = ''; if (count($this->aCSSClasses) > 0) { $sCSSClasses = 'class="'.implode(' ', $this->aCSSClasses).'"'; } if ($this->IsReadOnly()) { $aSelected = array(); $aHiddenValues = array(); $sDisplayValue = ''; $sHiddenValue = ''; foreach($this->aSubForms as $iKey => $aFormData) { if ($iKey == $this->defaultValue) // Default value is actually the index { $sDisplayValue = htmlentities($aFormData['label'], ENT_QUOTES, 'UTF-8'); $sHiddenValue = ""; break; } } $sHtml = "".$sDisplayValue.$sHiddenValue.""; } else { $sHtml = ""; } if ($sRenderMode == 'property') { $sHtml .= ''; } foreach($this->aSubForms as $sKey => $aFormData) { $sId = $this->oForm->GetFieldId($this->sCode); $sStyle = (($sKey == $this->defaultValue) && $this->oForm->IsDisplayed()) ? '' : 'style="display:none"'; $oSubForm = $aFormData['form']; $oSubForm->SetParentForm($this->oForm); $oSubForm->CopySubmitParams($this->oForm); $oSubForm->SetPrefix($this->oForm->GetPrefix().$sKey.'_'); if ($sRenderMode == 'property') { // Note: Managing the visibility of nested subforms had several implications // 1) Attributes are displayed in a table and we have to group them in as many tbodys as necessary to hide/show the various options depending on the current selection // 2) It is not possible to nest tbody tags. Therefore, it is not possible to manage the visibility the same way as it is done for the dialog mode (using nested divs). // The div hierarchy has been emulated by adding attributes to the tbody tags: // - data-selector : uniquely identifies the DesignerFormSelectorField that has an impact on the visibility of the node // - data-path : uniquely identifies the combination of users choices that must be made to show the node // - data-state : records the state, depending on the user choice on the FormSelectorField just above the node, but indepentantly from the visibility in the page (can be visible in the form itself being in a hidden form) // Then a series of actions are performed to hide and show the relevant nodes, depending on the user choice $sSelector = $this->oForm->GetHierarchyPath().'/'.$this->sCode.$this->oForm->GetSuffix(); $oSubForm->SetHierarchyParent($sSelector); $sPath = $this->oForm->GetHierarchyPath().'/'.$this->sCode.$this->oForm->GetSuffix().'-'.$sKey; $oSubForm->SetHierarchyPath($sPath); $oSubForm->SetDisplayed($sKey == $this->defaultValue); $sState = ($sKey == $this->defaultValue) ? 'visible' : 'hidden'; //$sHtml .= ""; $sHtml .= $oSubForm->RenderAsPropertySheet($oP, true); $sState = $this->oForm->IsDisplayed() ? 'visible' : 'hidden'; $sParentStyle = ''; if ($oParent = $this->oForm->GetParentForm()) { $sParentStyle = ($oParent->IsDisplayed()) ? '' : 'style="display:none"'; $sParentSelector = $oParent->GetHierarchyParent(); $sParentPath = $oParent->GetHierarchyPath(); } else { $sParentSelector = ''; $sParentPath = ''; } //$sHtml .= ""; } else { $sHtml .= "

"; $sHtml .= $oSubForm->Render($oP, true); $sHtml .= "

"; } } if ($sRenderMode == 'property') { $sSelector = $this->oForm->GetHierarchyPath().'/'.$this->sCode.$this->oForm->GetSuffix(); $oP->add_ready_script("InitFormSelectorField('$sId', '$sSelector');"); } else { $oP->add_ready_script( << $this->sLabel, 'value' => $sHtml); } public function ReadParam(&$aValues) { parent::ReadParam($aValues); $sKey = $aValues[$this->sCode]; $aValues[$this->sCode] = $this->aSubForms[$sKey]['value']; $this->aSubForms[$sKey]['form']->SetPrefix($this->oForm->GetPrefix().$sKey.'_'); $this->aSubForms[$sKey]['form']->SetParentForm($this->oForm); $this->aSubForms[$sKey]['form']->ReadParams($aValues); } public function SetDefaultValueFrom($aAllDefaultValues) { if (array_key_exists($this->GetCode(), $aAllDefaultValues)) { $selectedValue = $aAllDefaultValues[$this->GetCode()]; foreach($this->aSubForms as $iKey => $aFormData) { $sId = $this->oForm->GetFieldId($this->sCode); if ($selectedValue == $aFormData['value']) { $this->defaultValue =$iKey; $aDefaultValues = $this->oForm->GetDefaultValues(); $oSubForm = $aFormData['form']; $oSubForm->SetDefaultValues($aAllDefaultValues); } } } } public function FindField($sFieldCode) { $oField = parent::FindField($sFieldCode); if ($oField === false) { // Look in the subforms foreach($this->aSubForms as $sKey => $aFormData) { $oSubForm = $aFormData['form']; $oField = $oSubForm->FindField($sFieldCode); if ($oField !== false) { break; } } } return $oField; } } class DesignerSubFormField extends DesignerFormField { protected $oSubForm; public function __construct($sLabel, $oSubForm) { parent::__construct('', $sLabel, ''); $this->oSubForm = $oSubForm; } public function Render(WebPage $oP, $sFormId, $sRenderMode='dialog') { $this->oSubForm->SetParentForm($this->oForm); $this->oSubForm->CopySubmitParams($this->oForm); if ($sRenderMode == 'property') { $sHtml = $this->oSubForm->RenderAsPropertySheet($oP, true); } else { $sHtml = $this->oSubForm->Render($oP, true); } return array('label' => $this->sLabel, 'value' => $sHtml); } public function ReadParam(&$aValues) { $this->oSubForm->SetParentForm($this->oForm); $this->oSubForm->ReadParams($aValues); } public function FindField($sFieldCode) { $oField = parent::FindField($sFieldCode); if ($oField === false) { // Look in the subform $oField = $this->oSubForm->FindField($sFieldCode); } return $oField; } } class DesignerStaticTextField extends DesignerFormField { public function __construct($sCode, $sLabel = '', $defaultValue = '') { parent::__construct($sCode, $sLabel, $defaultValue); } public function Render(WebPage $oP, $sFormId, $sRenderMode='dialog') { return array('label' => $this->sLabel, 'value' => $this->defaultValue); } }