For example, having this : - * - *
- * +---------------------+ +--------------------+ +--------------+ - * | Class A | | Class B | | Class C | - * +---------------------+ +--------------------+ +--------------+ - * | foo- * - *-------->c_id_friendly_name--------->friendlyname | - * +---------------------+ +--------------------+ +--------------+ - *
The ExternalField foo points to a magical field that is brought by c_id ExternalKey in class B. - * - *
In the normal case the foo label would be : B -> C -> friendlyname
- * But as foo is a friendlyname its label will be the same as the one on A.b_id field
- * This can be overrided with dict key Class:ClassA/Attribute:foo
- *
- * @throws \CoreException
- * @throws \Exception
- */
- public function GetLabel($sDefault = null)
- {
- $sLabelDefaultValue = '';
- $sLabel = parent::GetLabel($sLabelDefaultValue);
- if ($sLabelDefaultValue !== $sLabel) {
- return $sLabel;
- }
-
- if ($this->IsFriendlyName() && ($this->Get("target_attcode") === "friendlyname")) {
- // This will be used even if we are pointing to a friendlyname in a distance > 1
- // For example we can link to a magic friendlyname (like org_id_friendlyname)
- // If a specific label is needed, use a Dict key !
- // See N°2174
- $sKeyAttCode = $this->Get("extkey_attcode");
- $oExtKeyAttDef = MetaModel::GetAttributeDef($this->GetHostClass(), $sKeyAttCode);
- $sLabel = $oExtKeyAttDef->GetLabel($this->m_sCode);
-
- return $sLabel;
- }
-
- $oRemoteAtt = $this->GetExtAttDef();
- $sLabel = $oRemoteAtt->GetLabel($this->m_sCode);
- $oKeyAtt = $this->GetKeyAttDef();
- $sKeyLabel = $oKeyAtt->GetLabel($this->GetKeyAttCode());
- $sLabel = "{$sKeyLabel}->{$sLabel}";
-
- return $sLabel;
- }
-
- public function GetLabelForSearchField()
- {
- $sLabel = parent::GetLabel('');
- if (strlen($sLabel) == 0) {
- $sKeyAttCode = $this->Get("extkey_attcode");
- $oExtKeyAttDef = MetaModel::GetAttributeDef($this->GetHostClass(), $sKeyAttCode);
- $sLabel = $oExtKeyAttDef->GetLabel($this->m_sCode);
-
- $oRemoteAtt = $this->GetExtAttDef();
- $sLabel .= '->' . $oRemoteAtt->GetLabel($this->m_sCode);
- }
-
- return $sLabel;
- }
-
- public function GetDescription($sDefault = null)
- {
- $sLabel = parent::GetDescription('');
- if (strlen($sLabel) == 0) {
- $oRemoteAtt = $this->GetExtAttDef();
- $sLabel = $oRemoteAtt->GetDescription('');
- }
-
- return $sLabel;
- }
-
- public function GetHelpOnEdition($sDefault = null)
- {
- $sLabel = parent::GetHelpOnEdition('');
- if (strlen($sLabel) == 0) {
- $oRemoteAtt = $this->GetExtAttDef();
- $sLabel = $oRemoteAtt->GetHelpOnEdition('');
- }
-
- return $sLabel;
- }
-
- public function IsExternalKey($iType = EXTKEY_RELATIVE)
- {
- switch ($iType) {
- case EXTKEY_ABSOLUTE:
- // see further
- $oRemoteAtt = $this->GetExtAttDef();
-
- return $oRemoteAtt->IsExternalKey($iType);
-
- case EXTKEY_RELATIVE:
- return false;
-
- default:
- throw new CoreException("Unexpected value for argument iType: '$iType'");
- }
- }
-
- /**
- * @return bool
- * @throws \CoreException
- */
- public function IsFriendlyName()
- {
- $oRemoteAtt = $this->GetExtAttDef();
- if ($oRemoteAtt instanceof AttributeExternalField) {
- $bRet = $oRemoteAtt->IsFriendlyName();
- } elseif ($oRemoteAtt instanceof AttributeFriendlyName) {
- $bRet = true;
- } else {
- $bRet = false;
- }
-
- return $bRet;
- }
-
- public function GetTargetClass($iType = EXTKEY_RELATIVE)
- {
- return $this->GetKeyAttDef($iType)->GetTargetClass();
- }
-
- public static function IsExternalField()
- {
- return true;
- }
-
- public function GetKeyAttCode()
- {
- return $this->Get("extkey_attcode");
- }
-
- public function GetExtAttCode()
- {
- return $this->Get("target_attcode");
- }
-
- /**
- * @param int $iType
- *
- * @return \AttributeExternalKey
- * @throws \CoreException
- * @throws \Exception
- */
- public function GetKeyAttDef($iType = EXTKEY_RELATIVE)
- {
- switch ($iType) {
- case EXTKEY_ABSOLUTE:
- // see further
- /** @var \AttributeExternalKey $oRemoteAtt */
- $oRemoteAtt = $this->GetExtAttDef();
- if ($oRemoteAtt->IsExternalField()) {
- return $oRemoteAtt->GetKeyAttDef(EXTKEY_ABSOLUTE);
- } else {
- if ($oRemoteAtt->IsExternalKey()) {
- return $oRemoteAtt;
- }
- }
-
- return $this->GetKeyAttDef(EXTKEY_RELATIVE); // which corresponds to the code hereafter !
-
- case EXTKEY_RELATIVE:
- /** @var \AttributeExternalKey $oAttDef */
- $oAttDef = MetaModel::GetAttributeDef($this->GetHostClass(), $this->Get("extkey_attcode"));
-
- return $oAttDef;
-
- default:
- throw new CoreException("Unexpected value for argument iType: '$iType'");
- }
- }
-
- public function GetPrerequisiteAttributes($sClass = null)
- {
- return array($this->Get("extkey_attcode"));
- }
-
-
- /**
- * @return \AttributeExternalField
- * @throws \CoreException
- * @throws \Exception
- */
- public function GetExtAttDef()
- {
- $oKeyAttDef = $this->GetKeyAttDef();
- /** @var \AttributeExternalField $oExtAttDef */
- $oExtAttDef = MetaModel::GetAttributeDef($oKeyAttDef->GetTargetClass(), $this->Get("target_attcode"));
- if (!is_object($oExtAttDef)) {
- throw new CoreException("Invalid external field " . $this->GetCode() . " in class " . $this->GetHostClass() . ". The class " . $oKeyAttDef->GetTargetClass() . " has no attribute " . $this->Get("target_attcode"));
- }
-
- return $oExtAttDef;
- }
-
- /**
- * @return mixed
- * @throws \CoreException
- */
- public function GetSQLExpr()
- {
- $oExtAttDef = $this->GetExtAttDef();
-
- return $oExtAttDef->GetSQLExpr();
- }
-
- public function GetDefaultValue(DBObject $oHostObject = null)
- {
- $oExtAttDef = $this->GetExtAttDef();
-
- return $oExtAttDef->GetDefaultValue();
- }
-
- public function IsNullAllowed()
- {
- $oExtAttDef = $this->GetExtAttDef();
-
- return $oExtAttDef->IsNullAllowed();
- }
-
- public static function IsScalar()
- {
- return true;
- }
-
- public function GetBasicFilterOperators()
- {
- $oExtAttDef = $this->GetExtAttDef();
-
- return $oExtAttDef->GetBasicFilterOperators();
- }
-
- public function GetBasicFilterLooseOperator()
- {
- $oExtAttDef = $this->GetExtAttDef();
-
- return $oExtAttDef->GetBasicFilterLooseOperator();
- }
-
- public function GetBasicFilterSQLExpr($sOpCode, $value)
- {
- $oExtAttDef = $this->GetExtAttDef();
-
- return $oExtAttDef->GetBasicFilterSQLExpr($sOpCode, $value);
- }
-
- public function GetNullValue()
- {
- $oExtAttDef = $this->GetExtAttDef();
-
- return $oExtAttDef->GetNullValue();
- }
-
- public function IsNull($proposedValue)
- {
- $oExtAttDef = $this->GetExtAttDef();
-
- return $oExtAttDef->IsNull($proposedValue);
- }
-
- /**
- * @inheritDoc
- */
- public function HasAValue($proposedValue): bool
- {
- $oExtAttDef = $this->GetExtAttDef();
-
- return $oExtAttDef->HasAValue($proposedValue);
- }
-
- public function MakeRealValue($proposedValue, $oHostObj)
- {
- $oExtAttDef = $this->GetExtAttDef();
-
- return $oExtAttDef->MakeRealValue($proposedValue, $oHostObj);
- }
-
- /**
- * @inheritDoc
- * @since 3.1.0 N°6271 Delegate to remote attribute to ensure cascading computed values
- */
- public function GetSQLValues($value)
- {
- $oExtAttDef = $this->GetExtAttDef();
-
- return $oExtAttDef->GetSQLValues($value);
- }
-
- public function ScalarToSQL($value)
- {
- // This one could be used in case of filtering only
- $oExtAttDef = $this->GetExtAttDef();
-
- return $oExtAttDef->ScalarToSQL($value);
- }
-
-
- // Do not overload GetSQLExpression here because this is handled in the joins
- //public function GetSQLExpressions($sPrefix = '') {return array();}
-
- // Here, we get the data...
- public function FromSQLToValue($aCols, $sPrefix = '')
- {
- $oExtAttDef = $this->GetExtAttDef();
-
- return $oExtAttDef->FromSQLToValue($aCols, $sPrefix);
- }
-
- public function GetAsHTML($value, $oHostObject = null, $bLocalize = true)
- {
- $oExtAttDef = $this->GetExtAttDef();
-
- return $oExtAttDef->GetAsHTML($value, null, $bLocalize);
- }
-
- public function GetAsXML($value, $oHostObject = null, $bLocalize = true)
- {
- $oExtAttDef = $this->GetExtAttDef();
-
- return $oExtAttDef->GetAsXML($value, null, $bLocalize);
- }
-
- public function GetAsCSV(
- $value, $sSeparator = ',', $sTestQualifier = '"', $oHostObject = null, $bLocalize = true,
- $bConvertToPlainText = false
- )
- {
- $oExtAttDef = $this->GetExtAttDef();
-
- return $oExtAttDef->GetAsCSV($value, $sSeparator, $sTestQualifier, null, $bLocalize, $bConvertToPlainText);
- }
-
- public static function GetFormFieldClass()
- {
- return '\\Combodo\\iTop\\Form\\Field\\LabelField';
- }
-
- /**
- * @param \DBObject $oObject
- * @param \Combodo\iTop\Form\Field\Field $oFormField
- *
- * @return null
- * @throws \CoreException
- */
- public function MakeFormField(DBObject $oObject, $oFormField = null)
- {
- // Retrieving AttDef from the remote attribute
- $oRemoteAttDef = $this->GetExtAttDef();
-
- if ($oFormField === null) {
- // ExternalField's FormField are actually based on the FormField from the target attribute.
- // Except for the AttributeExternalKey because we have no OQL and stuff
- if ($oRemoteAttDef instanceof AttributeExternalKey) {
- $sFormFieldClass = static::GetFormFieldClass();
- } else {
- $sFormFieldClass = $oRemoteAttDef::GetFormFieldClass();
- }
- /** @var \Combodo\iTop\Form\Field\Field $oFormField */
- $oFormField = new $sFormFieldClass($this->GetCode());
- switch ($sFormFieldClass) {
- case '\Combodo\iTop\Form\Field\SelectField':
- $oFormField->SetChoices($oRemoteAttDef->GetAllowedValues($oObject->ToArgsForQuery()));
- break;
- default:
- break;
- }
- }
- parent::MakeFormField($oObject, $oFormField);
- if ($oFormField instanceof \Combodo\iTop\Form\Field\TextAreaField) {
- if (method_exists($oRemoteAttDef, 'GetFormat')) {
- /** @var \Combodo\iTop\Form\Field\TextAreaField $oFormField */
- $oFormField->SetFormat($oRemoteAttDef->GetFormat());
- }
- }
-
- // Manually setting for remote ExternalKey, otherwise, the id would be displayed.
- if ($oRemoteAttDef instanceof AttributeExternalKey) {
- $oFormField->SetCurrentValue($oObject->Get($this->GetCode() . '_friendlyname'));
- }
-
- // Readonly field because we can't update external fields
- $oFormField->SetReadOnly(true);
-
- return $oFormField;
- }
-
- public function IsPartOfFingerprint()
- {
- return false;
- }
-
- public function GetFormat()
- {
- $oRemoteAttDef = $this->GetExtAttDef();
- if (method_exists($oRemoteAttDef, 'GetFormat')) {
- /** @var \Combodo\iTop\Form\Field\TextAreaField $oFormField */
- return $oRemoteAttDef->GetFormat();
- }
- return 'text';
- }
+ /**
+ * Useless constructor, but if not present PHP 7.4.0/7.4.1 is crashing :( (N°2329)
+ *
+ * @see https://www.php.net/manual/fr/language.oop5.decon.php states that child constructor can be ommited
+ * @see https://bugs.php.net/bug.php?id=79010 bug solved in PHP 7.4.9
+ *
+ * @param string $sCode
+ * @param array $aParams
+ *
+ * @throws Exception
+ * @noinspection SenselessProxyMethodInspection
+ */
+ public function __construct($sCode, $aParams)
+ {
+ parent::__construct($sCode, $aParams);
+ }
+
+ /**
+ * Return the search widget type corresponding to this attribute
+ *
+ * @return string
+ * @throws CoreException
+ */
+ public function GetSearchType()
+ {
+ // Not necessary the external key is already present
+ if ($this->IsFriendlyName()) {
+ return self::SEARCH_WIDGET_TYPE_RAW;
+ }
+
+ try {
+ $oRemoteAtt = $this->GetFinalAttDef();
+ switch (true) {
+ case ($oRemoteAtt instanceof AttributeString):
+ return self::SEARCH_WIDGET_TYPE_EXTERNAL_FIELD;
+ case ($oRemoteAtt instanceof AttributeExternalKey):
+ return self::SEARCH_WIDGET_TYPE_EXTERNAL_KEY;
+ }
+ }
+ catch (CoreException $e) {
+ }
+
+ return self::SEARCH_WIDGET_TYPE_RAW;
+ }
+
+ function IsSearchable()
+ {
+ if ($this->IsFriendlyName()) {
+ return true;
+ }
+
+ return parent::IsSearchable();
+ }
+
+ public static function ListExpectedParams()
+ {
+ return array_merge(parent::ListExpectedParams(), array("extkey_attcode", "target_attcode"));
+ }
+
+ public function GetEditClass()
+ {
+ return "ExtField";
+ }
+
+ /**
+ * @return AttributeDefinition
+ * @throws CoreException
+ */
+ public function GetFinalAttDef()
+ {
+ $oExtAttDef = $this->GetExtAttDef();
+
+ return $oExtAttDef->GetFinalAttDef();
+ }
+
+ protected function GetSQLCol($bFullSpec = false)
+ {
+ // throw new CoreException("external attribute: does it make any sense to request its type ?");
+ $oExtAttDef = $this->GetExtAttDef();
+
+ return $oExtAttDef->GetSQLCol($bFullSpec);
+ }
+
+ public function GetSQLExpressions($sPrefix = '')
+ {
+ if ($sPrefix == '') {
+ return array('' => $this->GetCode()); // Warning: Use GetCode() since AttributeExternalField does not have any 'sql' property
+ } else {
+ return $sPrefix;
+ }
+ }
+
+ /**
+ * @param string $sDefault
+ *
+ * @return string dict entry if defined, otherwise :
+ *
-
+ *
- if field is a friendlyname then display the label of the ExternalKey + *
- the class hierarchy -> field name
+ *
+ *
For example, having this : + * + *
+ * +---------------------+ +--------------------+ +--------------+ + * | Class A | | Class B | | Class C | + * +---------------------+ +--------------------+ +--------------+ + * | foo
+ * + *-------->c_id_friendly_name--------->friendlyname | + * +---------------------+ +--------------------+ +--------------+ + * The ExternalField foo points to a magical field that is brought by c_id ExternalKey in class B. + * + *
In the normal case the foo label would be : B -> C -> friendlyname
+ * But as foo is a friendlyname its label will be the same as the one on A.b_id field + * This can be overrided with dict key Class:ClassA/Attribute:foo + * + * @throws CoreException + * @throws Exception + */ + public function GetLabel($sDefault = null) + { + $sLabelDefaultValue = ''; + $sLabel = parent::GetLabel($sLabelDefaultValue); + if ($sLabelDefaultValue !== $sLabel) { + return $sLabel; + } + + if ($this->IsFriendlyName() && ($this->Get("target_attcode") === "friendlyname")) { + // This will be used even if we are pointing to a friendlyname in a distance > 1 + // For example we can link to a magic friendlyname (like org_id_friendlyname) + // If a specific label is needed, use a Dict key ! + // See N°2174 + $sKeyAttCode = $this->Get("extkey_attcode"); + $oExtKeyAttDef = MetaModel::GetAttributeDef($this->GetHostClass(), $sKeyAttCode); + $sLabel = $oExtKeyAttDef->GetLabel($this->m_sCode); + + return $sLabel; + } + + $oRemoteAtt = $this->GetExtAttDef(); + $sLabel = $oRemoteAtt->GetLabel($this->m_sCode); + $oKeyAtt = $this->GetKeyAttDef(); + $sKeyLabel = $oKeyAtt->GetLabel($this->GetKeyAttCode()); + $sLabel = "{$sKeyLabel}->{$sLabel}"; + + return $sLabel; + } + + public function GetLabelForSearchField() + { + $sLabel = parent::GetLabel(''); + if (strlen($sLabel) == 0) { + $sKeyAttCode = $this->Get("extkey_attcode"); + $oExtKeyAttDef = MetaModel::GetAttributeDef($this->GetHostClass(), $sKeyAttCode); + $sLabel = $oExtKeyAttDef->GetLabel($this->m_sCode); + + $oRemoteAtt = $this->GetExtAttDef(); + $sLabel .= '->'.$oRemoteAtt->GetLabel($this->m_sCode); + } + + return $sLabel; + } + + public function GetDescription($sDefault = null) + { + $sLabel = parent::GetDescription(''); + if (strlen($sLabel) == 0) { + $oRemoteAtt = $this->GetExtAttDef(); + $sLabel = $oRemoteAtt->GetDescription(''); + } + + return $sLabel; + } + + public function GetHelpOnEdition($sDefault = null) + { + $sLabel = parent::GetHelpOnEdition(''); + if (strlen($sLabel) == 0) { + $oRemoteAtt = $this->GetExtAttDef(); + $sLabel = $oRemoteAtt->GetHelpOnEdition(''); + } + + return $sLabel; + } + + public function IsExternalKey($iType = EXTKEY_RELATIVE) + { + switch ($iType) { + case EXTKEY_ABSOLUTE: + // see further + $oRemoteAtt = $this->GetExtAttDef(); + + return $oRemoteAtt->IsExternalKey($iType); + + case EXTKEY_RELATIVE: + return false; + + default: + throw new CoreException("Unexpected value for argument iType: '$iType'"); + } + } + + /** + * @return bool + * @throws CoreException + */ + public function IsFriendlyName() + { + $oRemoteAtt = $this->GetExtAttDef(); + if ($oRemoteAtt instanceof AttributeExternalField) { + $bRet = $oRemoteAtt->IsFriendlyName(); + } elseif ($oRemoteAtt instanceof AttributeFriendlyName) { + $bRet = true; + } else { + $bRet = false; + } + + return $bRet; + } + + public function GetTargetClass($iType = EXTKEY_RELATIVE) + { + return $this->GetKeyAttDef($iType)->GetTargetClass(); + } + + public static function IsExternalField() + { + return true; + } + + public function GetKeyAttCode() + { + return $this->Get("extkey_attcode"); + } + + public function GetExtAttCode() + { + return $this->Get("target_attcode"); + } + + /** + * @param int $iType + * + * @return AttributeExternalKey + * @throws CoreException + * @throws Exception + */ + public function GetKeyAttDef($iType = EXTKEY_RELATIVE) + { + switch ($iType) { + case EXTKEY_ABSOLUTE: + // see further + /** @var AttributeExternalKey $oRemoteAtt */ + $oRemoteAtt = $this->GetExtAttDef(); + if ($oRemoteAtt->IsExternalField()) { + return $oRemoteAtt->GetKeyAttDef(EXTKEY_ABSOLUTE); + } else { + if ($oRemoteAtt->IsExternalKey()) { + return $oRemoteAtt; + } + } + + return $this->GetKeyAttDef(EXTKEY_RELATIVE); // which corresponds to the code hereafter ! + + case EXTKEY_RELATIVE: + /** @var AttributeExternalKey $oAttDef */ + $oAttDef = MetaModel::GetAttributeDef($this->GetHostClass(), $this->Get("extkey_attcode")); + + return $oAttDef; + + default: + throw new CoreException("Unexpected value for argument iType: '$iType'"); + } + } + + public function GetPrerequisiteAttributes($sClass = null) + { + return array($this->Get("extkey_attcode")); + } + + + /** + * @return AttributeExternalField + * @throws CoreException + * @throws Exception + */ + public function GetExtAttDef() + { + $oKeyAttDef = $this->GetKeyAttDef(); + /** @var AttributeExternalField $oExtAttDef */ + $oExtAttDef = MetaModel::GetAttributeDef($oKeyAttDef->GetTargetClass(), $this->Get("target_attcode")); + if (!is_object($oExtAttDef)) { + throw new CoreException("Invalid external field ".$this->GetCode()." in class ".$this->GetHostClass().". The class ".$oKeyAttDef->GetTargetClass()." has no attribute ".$this->Get("target_attcode")); + } + + return $oExtAttDef; + } + + /** + * @return mixed + * @throws CoreException + */ + public function GetSQLExpr() + { + $oExtAttDef = $this->GetExtAttDef(); + + return $oExtAttDef->GetSQLExpr(); + } + + public function GetDefaultValue(DBObject $oHostObject = null) + { + $oExtAttDef = $this->GetExtAttDef(); + + return $oExtAttDef->GetDefaultValue(); + } + + public function IsNullAllowed() + { + $oExtAttDef = $this->GetExtAttDef(); + + return $oExtAttDef->IsNullAllowed(); + } + + public static function IsScalar() + { + return true; + } + + public function GetBasicFilterOperators() + { + $oExtAttDef = $this->GetExtAttDef(); + + return $oExtAttDef->GetBasicFilterOperators(); + } + + public function GetBasicFilterLooseOperator() + { + $oExtAttDef = $this->GetExtAttDef(); + + return $oExtAttDef->GetBasicFilterLooseOperator(); + } + + public function GetBasicFilterSQLExpr($sOpCode, $value) + { + $oExtAttDef = $this->GetExtAttDef(); + + return $oExtAttDef->GetBasicFilterSQLExpr($sOpCode, $value); + } + + public function GetNullValue() + { + $oExtAttDef = $this->GetExtAttDef(); + + return $oExtAttDef->GetNullValue(); + } + + public function IsNull($proposedValue) + { + $oExtAttDef = $this->GetExtAttDef(); + + return $oExtAttDef->IsNull($proposedValue); + } + + /** + * @inheritDoc + */ + public function HasAValue($proposedValue): bool + { + $oExtAttDef = $this->GetExtAttDef(); + + return $oExtAttDef->HasAValue($proposedValue); + } + + public function MakeRealValue($proposedValue, $oHostObj) + { + $oExtAttDef = $this->GetExtAttDef(); + + return $oExtAttDef->MakeRealValue($proposedValue, $oHostObj); + } + + /** + * @inheritDoc + * @since 3.1.0 N°6271 Delegate to remote attribute to ensure cascading computed values + */ + public function GetSQLValues($value) + { + $oExtAttDef = $this->GetExtAttDef(); + + return $oExtAttDef->GetSQLValues($value); + } + + public function ScalarToSQL($value) + { + // This one could be used in case of filtering only + $oExtAttDef = $this->GetExtAttDef(); + + return $oExtAttDef->ScalarToSQL($value); + } + + + // Do not overload GetSQLExpression here because this is handled in the joins + //public function GetSQLExpressions($sPrefix = '') {return array();} + + // Here, we get the data... + public function FromSQLToValue($aCols, $sPrefix = '') + { + $oExtAttDef = $this->GetExtAttDef(); + + return $oExtAttDef->FromSQLToValue($aCols, $sPrefix); + } + + public function GetAsHTML($value, $oHostObject = null, $bLocalize = true) + { + $oExtAttDef = $this->GetExtAttDef(); + + return $oExtAttDef->GetAsHTML($value, null, $bLocalize); + } + + public function GetAsXML($value, $oHostObject = null, $bLocalize = true) + { + $oExtAttDef = $this->GetExtAttDef(); + + return $oExtAttDef->GetAsXML($value, null, $bLocalize); + } + + public function GetAsCSV( + $value, $sSeparator = ',', $sTestQualifier = '"', $oHostObject = null, $bLocalize = true, + $bConvertToPlainText = false + ) + { + $oExtAttDef = $this->GetExtAttDef(); + + return $oExtAttDef->GetAsCSV($value, $sSeparator, $sTestQualifier, null, $bLocalize, $bConvertToPlainText); + } + + public static function GetFormFieldClass() + { + return '\\Combodo\\iTop\\Form\\Field\\LabelField'; + } + + /** + * @param DBObject $oObject + * @param Field $oFormField + * + * @return null + * @throws CoreException + */ + public function MakeFormField(DBObject $oObject, $oFormField = null) + { + // Retrieving AttDef from the remote attribute + $oRemoteAttDef = $this->GetExtAttDef(); + + if ($oFormField === null) { + // ExternalField's FormField are actually based on the FormField from the target attribute. + // Except for the AttributeExternalKey because we have no OQL and stuff + if ($oRemoteAttDef instanceof AttributeExternalKey) { + $sFormFieldClass = static::GetFormFieldClass(); + } else { + $sFormFieldClass = $oRemoteAttDef::GetFormFieldClass(); + } + /** @var Field $oFormField */ + $oFormField = new $sFormFieldClass($this->GetCode()); + switch ($sFormFieldClass) { + case '\Combodo\iTop\Form\Field\SelectField': + $oFormField->SetChoices($oRemoteAttDef->GetAllowedValues($oObject->ToArgsForQuery())); + break; + default: + break; + } + } + parent::MakeFormField($oObject, $oFormField); + if ($oFormField instanceof \Combodo\iTop\Form\Field\TextAreaField) { + if (method_exists($oRemoteAttDef, 'GetFormat')) { + /** @var TextAreaField $oFormField */ + $oFormField->SetFormat($oRemoteAttDef->GetFormat()); + } + } + + // Manually setting for remote ExternalKey, otherwise, the id would be displayed. + if ($oRemoteAttDef instanceof AttributeExternalKey) { + $oFormField->SetCurrentValue($oObject->Get($this->GetCode().'_friendlyname')); + } + + // Readonly field because we can't update external fields + $oFormField->SetReadOnly(true); + + return $oFormField; + } + + public function IsPartOfFingerprint() + { + return false; + } + + public function GetFormat() + { + $oRemoteAttDef = $this->GetExtAttDef(); + if (method_exists($oRemoteAttDef, 'GetFormat')) { + /** @var TextAreaField $oFormField */ + return $oRemoteAttDef->GetFormat(); + } + + return 'text'; + } } \ No newline at end of file diff --git a/sources/Core/AttributeDefinition/AttributeExternalKey.php b/sources/Core/AttributeDefinition/AttributeExternalKey.php index 3be7a2989..96042294e 100644 --- a/sources/Core/AttributeDefinition/AttributeExternalKey.php +++ b/sources/Core/AttributeDefinition/AttributeExternalKey.php @@ -1,4 +1,20 @@ GetFinalAttDef(); - $sTargetClass = $oRemoteAtt->GetTargetClass(); - if (MetaModel::IsHierarchicalClass($sTargetClass)) { - return self::SEARCH_WIDGET_TYPE_HIERARCHICAL_KEY; - } + /** + * Return the search widget type corresponding to this attribute + * + * @return string + */ + public function GetSearchType() + { + try { + $oRemoteAtt = $this->GetFinalAttDef(); + $sTargetClass = $oRemoteAtt->GetTargetClass(); + if (MetaModel::IsHierarchicalClass($sTargetClass)) { + return self::SEARCH_WIDGET_TYPE_HIERARCHICAL_KEY; + } - return self::SEARCH_WIDGET_TYPE_EXTERNAL_KEY; - } catch (CoreException $e) { - } + return self::SEARCH_WIDGET_TYPE_EXTERNAL_KEY; + } + catch (CoreException $e) { + } - return self::SEARCH_WIDGET_TYPE_RAW; - } + return self::SEARCH_WIDGET_TYPE_RAW; + } - public static function ListExpectedParams() - { - return array_merge(parent::ListExpectedParams(), array("targetclass", "is_null_allowed", "on_target_delete")); - } + public static function ListExpectedParams() + { + return array_merge(parent::ListExpectedParams(), array("targetclass", "is_null_allowed", "on_target_delete")); + } - public function GetEditClass() - { - return "ExtKey"; - } + public function GetEditClass() + { + return "ExtKey"; + } - protected function GetSQLCol($bFullSpec = false) - { - return "INT(11)" . ($bFullSpec ? " DEFAULT 0" : ""); - } + protected function GetSQLCol($bFullSpec = false) + { + return "INT(11)".($bFullSpec ? " DEFAULT 0" : ""); + } - public function RequiresIndex() - { - return true; - } + public function RequiresIndex() + { + return true; + } - public function IsExternalKey($iType = EXTKEY_RELATIVE) - { - return true; - } + public function IsExternalKey($iType = EXTKEY_RELATIVE) + { + return true; + } - public function GetTargetClass($iType = EXTKEY_RELATIVE) - { - return $this->Get("targetclass"); - } + public function GetTargetClass($iType = EXTKEY_RELATIVE) + { + return $this->Get("targetclass"); + } - public function GetKeyAttDef($iType = EXTKEY_RELATIVE) - { - return $this; - } + public function GetKeyAttDef($iType = EXTKEY_RELATIVE) + { + return $this; + } - public function GetKeyAttCode() - { - return $this->GetCode(); - } + public function GetKeyAttCode() + { + return $this->GetCode(); + } - public function GetDisplayStyle() - { - return $this->GetOptional('display_style', 'select'); - } + public function GetDisplayStyle() + { + return $this->GetOptional('display_style', 'select'); + } - public function GetDefaultValue(DBObject $oHostObject = null) - { - return 0; - } + public function GetDefaultValue(DBObject $oHostObject = null) + { + return 0; + } - public function IsNullAllowed() - { - if (MetaModel::GetConfig()->Get('disable_mandatory_ext_keys')) { - return true; - } + public function IsNullAllowed() + { + if (MetaModel::GetConfig()->Get('disable_mandatory_ext_keys')) { + return true; + } - return $this->Get("is_null_allowed"); - } + return $this->Get("is_null_allowed"); + } - public function GetBasicFilterOperators() - { - return parent::GetBasicFilterOperators(); - } + public function GetBasicFilterOperators() + { + return parent::GetBasicFilterOperators(); + } - public function GetBasicFilterLooseOperator() - { - return parent::GetBasicFilterLooseOperator(); - } + public function GetBasicFilterLooseOperator() + { + return parent::GetBasicFilterLooseOperator(); + } - public function GetBasicFilterSQLExpr($sOpCode, $value) - { - return parent::GetBasicFilterSQLExpr($sOpCode, $value); - } + public function GetBasicFilterSQLExpr($sOpCode, $value) + { + return parent::GetBasicFilterSQLExpr($sOpCode, $value); + } - // overloaded here so that an ext key always have the answer to - // "what are your possible values?" - public function GetValuesDef() - { - $oValSetDef = $this->Get("allowed_values"); - if (!$oValSetDef) { - // Let's propose every existing value - $oValSetDef = new ValueSetObjects('SELECT ' . $this->GetTargetClass()); - } + // overloaded here so that an ext key always have the answer to + // "what are your possible values?" + public function GetValuesDef() + { + $oValSetDef = $this->Get("allowed_values"); + if (!$oValSetDef) { + // Let's propose every existing value + $oValSetDef = new ValueSetObjects('SELECT '.$this->GetTargetClass()); + } - return $oValSetDef; - } + return $oValSetDef; + } - public function GetAllowedValues($aArgs = array(), $sContains = '') - { - //throw new Exception("GetAllowedValues on ext key has been deprecated"); - try { - return parent::GetAllowedValues($aArgs, $sContains); - } catch (Exception $e) { - // Some required arguments could not be found, enlarge to any existing value - $oValSetDef = new ValueSetObjects('SELECT ' . $this->GetTargetClass()); + public function GetAllowedValues($aArgs = array(), $sContains = '') + { + //throw new Exception("GetAllowedValues on ext key has been deprecated"); + try { + return parent::GetAllowedValues($aArgs, $sContains); + } + catch (Exception $e) { + // Some required arguments could not be found, enlarge to any existing value + $oValSetDef = new ValueSetObjects('SELECT '.$this->GetTargetClass()); - return $oValSetDef->GetValues($aArgs, $sContains); - } - } + return $oValSetDef->GetValues($aArgs, $sContains); + } + } - public function GetAllowedValuesForSelect($aArgs = array(), $sContains = '') - { - //$this->GetValuesDef(); - $oValSetDef = new ValueSetObjects('SELECT ' . $this->GetTargetClass()); - return $oValSetDef->GetValuesForAutocomplete($aArgs, $sContains); - } + public function GetAllowedValuesForSelect($aArgs = array(), $sContains = '') + { + //$this->GetValuesDef(); + $oValSetDef = new ValueSetObjects('SELECT '.$this->GetTargetClass()); + + return $oValSetDef->GetValuesForAutocomplete($aArgs, $sContains); + } - public function GetAllowedValuesAsObjectSet($aArgs = array(), $sContains = '', $iAdditionalValue = null) - { - $oValSetDef = $this->GetValuesDef(); - $oSet = $oValSetDef->ToObjectSet($aArgs, $sContains, $iAdditionalValue); + public function GetAllowedValuesAsObjectSet($aArgs = array(), $sContains = '', $iAdditionalValue = null) + { + $oValSetDef = $this->GetValuesDef(); + $oSet = $oValSetDef->ToObjectSet($aArgs, $sContains, $iAdditionalValue); - return $oSet; - } + return $oSet; + } - public function GetAllowedValuesAsFilter($aArgs = array(), $sContains = '', $iAdditionalValue = null) - { - return DBObjectSearch::FromOQL($this->GetValuesDef()->GetFilterExpression()); - } + public function GetAllowedValuesAsFilter($aArgs = array(), $sContains = '', $iAdditionalValue = null) + { + return DBObjectSearch::FromOQL($this->GetValuesDef()->GetFilterExpression()); + } - public function GetDeletionPropagationOption() - { - return $this->Get("on_target_delete"); - } + public function GetDeletionPropagationOption() + { + return $this->Get("on_target_delete"); + } - public function GetNullValue() - { - return 0; - } + public function GetNullValue() + { + return 0; + } - public function IsNull($proposedValue) - { - return ($proposedValue == 0); - } + public function IsNull($proposedValue) + { + return ($proposedValue == 0); + } - /** - * @inheritDoc - */ - public function HasAValue($proposedValue): bool - { - return ((int)$proposedValue) !== 0; - } + /** + * @inheritDoc + */ + public function HasAValue($proposedValue): bool + { + return ((int)$proposedValue) !== 0; + } - public function MakeRealValue($proposedValue, $oHostObj) - { - if (is_null($proposedValue)) { - return 0; - } - if ($proposedValue === '') { - return 0; - } - if (MetaModel::IsValidObject($proposedValue)) { - return $proposedValue->GetKey(); - } + public function MakeRealValue($proposedValue, $oHostObj) + { + if (is_null($proposedValue)) { + return 0; + } + if ($proposedValue === '') { + return 0; + } + if (MetaModel::IsValidObject($proposedValue)) { + return $proposedValue->GetKey(); + } - return (int)$proposedValue; - } + return (int)$proposedValue; + } - /** @inheritdoc @since 3.1 */ - public function WriteExternalValues(DBObject $oHostObject): void - { - $sTargetKey = $oHostObject->Get($this->GetCode()); - $oFilter = DBSearch::FromOQL('SELECT `' . TemporaryObjectDescriptor::class . '` WHERE item_class=:class AND item_id=:id'); - $oSet = new DBObjectSet($oFilter, [], ['class' => $this->GetTargetClass(), 'id' => $sTargetKey]); - while ($oTemporaryObjectDescriptor = $oSet->Fetch()) { - $oTemporaryObjectDescriptor->Set('host_class', get_class($oHostObject)); - $oTemporaryObjectDescriptor->Set('host_id', $oHostObject->GetKey()); - $oTemporaryObjectDescriptor->Set('host_att_code', $this->GetCode()); - $oTemporaryObjectDescriptor->DBUpdate(); - } - } + /** @inheritdoc @since 3.1 */ + public function WriteExternalValues(DBObject $oHostObject): void + { + $sTargetKey = $oHostObject->Get($this->GetCode()); + $oFilter = DBSearch::FromOQL('SELECT `'.TemporaryObjectDescriptor::class.'` WHERE item_class=:class AND item_id=:id'); + $oSet = new DBObjectSet($oFilter, [], ['class' => $this->GetTargetClass(), 'id' => $sTargetKey]); + while ($oTemporaryObjectDescriptor = $oSet->Fetch()) { + $oTemporaryObjectDescriptor->Set('host_class', get_class($oHostObject)); + $oTemporaryObjectDescriptor->Set('host_id', $oHostObject->GetKey()); + $oTemporaryObjectDescriptor->Set('host_att_code', $this->GetCode()); + $oTemporaryObjectDescriptor->DBUpdate(); + } + } - public function GetMaximumComboLength() - { - return $this->GetOptional('max_combo_length', MetaModel::GetConfig()->Get('max_combo_length')); - } + public function GetMaximumComboLength() + { + return $this->GetOptional('max_combo_length', MetaModel::GetConfig()->Get('max_combo_length')); + } - public function GetMinAutoCompleteChars() - { - return $this->GetOptional('min_autocomplete_chars', MetaModel::GetConfig()->Get('min_autocomplete_chars')); - } + public function GetMinAutoCompleteChars() + { + return $this->GetOptional('min_autocomplete_chars', MetaModel::GetConfig()->Get('min_autocomplete_chars')); + } - /** - * @return int - * @since 3.0.0 - */ - public function GetMaxAutoCompleteResults(): int - { - return MetaModel::GetConfig()->Get('max_autocomplete_results'); - } + /** + * @return int + * @since 3.0.0 + */ + public function GetMaxAutoCompleteResults(): int + { + return MetaModel::GetConfig()->Get('max_autocomplete_results'); + } - public function AllowTargetCreation() - { - return $this->GetOptional('allow_target_creation', MetaModel::GetConfig()->Get('allow_target_creation')); - } + public function AllowTargetCreation() + { + return $this->GetOptional('allow_target_creation', MetaModel::GetConfig()->Get('allow_target_creation')); + } - /** - * Find the corresponding "link" attribute on the target class, if any - * - * @return null | AttributeDefinition - * @throws \CoreException - */ - public function GetMirrorLinkAttribute() - { - $oRet = null; - $sRemoteClass = $this->GetTargetClass(); - foreach (MetaModel::ListAttributeDefs($sRemoteClass) as $sRemoteAttCode => $oRemoteAttDef) { - if (!$oRemoteAttDef->IsLinkSet()) { - continue; - } - if (!is_subclass_of($this->GetHostClass(), - $oRemoteAttDef->GetLinkedClass()) && $oRemoteAttDef->GetLinkedClass() != $this->GetHostClass()) { - continue; - } - if ($oRemoteAttDef->GetExtKeyToMe() != $this->GetCode()) { - continue; - } - $oRet = $oRemoteAttDef; - break; - } + /** + * Find the corresponding "link" attribute on the target class, if any + * + * @return null | AttributeDefinition + * @throws \CoreException + */ + public function GetMirrorLinkAttribute() + { + $oRet = null; + $sRemoteClass = $this->GetTargetClass(); + foreach (MetaModel::ListAttributeDefs($sRemoteClass) as $sRemoteAttCode => $oRemoteAttDef) { + if (!$oRemoteAttDef->IsLinkSet()) { + continue; + } + if (!is_subclass_of($this->GetHostClass(), + $oRemoteAttDef->GetLinkedClass()) && $oRemoteAttDef->GetLinkedClass() != $this->GetHostClass()) { + continue; + } + if ($oRemoteAttDef->GetExtKeyToMe() != $this->GetCode()) { + continue; + } + $oRet = $oRemoteAttDef; + break; + } - return $oRet; - } + return $oRet; + } - public static function GetFormFieldClass() - { - return '\\Combodo\\iTop\\Form\\Field\\SelectObjectField'; - } + public static function GetFormFieldClass() + { + return '\\Combodo\\iTop\\Form\\Field\\SelectObjectField'; + } - public function MakeFormField(DBObject $oObject, $oFormField = null) - { - /** @var \Combodo\iTop\Form\Field\Field $oFormField */ - if ($oFormField === null) { - // Later : We should check $this->Get('display_style') and create a Radio / Select / ... regarding its value - $sFormFieldClass = static::GetFormFieldClass(); - $oFormField = new $sFormFieldClass($this->GetCode()); - } + public function MakeFormField(DBObject $oObject, $oFormField = null) + { + /** @var \Combodo\iTop\Form\Field\Field $oFormField */ + if ($oFormField === null) { + // Later : We should check $this->Get('display_style') and create a Radio / Select / ... regarding its value + $sFormFieldClass = static::GetFormFieldClass(); + $oFormField = new $sFormFieldClass($this->GetCode()); + } - // Setting params - $oFormField->SetMaximumComboLength($this->GetMaximumComboLength()); - $oFormField->SetMinAutoCompleteChars($this->GetMinAutoCompleteChars()); - $oFormField->SetMaxAutoCompleteResults($this->GetMaxAutoCompleteResults()); - $oFormField->SetHierarchical(MetaModel::IsHierarchicalClass($this->GetTargetClass())); - // Setting choices regarding the field dependencies - $aFieldDependencies = $this->GetPrerequisiteAttributes(); - if (!empty($aFieldDependencies)) { - $oTmpAttDef = $this; - $oTmpField = $oFormField; - $oFormField->SetOnFinalizeCallback(function () use ($oTmpField, $oTmpAttDef, $oObject) { - /** @var $oTmpField \Combodo\iTop\Form\Field\Field */ - /** @var $oTmpAttDef \AttributeDefinition */ - /** @var $oObject \DBObject */ + // Setting params + $oFormField->SetMaximumComboLength($this->GetMaximumComboLength()); + $oFormField->SetMinAutoCompleteChars($this->GetMinAutoCompleteChars()); + $oFormField->SetMaxAutoCompleteResults($this->GetMaxAutoCompleteResults()); + $oFormField->SetHierarchical(MetaModel::IsHierarchicalClass($this->GetTargetClass())); + // Setting choices regarding the field dependencies + $aFieldDependencies = $this->GetPrerequisiteAttributes(); + if (!empty($aFieldDependencies)) { + $oTmpAttDef = $this; + $oTmpField = $oFormField; + $oFormField->SetOnFinalizeCallback(function () use ($oTmpField, $oTmpAttDef, $oObject) { + /** @var $oTmpField \Combodo\iTop\Form\Field\Field */ + /** @var $oTmpAttDef \AttributeDefinition */ + /** @var $oObject \DBObject */ - // We set search object only if it has not already been set (overrided) - if ($oTmpField->GetSearch() === null) { - $oSearch = DBSearch::FromOQL($oTmpAttDef->GetValuesDef()->GetFilterExpression()); - $oSearch->SetInternalParams(array('this' => $oObject)); - $oTmpField->SetSearch($oSearch); - } - }); - } else { - $oSearch = DBSearch::FromOQL($this->GetValuesDef()->GetFilterExpression()); - $oSearch->SetInternalParams(array('this' => $oObject)); - $oFormField->SetSearch($oSearch); - } + // We set search object only if it has not already been set (overrided) + if ($oTmpField->GetSearch() === null) { + $oSearch = DBSearch::FromOQL($oTmpAttDef->GetValuesDef()->GetFilterExpression()); + $oSearch->SetInternalParams(array('this' => $oObject)); + $oTmpField->SetSearch($oSearch); + } + }); + } else { + $oSearch = DBSearch::FromOQL($this->GetValuesDef()->GetFilterExpression()); + $oSearch->SetInternalParams(array('this' => $oObject)); + $oFormField->SetSearch($oSearch); + } - parent::MakeFormField($oObject, $oFormField); + parent::MakeFormField($oObject, $oFormField); - return $oFormField; - } + return $oFormField; + } - public function GetAsHTML($sValue, $oHostObject = null, $bLocalize = true) - { - if (!is_null($oHostObject)) { - return $oHostObject->GetAsHTML($this->GetCode(), $oHostObject); - } + public function GetAsHTML($sValue, $oHostObject = null, $bLocalize = true) + { + if (!is_null($oHostObject)) { + return $oHostObject->GetAsHTML($this->GetCode(), $oHostObject); + } - return DBObject::MakeHyperLink($this->GetTargetClass(), $sValue); - } + return DBObject::MakeHyperLink($this->GetTargetClass(), $sValue); + } } \ No newline at end of file diff --git a/sources/Core/AttributeDefinition/AttributeFinalClass.php b/sources/Core/AttributeDefinition/AttributeFinalClass.php index c104e4f13..ce8fddcd3 100644 --- a/sources/Core/AttributeDefinition/AttributeFinalClass.php +++ b/sources/Core/AttributeDefinition/AttributeFinalClass.php @@ -1,4 +1,14 @@ m_sCode = $sCode; - $aParams["allowed_values"] = null; - parent::__construct($sCode, $aParams); + public function __construct($sCode, $aParams) + { + $this->m_sCode = $sCode; + $aParams["allowed_values"] = null; + parent::__construct($sCode, $aParams); - $this->m_sValue = $this->Get("default_value"); - } + $this->m_sValue = $this->Get("default_value"); + } - public function IsWritable() - { - return false; - } + public function IsWritable() + { + return false; + } - public function IsMagic() - { - return true; - } + public function IsMagic() + { + return true; + } - public function RequiresIndex() - { - return true; - } + public function RequiresIndex() + { + return true; + } - public function SetFixedValue($sValue) - { - $this->m_sValue = $sValue; - } + public function SetFixedValue($sValue) + { + $this->m_sValue = $sValue; + } - public function GetDefaultValue(DBObject $oHostObject = null) - { - return $this->m_sValue; - } + public function GetDefaultValue(DBObject $oHostObject = null) + { + return $this->m_sValue; + } - public function GetAsHTML($sValue, $oHostObject = null, $bLocalize = true) - { - if (empty($sValue)) { - return ''; - } - if ($bLocalize) { - return MetaModel::GetName($sValue); - } else { - return $sValue; - } - } + public function GetAsHTML($sValue, $oHostObject = null, $bLocalize = true) + { + if (empty($sValue)) { + return ''; + } + if ($bLocalize) { + return MetaModel::GetName($sValue); + } else { + return $sValue; + } + } - /** - * An enum can be localized - * - * @param string $sProposedValue - * @param bool $bLocalizedValue - * @param string $sSepItem - * @param string $sSepAttribute - * @param string $sSepValue - * @param string $sAttributeQualifier - * - * @return mixed|null|string - * @throws \CoreException - * @throws \OQLException - */ - public function MakeValueFromString( - $sProposedValue, $bLocalizedValue = false, $sSepItem = null, $sSepAttribute = null, $sSepValue = null, - $sAttributeQualifier = null - ) - { - if ($bLocalizedValue) { - // Lookup for the value matching the input - // - $sFoundValue = null; - $aRawValues = self::GetAllowedValues(); - if (!is_null($aRawValues)) { - foreach ($aRawValues as $sKey => $sValue) { - if ($sProposedValue == $sValue) { - $sFoundValue = $sKey; - break; - } - } - } - if (is_null($sFoundValue)) { - return null; - } + /** + * An enum can be localized + * + * @param string $sProposedValue + * @param bool $bLocalizedValue + * @param string $sSepItem + * @param string $sSepAttribute + * @param string $sSepValue + * @param string $sAttributeQualifier + * + * @return mixed|null|string + * @throws CoreException + * @throws OQLException + */ + public function MakeValueFromString( + $sProposedValue, $bLocalizedValue = false, $sSepItem = null, $sSepAttribute = null, $sSepValue = null, + $sAttributeQualifier = null + ) + { + if ($bLocalizedValue) { + // Lookup for the value matching the input + // + $sFoundValue = null; + $aRawValues = self::GetAllowedValues(); + if (!is_null($aRawValues)) { + foreach ($aRawValues as $sKey => $sValue) { + if ($sProposedValue == $sValue) { + $sFoundValue = $sKey; + break; + } + } + } + if (is_null($sFoundValue)) { + return null; + } - return $this->MakeRealValue($sFoundValue, null); - } else { - return parent::MakeValueFromString($sProposedValue, $bLocalizedValue, $sSepItem, $sSepAttribute, $sSepValue, - $sAttributeQualifier); - } - } + return $this->MakeRealValue($sFoundValue, null); + } else { + return parent::MakeValueFromString($sProposedValue, $bLocalizedValue, $sSepItem, $sSepAttribute, $sSepValue, + $sAttributeQualifier); + } + } - // Because this is sometimes used to get a localized/string version of an attribute... - public function GetEditValue($sValue, $oHostObj = null) - { - if (empty($sValue)) { - return ''; - } + // Because this is sometimes used to get a localized/string version of an attribute... + public function GetEditValue($sValue, $oHostObj = null) + { + if (empty($sValue)) { + return ''; + } - return MetaModel::GetName($sValue); - } + return MetaModel::GetName($sValue); + } - public function GetForJSON($value) - { - // JSON values are NOT localized - return $value; - } + public function GetForJSON($value) + { + // JSON values are NOT localized + return $value; + } - /** - * @param $value - * @param string $sSeparator - * @param string $sTextQualifier - * @param \DBObject $oHostObject - * @param bool $bLocalize - * @param bool $bConvertToPlainText - * - * @return string - * @throws \CoreException - * @throws \DictExceptionMissingString - */ - public function GetAsCSV( - $value, $sSeparator = ',', $sTextQualifier = '"', $oHostObject = null, $bLocalize = true, - $bConvertToPlainText = false - ) - { - if ($bLocalize && $value != '') { - $sRawValue = MetaModel::GetName($value); - } else { - $sRawValue = $value; - } + /** + * @param $value + * @param string $sSeparator + * @param string $sTextQualifier + * @param DBObject $oHostObject + * @param bool $bLocalize + * @param bool $bConvertToPlainText + * + * @return string + * @throws CoreException + * @throws DictExceptionMissingString + */ + public function GetAsCSV( + $value, $sSeparator = ',', $sTextQualifier = '"', $oHostObject = null, $bLocalize = true, + $bConvertToPlainText = false + ) + { + if ($bLocalize && $value != '') { + $sRawValue = MetaModel::GetName($value); + } else { + $sRawValue = $value; + } - return parent::GetAsCSV($sRawValue, $sSeparator, $sTextQualifier, null, false, $bConvertToPlainText); - } + return parent::GetAsCSV($sRawValue, $sSeparator, $sTextQualifier, null, false, $bConvertToPlainText); + } - public function GetAsXML($value, $oHostObject = null, $bLocalize = true) - { - if (empty($value)) { - return ''; - } - if ($bLocalize) { - $sRawValue = MetaModel::GetName($value); - } else { - $sRawValue = $value; - } + public function GetAsXML($value, $oHostObject = null, $bLocalize = true) + { + if (empty($value)) { + return ''; + } + if ($bLocalize) { + $sRawValue = MetaModel::GetName($value); + } else { + $sRawValue = $value; + } - return Str::pure2xml($sRawValue); - } + return Str::pure2xml($sRawValue); + } - public function GetBasicFilterLooseOperator() - { - return '='; - } + public function GetBasicFilterLooseOperator() + { + return '='; + } - public function GetValueLabel($sValue) - { - if (empty($sValue)) { - return ''; - } + public function GetValueLabel($sValue) + { + if (empty($sValue)) { + return ''; + } - return MetaModel::GetName($sValue); - } + return MetaModel::GetName($sValue); + } - public function GetAllowedValues($aArgs = array(), $sContains = '') - { - $aRawValues = MetaModel::EnumChildClasses($this->GetHostClass(), ENUM_CHILD_CLASSES_ALL); - $aLocalizedValues = array(); - foreach ($aRawValues as $sClass) { - $aLocalizedValues[$sClass] = MetaModel::GetName($sClass); - } + public function GetAllowedValues($aArgs = array(), $sContains = '') + { + $aRawValues = MetaModel::EnumChildClasses($this->GetHostClass(), ENUM_CHILD_CLASSES_ALL); + $aLocalizedValues = array(); + foreach ($aRawValues as $sClass) { + $aLocalizedValues[$sClass] = MetaModel::GetName($sClass); + } - return $aLocalizedValues; - } + return $aLocalizedValues; + } - /** - * @return bool - * @since 2.7.0 N°2272 OQL perf finalclass in all intermediary tables - */ - public function CopyOnAllTables() - { - $sClass = self::GetHostClass(); - if (MetaModel::IsLeafClass($sClass)) { - // Leaf class, no finalclass - return false; - } - return true; - } + /** + * @return bool + * @since 2.7.0 N°2272 OQL perf finalclass in all intermediary tables + */ + public function CopyOnAllTables() + { + $sClass = self::GetHostClass(); + if (MetaModel::IsLeafClass($sClass)) { + // Leaf class, no finalclass + return false; + } + + return true; + } } \ No newline at end of file diff --git a/sources/Core/AttributeDefinition/AttributeFriendlyName.php b/sources/Core/AttributeDefinition/AttributeFriendlyName.php index e4cfb7a39..6c4f4b3a5 100644 --- a/sources/Core/AttributeDefinition/AttributeFriendlyName.php +++ b/sources/Core/AttributeDefinition/AttributeFriendlyName.php @@ -1,4 +1,16 @@ m_sCode = $sCode; - $aParams = array(); - $aParams["default_value"] = ''; - parent::__construct($sCode, $aParams); + public function __construct($sCode) + { + $this->m_sCode = $sCode; + $aParams = array(); + $aParams["default_value"] = ''; + parent::__construct($sCode, $aParams); - $this->m_sValue = $this->Get("default_value"); - } + $this->m_sValue = $this->Get("default_value"); + } - public function GetEditClass() - { - return ""; - } + public function GetEditClass() + { + return ""; + } - public function GetValuesDef() - { - return null; - } + public function GetValuesDef() + { + return null; + } - public function GetPrerequisiteAttributes($sClass = null) - { - // Code duplicated with AttributeObsolescenceFlag - $aAttributes = $this->GetOptional("depends_on", array()); - $oExpression = $this->GetOQLExpression(); - foreach ($oExpression->ListRequiredFields() as $sAttCode) { - if (!in_array($sAttCode, $aAttributes)) { - $aAttributes[] = $sAttCode; - } - } + public function GetPrerequisiteAttributes($sClass = null) + { + // Code duplicated with AttributeObsolescenceFlag + $aAttributes = $this->GetOptional("depends_on", array()); + $oExpression = $this->GetOQLExpression(); + foreach ($oExpression->ListRequiredFields() as $sAttCode) { + if (!in_array($sAttCode, $aAttributes)) { + $aAttributes[] = $sAttCode; + } + } - return $aAttributes; - } + return $aAttributes; + } - public static function IsScalar() - { - return true; - } + public static function IsScalar() + { + return true; + } - public function IsNullAllowed() - { - return false; - } + public function IsNullAllowed() + { + return false; + } - public function GetSQLExpressions($sPrefix = '') - { - if ($sPrefix == '') { - $sPrefix = $this->GetCode(); // Warning AttributeComputedFieldVoid does not have any sql property - } + public function GetSQLExpressions($sPrefix = '') + { + if ($sPrefix == '') { + $sPrefix = $this->GetCode(); // Warning AttributeComputedFieldVoid does not have any sql property + } - return array('' => $sPrefix); - } + return array('' => $sPrefix); + } - public static function IsBasedOnOQLExpression() - { - return true; - } + public static function IsBasedOnOQLExpression() + { + return true; + } - public function GetOQLExpression() - { - return MetaModel::GetNameExpression($this->GetHostClass()); - } + public function GetOQLExpression() + { + return MetaModel::GetNameExpression($this->GetHostClass()); + } - public function GetLabel($sDefault = null) - { - $sLabel = parent::GetLabel(''); - if (strlen($sLabel) == 0) { - $sLabel = Dict::S('Core:FriendlyName-Label'); - } + public function GetLabel($sDefault = null) + { + $sLabel = parent::GetLabel(''); + if (strlen($sLabel) == 0) { + $sLabel = Dict::S('Core:FriendlyName-Label'); + } - return $sLabel; - } + return $sLabel; + } - public function GetDescription($sDefault = null) - { - $sLabel = parent::GetDescription(''); - if (strlen($sLabel) == 0) { - $sLabel = Dict::S('Core:FriendlyName-Description'); - } + public function GetDescription($sDefault = null) + { + $sLabel = parent::GetDescription(''); + if (strlen($sLabel) == 0) { + $sLabel = Dict::S('Core:FriendlyName-Description'); + } - return $sLabel; - } + return $sLabel; + } - public function FromSQLToValue($aCols, $sPrefix = '') - { - $sValue = $aCols[$sPrefix]; + public function FromSQLToValue($aCols, $sPrefix = '') + { + $sValue = $aCols[$sPrefix]; - return $sValue; - } + return $sValue; + } - public function IsWritable() - { - return false; - } + public function IsWritable() + { + return false; + } - public function IsMagic() - { - return true; - } + public function IsMagic() + { + return true; + } - public static function IsBasedOnDBColumns() - { - return false; - } + public static function IsBasedOnDBColumns() + { + return false; + } - public function SetFixedValue($sValue) - { - $this->m_sValue = $sValue; - } + public function SetFixedValue($sValue) + { + $this->m_sValue = $sValue; + } - public function GetDefaultValue(DBObject $oHostObject = null) - { - return $this->m_sValue; - } + public function GetDefaultValue(DBObject $oHostObject = null) + { + return $this->m_sValue; + } - public function GetAsHTML($sValue, $oHostObject = null, $bLocalize = true) - { - return Str::pure2html((string)$sValue); - } + public function GetAsHTML($sValue, $oHostObject = null, $bLocalize = true) + { + return Str::pure2html((string)$sValue); + } - public function GetAsCSV( - $sValue, $sSeparator = ',', $sTextQualifier = '"', $oHostObject = null, $bLocalize = true, - $bConvertToPlainText = false - ) - { - $sFrom = array("\r\n", $sTextQualifier); - $sTo = array("\n", $sTextQualifier . $sTextQualifier); - $sEscaped = str_replace($sFrom, $sTo, (string)$sValue); + public function GetAsCSV( + $sValue, $sSeparator = ',', $sTextQualifier = '"', $oHostObject = null, $bLocalize = true, + $bConvertToPlainText = false + ) + { + $sFrom = array("\r\n", $sTextQualifier); + $sTo = array("\n", $sTextQualifier.$sTextQualifier); + $sEscaped = str_replace($sFrom, $sTo, (string)$sValue); - return $sTextQualifier . $sEscaped . $sTextQualifier; - } + return $sTextQualifier.$sEscaped.$sTextQualifier; + } - static function GetFormFieldClass() - { - return '\\Combodo\\iTop\\Form\\Field\\StringField'; - } + static function GetFormFieldClass() + { + return '\\Combodo\\iTop\\Form\\Field\\StringField'; + } - public function MakeFormField(DBObject $oObject, $oFormField = null) - { - if ($oFormField === null) { - $sFormFieldClass = static::GetFormFieldClass(); - $oFormField = new $sFormFieldClass($this->GetCode()); - } - $oFormField->SetReadOnly(true); - parent::MakeFormField($oObject, $oFormField); + public function MakeFormField(DBObject $oObject, $oFormField = null) + { + if ($oFormField === null) { + $sFormFieldClass = static::GetFormFieldClass(); + $oFormField = new $sFormFieldClass($this->GetCode()); + } + $oFormField->SetReadOnly(true); + parent::MakeFormField($oObject, $oFormField); - return $oFormField; - } + return $oFormField; + } - // Do not display friendly names in the history of change - public function DescribeChangeAsHTML($sOldValue, $sNewValue, $sLabel = null) - { - return ''; - } + // Do not display friendly names in the history of change + public function DescribeChangeAsHTML($sOldValue, $sNewValue, $sLabel = null) + { + return ''; + } - public function GetBasicFilterOperators() - { - return array("=" => "equals", "!=" => "differs from"); - } + public function GetBasicFilterOperators() + { + return array("=" => "equals", "!=" => "differs from"); + } - public function GetBasicFilterLooseOperator() - { - return "Contains"; - } + public function GetBasicFilterLooseOperator() + { + return "Contains"; + } - public function GetBasicFilterSQLExpr($sOpCode, $value) - { - $sQValue = CMDBSource::Quote($value); - switch ($sOpCode) { - case '=': - case '!=': - return $this->GetSQLExpr() . " $sOpCode $sQValue"; - case 'Contains': - return $this->GetSQLExpr() . " LIKE " . CMDBSource::Quote("%$value%"); - case 'NotLike': - return $this->GetSQLExpr() . " NOT LIKE $sQValue"; - case 'Like': - default: - return $this->GetSQLExpr() . " LIKE $sQValue"; - } - } + public function GetBasicFilterSQLExpr($sOpCode, $value) + { + $sQValue = CMDBSource::Quote($value); + switch ($sOpCode) { + case '=': + case '!=': + return $this->GetSQLExpr()." $sOpCode $sQValue"; + case 'Contains': + return $this->GetSQLExpr()." LIKE ".CMDBSource::Quote("%$value%"); + case 'NotLike': + return $this->GetSQLExpr()." NOT LIKE $sQValue"; + case 'Like': + default: + return $this->GetSQLExpr()." LIKE $sQValue"; + } + } - public function IsPartOfFingerprint() - { - return false; - } + public function IsPartOfFingerprint() + { + return false; + } } \ No newline at end of file diff --git a/sources/Core/AttributeDefinition/AttributeHTML.php b/sources/Core/AttributeDefinition/AttributeHTML.php index 953e7c9a5..03deb3dbb 100644 --- a/sources/Core/AttributeDefinition/AttributeHTML.php +++ b/sources/Core/AttributeDefinition/AttributeHTML.php @@ -1,4 +1,10 @@ ?), containing HTML code, to an attribute @@ -7,45 +13,45 @@ */ class AttributeHTML extends AttributeLongText { - /** - * Useless constructor, but if not present PHP 7.4.0/7.4.1 is crashing :( (N°2329) - * - * @see https://www.php.net/manual/fr/language.oop5.decon.php states that child constructor can be ommited - * @see https://bugs.php.net/bug.php?id=79010 bug solved in PHP 7.4.9 - * - * @param string $sCode - * @param array $aParams - * - * @throws \Exception - * @noinspection SenselessProxyMethodInspection - */ - public function __construct($sCode, $aParams) - { - parent::__construct($sCode, $aParams); - } + /** + * Useless constructor, but if not present PHP 7.4.0/7.4.1 is crashing :( (N°2329) + * + * @see https://www.php.net/manual/fr/language.oop5.decon.php states that child constructor can be ommited + * @see https://bugs.php.net/bug.php?id=79010 bug solved in PHP 7.4.9 + * + * @param string $sCode + * @param array $aParams + * + * @throws Exception + * @noinspection SenselessProxyMethodInspection + */ + public function __construct($sCode, $aParams) + { + parent::__construct($sCode, $aParams); + } - public function GetSQLColumns($bFullSpec = false) - { - $aColumns = array(); - $aColumns[$this->Get('sql')] = $this->GetSQLCol(); - if ($this->GetOptional('format', null) != null) { - // Add the extra column only if the property 'format' is specified for the attribute - $aColumns[$this->Get('sql') . '_format'] = "ENUM('text','html')"; - if ($bFullSpec) { - $aColumns[$this->Get('sql') . '_format'] .= " DEFAULT 'html'"; // default 'html' is for migrating old records - } - } + public function GetSQLColumns($bFullSpec = false) + { + $aColumns = array(); + $aColumns[$this->Get('sql')] = $this->GetSQLCol(); + if ($this->GetOptional('format', null) != null) { + // Add the extra column only if the property 'format' is specified for the attribute + $aColumns[$this->Get('sql').'_format'] = "ENUM('text','html')"; + if ($bFullSpec) { + $aColumns[$this->Get('sql').'_format'] .= " DEFAULT 'html'"; // default 'html' is for migrating old records + } + } - return $aColumns; - } + return $aColumns; + } - /** - * The actual formatting of the text: either text (=plain text) or html (= text with HTML markup) - * - * @return string - */ - public function GetFormat() - { - return $this->GetOptional('format', 'html'); // Defaults to HTML - } + /** + * The actual formatting of the text: either text (=plain text) or html (= text with HTML markup) + * + * @return string + */ + public function GetFormat() + { + return $this->GetOptional('format', 'html'); // Defaults to HTML + } } \ No newline at end of file diff --git a/sources/Core/AttributeDefinition/AttributeHierarchicalKey.php b/sources/Core/AttributeDefinition/AttributeHierarchicalKey.php index fe4d5fe6a..f547f2675 100644 --- a/sources/Core/AttributeDefinition/AttributeHierarchicalKey.php +++ b/sources/Core/AttributeDefinition/AttributeHierarchicalKey.php @@ -1,186 +1,194 @@ m_sTargetClass)) { - $this->m_sTargetClass = $sHostClass; - } - parent::SetHostClass($sHostClass); - } + /* + * The target class is the class for which the attribute has been defined first + */ + public function SetHostClass($sHostClass) + { + if (!isset($this->m_sTargetClass)) { + $this->m_sTargetClass = $sHostClass; + } + parent::SetHostClass($sHostClass); + } - public static function IsHierarchicalKey() - { - return true; - } + public static function IsHierarchicalKey() + { + return true; + } - public function GetTargetClass($iType = EXTKEY_RELATIVE) - { - return $this->m_sTargetClass; - } + public function GetTargetClass($iType = EXTKEY_RELATIVE) + { + return $this->m_sTargetClass; + } - public function GetKeyAttDef($iType = EXTKEY_RELATIVE) - { - return $this; - } + public function GetKeyAttDef($iType = EXTKEY_RELATIVE) + { + return $this; + } - public function GetKeyAttCode() - { - return $this->GetCode(); - } + public function GetKeyAttCode() + { + return $this->GetCode(); + } - public function GetBasicFilterOperators() - { - return parent::GetBasicFilterOperators(); - } + public function GetBasicFilterOperators() + { + return parent::GetBasicFilterOperators(); + } - public function GetBasicFilterLooseOperator() - { - return parent::GetBasicFilterLooseOperator(); - } + public function GetBasicFilterLooseOperator() + { + return parent::GetBasicFilterLooseOperator(); + } - public function GetSQLColumns($bFullSpec = false) - { - $aColumns = array(); - $aColumns[$this->GetCode()] = 'INT(11)' . ($bFullSpec ? ' DEFAULT 0' : ''); - $aColumns[$this->GetSQLLeft()] = 'INT(11)' . ($bFullSpec ? ' DEFAULT 0' : ''); - $aColumns[$this->GetSQLRight()] = 'INT(11)' . ($bFullSpec ? ' DEFAULT 0' : ''); + public function GetSQLColumns($bFullSpec = false) + { + $aColumns = array(); + $aColumns[$this->GetCode()] = 'INT(11)'.($bFullSpec ? ' DEFAULT 0' : ''); + $aColumns[$this->GetSQLLeft()] = 'INT(11)'.($bFullSpec ? ' DEFAULT 0' : ''); + $aColumns[$this->GetSQLRight()] = 'INT(11)'.($bFullSpec ? ' DEFAULT 0' : ''); - return $aColumns; - } + return $aColumns; + } - public function GetSQLRight() - { - return $this->GetCode() . '_right'; - } + public function GetSQLRight() + { + return $this->GetCode().'_right'; + } - public function GetSQLLeft() - { - return $this->GetCode() . '_left'; - } + public function GetSQLLeft() + { + return $this->GetCode().'_left'; + } - public function GetSQLValues($value) - { - if (!is_array($value)) { - $aValues[$this->GetCode()] = $value; - } else { - $aValues = array(); - $aValues[$this->GetCode()] = $value[$this->GetCode()]; - $aValues[$this->GetSQLRight()] = $value[$this->GetSQLRight()]; - $aValues[$this->GetSQLLeft()] = $value[$this->GetSQLLeft()]; - } + public function GetSQLValues($value) + { + if (!is_array($value)) { + $aValues[$this->GetCode()] = $value; + } else { + $aValues = array(); + $aValues[$this->GetCode()] = $value[$this->GetCode()]; + $aValues[$this->GetSQLRight()] = $value[$this->GetSQLRight()]; + $aValues[$this->GetSQLLeft()] = $value[$this->GetSQLLeft()]; + } - return $aValues; - } + return $aValues; + } - public function GetAllowedValues($aArgs = array(), $sContains = '') - { - $oFilter = $this->GetHierachicalFilter($aArgs, $sContains); - if ($oFilter) { - $oValSetDef = $this->GetValuesDef(); - $oValSetDef->SetCondition($oFilter); + public function GetAllowedValues($aArgs = array(), $sContains = '') + { + $oFilter = $this->GetHierachicalFilter($aArgs, $sContains); + if ($oFilter) { + $oValSetDef = $this->GetValuesDef(); + $oValSetDef->SetCondition($oFilter); - return $oValSetDef->GetValues($aArgs, $sContains); - } else { - return parent::GetAllowedValues($aArgs, $sContains); - } - } + return $oValSetDef->GetValues($aArgs, $sContains); + } else { + return parent::GetAllowedValues($aArgs, $sContains); + } + } - public function GetAllowedValuesAsObjectSet($aArgs = array(), $sContains = '', $iAdditionalValue = null) - { - $oValSetDef = $this->GetValuesDef(); - $oFilter = $this->GetHierachicalFilter($aArgs, $sContains, $iAdditionalValue); - if ($oFilter) { - $oValSetDef->SetCondition($oFilter); - } - $oSet = $oValSetDef->ToObjectSet($aArgs, $sContains, $iAdditionalValue); + public function GetAllowedValuesAsObjectSet($aArgs = array(), $sContains = '', $iAdditionalValue = null) + { + $oValSetDef = $this->GetValuesDef(); + $oFilter = $this->GetHierachicalFilter($aArgs, $sContains, $iAdditionalValue); + if ($oFilter) { + $oValSetDef->SetCondition($oFilter); + } + $oSet = $oValSetDef->ToObjectSet($aArgs, $sContains, $iAdditionalValue); - return $oSet; - } + return $oSet; + } - public function GetAllowedValuesAsFilter($aArgs = array(), $sContains = '', $iAdditionalValue = null) - { - $oFilter = $this->GetHierachicalFilter($aArgs, $sContains, $iAdditionalValue); - if ($oFilter) { - return $oFilter; - } + public function GetAllowedValuesAsFilter($aArgs = array(), $sContains = '', $iAdditionalValue = null) + { + $oFilter = $this->GetHierachicalFilter($aArgs, $sContains, $iAdditionalValue); + if ($oFilter) { + return $oFilter; + } - return parent::GetAllowedValuesAsFilter($aArgs, $sContains, $iAdditionalValue); - } + return parent::GetAllowedValuesAsFilter($aArgs, $sContains, $iAdditionalValue); + } - private function GetHierachicalFilter($aArgs = array(), $sContains = '', $iAdditionalValue = null) - { - if (array_key_exists('this', $aArgs)) { - // Hierarchical keys have one more constraint: the "parent value" cannot be - // "under" themselves - $iRootId = $aArgs['this']->GetKey(); - if ($iRootId > 0) // ignore objects that do no exist in the database... - { - $sClass = $this->m_sTargetClass; + private function GetHierachicalFilter($aArgs = array(), $sContains = '', $iAdditionalValue = null) + { + if (array_key_exists('this', $aArgs)) { + // Hierarchical keys have one more constraint: the "parent value" cannot be + // "under" themselves + $iRootId = $aArgs['this']->GetKey(); + if ($iRootId > 0) // ignore objects that do no exist in the database... + { + $sClass = $this->m_sTargetClass; - return DBObjectSearch::FromOQL("SELECT $sClass AS node JOIN $sClass AS root ON node." . $this->GetCode() . " NOT BELOW root.id WHERE root.id = $iRootId"); - } - } + return DBObjectSearch::FromOQL("SELECT $sClass AS node JOIN $sClass AS root ON node.".$this->GetCode()." NOT BELOW root.id WHERE root.id = $iRootId"); + } + } - return false; - } + return false; + } - /** - * Find the corresponding "link" attribute on the target class, if any - * - * @return null | AttributeDefinition - */ - public function GetMirrorLinkAttribute() - { - return null; - } + /** + * Find the corresponding "link" attribute on the target class, if any + * + * @return null | AttributeDefinition + */ + public function GetMirrorLinkAttribute() + { + return null; + } } \ No newline at end of file diff --git a/sources/Core/AttributeDefinition/AttributeIPAddress.php b/sources/Core/AttributeDefinition/AttributeIPAddress.php index e797f5108..49c288abc 100644 --- a/sources/Core/AttributeDefinition/AttributeIPAddress.php +++ b/sources/Core/AttributeDefinition/AttributeIPAddress.php @@ -1,4 +1,10 @@ GetCode() . '`)'); - } + public function GetOrderBySQLExpressions($sClassAlias) + { + // Note: This is the responsibility of this function to place backticks around column aliases + return array('INET_ATON(`'.$sClassAlias.$this->GetCode().'`)'); + } } \ No newline at end of file diff --git a/sources/Core/AttributeDefinition/AttributeImage.php b/sources/Core/AttributeDefinition/AttributeImage.php index dff7f0204..6fd7f423b 100644 --- a/sources/Core/AttributeDefinition/AttributeImage.php +++ b/sources/Core/AttributeDefinition/AttributeImage.php @@ -1,4 +1,15 @@ IsEmpty()) - && ($oDoc->GetMimeType() === 'image/svg+xml')) { - $sCleanSvg = HTMLSanitizer::Sanitize($oDoc->GetData(), 'svg_sanitizer'); - $oDoc = new ormDocument($sCleanSvg, $oDoc->GetMimeType(), $oDoc->GetFileName()); - } + if (($oDoc instanceof ormDocument) + && (false === $oDoc->IsEmpty()) + && ($oDoc->GetMimeType() === 'image/svg+xml')) { + $sCleanSvg = HTMLSanitizer::Sanitize($oDoc->GetData(), 'svg_sanitizer'); + $oDoc = new ormDocument($sCleanSvg, $oDoc->GetMimeType(), $oDoc->GetFileName()); + } - // The validation of the MIME Type is done by CheckFormat below - return $oDoc; - } + // The validation of the MIME Type is done by CheckFormat below + return $oDoc; + } - public function GetDefaultValue(DBObject $oHostObject = null) - { - return new ormDocument('', '', ''); - } + public function GetDefaultValue(DBObject $oHostObject = null) + { + return new ormDocument('', '', ''); + } - /** - * Check that the supplied ormDocument actually contains an image - * {@inheritDoc} - * - * @see AttributeDefinition::CheckFormat() - */ - public function CheckFormat($value) - { - if ($value instanceof ormDocument && !$value->IsEmpty()) { - return ($value->GetMainMimeType() == 'image'); - } + /** + * Check that the supplied ormDocument actually contains an image + * {@inheritDoc} + * + * @see AttributeDefinition::CheckFormat() + */ + public function CheckFormat($value) + { + if ($value instanceof ormDocument && !$value->IsEmpty()) { + return ($value->GetMainMimeType() == 'image'); + } - return true; - } + return true; + } - /** - * @param \ormDocument $value - * @param \DBObject $oHostObject - * @param bool $bLocalize - * - * @return string - * - * @see edit_image.js for JS generated markup in form edition - */ - public function GetAsHTML($value, $oHostObject = null, $bLocalize = true) - { - $sRet = ''; - $bIsCustomImage = false; + /** + * @see edit_image.js for JS generated markup in form edition + * + * @param DBObject $oHostObject + * @param bool $bLocalize + * + * @param ormDocument $value + * + * @return string + * + */ + public function GetAsHTML($value, $oHostObject = null, $bLocalize = true) + { + $sRet = ''; + $bIsCustomImage = false; - $iMaxWidth = $this->Get('display_max_width'); - $sMaxWidthPx = $iMaxWidth . 'px'; - $iMaxHeight = $this->Get('display_max_height'); - $sMaxHeightPx = $iMaxHeight . 'px'; + $iMaxWidth = $this->Get('display_max_width'); + $sMaxWidthPx = $iMaxWidth.'px'; + $iMaxHeight = $this->Get('display_max_height'); + $sMaxHeightPx = $iMaxHeight.'px'; - $sDefaultImageUrl = $this->Get('default_image'); - if ($sDefaultImageUrl !== null) { - $sRet = $this->GetHtmlForImageUrl($sDefaultImageUrl, $sMaxWidthPx, $sMaxHeightPx); - } + $sDefaultImageUrl = $this->Get('default_image'); + if ($sDefaultImageUrl !== null) { + $sRet = $this->GetHtmlForImageUrl($sDefaultImageUrl, $sMaxWidthPx, $sMaxHeightPx); + } - $sCustomImageUrl = $this->GetAttributeImageFileUrl($value, $oHostObject); - if ($sCustomImageUrl !== null) { - $bIsCustomImage = true; - $sRet = $this->GetHtmlForImageUrl($sCustomImageUrl, $sMaxWidthPx, $sMaxHeightPx); - } + $sCustomImageUrl = $this->GetAttributeImageFileUrl($value, $oHostObject); + if ($sCustomImageUrl !== null) { + $bIsCustomImage = true; + $sRet = $this->GetHtmlForImageUrl($sCustomImageUrl, $sMaxWidthPx, $sMaxHeightPx); + } - $sCssClasses = 'ibo-input-image--image-view attribute-image'; - $sCssClasses .= ' ' . (($bIsCustomImage) ? 'attribute-image-custom' : 'attribute-image-default'); + $sCssClasses = 'ibo-input-image--image-view attribute-image'; + $sCssClasses .= ' '.(($bIsCustomImage) ? 'attribute-image-custom' : 'attribute-image-default'); - // Important: If you change this, mind updating edit_image.js as well - return '' . $sRet . ''; - } + // Important: If you change this, mind updating edit_image.js as well + return ''.$sRet.''; + } - /** - * @param string $sUrl - * @param int $iMaxWidthPx - * @param int $iMaxHeightPx - * - * @return string - * - * @since 2.6.0 new private method - * @since 2.7.0 change visibility to protected - */ - protected function GetHtmlForImageUrl($sUrl, $iMaxWidthPx, $iMaxHeightPx) - { - return ''; - } + /** + * @param string $sUrl + * @param int $iMaxWidthPx + * @param int $iMaxHeightPx + * + * @return string + * + * @since 2.6.0 new private method + * @since 2.7.0 change visibility to protected + */ + protected function GetHtmlForImageUrl($sUrl, $iMaxWidthPx, $iMaxHeightPx) + { + return '
'; + } - /** - * @param \ormDocument $value - * @param \DBObject $oHostObject - * - * @return null|string - * - * @since 2.6.0 new private method - * @since 2.7.0 change visibility to protected - */ - protected function GetAttributeImageFileUrl($value, $oHostObject) - { - if (!is_object($value)) { - return null; - } - if ($value->IsEmpty()) { - return null; - } + /** + * @param ormDocument $value + * @param DBObject $oHostObject + * + * @return null|string + * + * @since 2.6.0 new private method + * @since 2.7.0 change visibility to protected + */ + protected function GetAttributeImageFileUrl($value, $oHostObject) + { + if (!is_object($value)) { + return null; + } + if ($value->IsEmpty()) { + return null; + } - $bExistingImageModified = ($oHostObject->IsModified() && (array_key_exists($this->GetCode(), $oHostObject->ListChanges()))); - if ($oHostObject->IsNew() || ($bExistingImageModified)) { - // If the object is modified (or not yet stored in the database) we must serve the content of the image directly inline - // otherwise (if we just give an URL) the browser will be given the wrong content... and may cache it - return 'data:' . $value->GetMimeType() . ';base64,' . base64_encode($value->GetData()); - } + $bExistingImageModified = ($oHostObject->IsModified() && (array_key_exists($this->GetCode(), $oHostObject->ListChanges()))); + if ($oHostObject->IsNew() || ($bExistingImageModified)) { + // If the object is modified (or not yet stored in the database) we must serve the content of the image directly inline + // otherwise (if we just give an URL) the browser will be given the wrong content... and may cache it + return 'data:'.$value->GetMimeType().';base64,'.base64_encode($value->GetData()); + } - return $value->GetDisplayURL(get_class($oHostObject), $oHostObject->GetKey(), $this->GetCode()); - } + return $value->GetDisplayURL(get_class($oHostObject), $oHostObject->GetKey(), $this->GetCode()); + } - public static function GetFormFieldClass() - { - return '\\Combodo\\iTop\\Form\\Field\\ImageField'; - } + public static function GetFormFieldClass() + { + return '\\Combodo\\iTop\\Form\\Field\\ImageField'; + } - public function MakeFormField(DBObject $oObject, $oFormField = null) - { - if ($oFormField === null) { - $sFormFieldClass = static::GetFormFieldClass(); - $oFormField = new $sFormFieldClass($this->GetCode()); - } + public function MakeFormField(DBObject $oObject, $oFormField = null) + { + if ($oFormField === null) { + $sFormFieldClass = static::GetFormFieldClass(); + $oFormField = new $sFormFieldClass($this->GetCode()); + } - parent::MakeFormField($oObject, $oFormField); + parent::MakeFormField($oObject, $oFormField); - // Generating urls - $value = $oObject->Get($this->GetCode()); - if (is_object($value) && !$value->IsEmpty()) { - $oFormField->SetDownloadUrl($value->GetDownloadURL(get_class($oObject), $oObject->GetKey(), $this->GetCode())); - $oFormField->SetDisplayUrl($value->GetDisplayURL(get_class($oObject), $oObject->GetKey(), $this->GetCode())); - } else { - $oDefaultImage = $this->Get('default_image'); - if (is_object($oDefaultImage) && !$oDefaultImage->IsEmpty()) { - $oFormField->SetDownloadUrl($oDefaultImage); - $oFormField->SetDisplayUrl($oDefaultImage); - } - } + // Generating urls + $value = $oObject->Get($this->GetCode()); + if (is_object($value) && !$value->IsEmpty()) { + $oFormField->SetDownloadUrl($value->GetDownloadURL(get_class($oObject), $oObject->GetKey(), $this->GetCode())); + $oFormField->SetDisplayUrl($value->GetDisplayURL(get_class($oObject), $oObject->GetKey(), $this->GetCode())); + } else { + $oDefaultImage = $this->Get('default_image'); + if (is_object($oDefaultImage) && !$oDefaultImage->IsEmpty()) { + $oFormField->SetDownloadUrl($oDefaultImage); + $oFormField->SetDisplayUrl($oDefaultImage); + } + } - return $oFormField; - } + return $oFormField; + } } \ No newline at end of file diff --git a/sources/Core/AttributeDefinition/AttributeInteger.php b/sources/Core/AttributeDefinition/AttributeInteger.php index 270879a82..e23c9552a 100644 --- a/sources/Core/AttributeDefinition/AttributeInteger.php +++ b/sources/Core/AttributeDefinition/AttributeInteger.php @@ -1,4 +1,14 @@ GetSQLColSpec() : ''); - } + protected function GetSQLCol($bFullSpec = false) + { + return "INT(11)".($bFullSpec ? $this->GetSQLColSpec() : ''); + } - public function GetValidationPattern() - { - return "^[0-9]+$"; - } + public function GetValidationPattern() + { + return "^[0-9]+$"; + } - public function GetBasicFilterOperators() - { - return array( - "!=" => "differs from", - "=" => "equals", - ">" => "greater (strict) than", - ">=" => "greater than", - "<" => "less (strict) than", - "<=" => "less than", - "in" => "in" - ); - } + public function GetBasicFilterOperators() + { + return array( + "!=" => "differs from", + "=" => "equals", + ">" => "greater (strict) than", + ">=" => "greater than", + "<" => "less (strict) than", + "<=" => "less than", + "in" => "in", + ); + } - public function GetBasicFilterLooseOperator() - { - // Unless we implement an "equals approximately..." or "same order of magnitude" - return "="; - } + public function GetBasicFilterLooseOperator() + { + // Unless we implement an "equals approximately..." or "same order of magnitude" + return "="; + } - public function GetBasicFilterSQLExpr($sOpCode, $value) - { - $sQValue = CMDBSource::Quote($value); - switch ($sOpCode) { - case '!=': - return $this->GetSQLExpr() . " != $sQValue"; - break; - case '>': - return $this->GetSQLExpr() . " > $sQValue"; - break; - case '>=': - return $this->GetSQLExpr() . " >= $sQValue"; - break; - case '<': - return $this->GetSQLExpr() . " < $sQValue"; - break; - case '<=': - return $this->GetSQLExpr() . " <= $sQValue"; - break; - case 'in': - if (!is_array($value)) { - throw new CoreException("Expected an array for argument value (sOpCode='$sOpCode')"); - } + public function GetBasicFilterSQLExpr($sOpCode, $value) + { + $sQValue = CMDBSource::Quote($value); + switch ($sOpCode) { + case '!=': + return $this->GetSQLExpr()." != $sQValue"; + break; + case '>': + return $this->GetSQLExpr()." > $sQValue"; + break; + case '>=': + return $this->GetSQLExpr()." >= $sQValue"; + break; + case '<': + return $this->GetSQLExpr()." < $sQValue"; + break; + case '<=': + return $this->GetSQLExpr()." <= $sQValue"; + break; + case 'in': + if (!is_array($value)) { + throw new CoreException("Expected an array for argument value (sOpCode='$sOpCode')"); + } - return $this->GetSQLExpr() . " IN ('" . implode("', '", $value) . "')"; - break; + return $this->GetSQLExpr()." IN ('".implode("', '", $value)."')"; + break; - case '=': - default: - return $this->GetSQLExpr() . " = \"$value\""; - } - } + case '=': + default: + return $this->GetSQLExpr()." = \"$value\""; + } + } - public function GetNullValue() - { - return null; - } + public function GetNullValue() + { + return null; + } - public function IsNull($proposedValue) - { - return is_null($proposedValue); - } + public function IsNull($proposedValue) + { + return is_null($proposedValue); + } - /** - * @inheritDoc - */ - public function HasAValue($proposedValue): bool - { - return utils::IsNotNullOrEmptyString($proposedValue); - } + /** + * @inheritDoc + */ + public function HasAValue($proposedValue): bool + { + return utils::IsNotNullOrEmptyString($proposedValue); + } - public function MakeRealValue($proposedValue, $oHostObj) - { - if (is_null($proposedValue)) { - return null; - } - if ($proposedValue === '') { - return null; - } // 0 is transformed into '' ! + public function MakeRealValue($proposedValue, $oHostObj) + { + if (is_null($proposedValue)) { + return null; + } + if ($proposedValue === '') { + return null; + } // 0 is transformed into '' ! - return (int)$proposedValue; - } + return (int)$proposedValue; + } - public function ScalarToSQL($value) - { - assert(is_numeric($value) || is_null($value)); + public function ScalarToSQL($value) + { + assert(is_numeric($value) || is_null($value)); - return $value; // supposed to be an int - } + return $value; // supposed to be an int + } } \ No newline at end of file diff --git a/sources/Core/AttributeDefinition/AttributeLinkedSet.php b/sources/Core/AttributeDefinition/AttributeLinkedSet.php index 6921e5116..0d47460dc 100644 --- a/sources/Core/AttributeDefinition/AttributeLinkedSet.php +++ b/sources/Core/AttributeDefinition/AttributeLinkedSet.php @@ -1,4 +1,28 @@ aCSSClasses[] = 'attribute-set'; - } - - public static function ListExpectedParams() - { - return array_merge(parent::ListExpectedParams(), - array("allowed_values", "depends_on", "linked_class", "ext_key_to_me", "count_min", "count_max")); - } - - public function GetEditClass() - { - return "LinkedSet"; - } - - /** @inheritDoc */ - public static function IsBulkModifyCompatible(): bool - { - return false; - } - - public function IsWritable() - { - return true; - } - - public static function IsLinkSet() - { - return true; - } - - public function IsIndirect() - { - return false; - } - - public function GetValuesDef() - { - $oValSetDef = $this->Get("allowed_values"); - if (!$oValSetDef) { - // Let's propose every existing value - $oValSetDef = new ValueSetObjects('SELECT ' . \Combodo\iTop\Service\Links\LinkSetModel::GetTargetClass($this)); - } - - return $oValSetDef; - } - - public function GetEditValue($value, $oHostObj = null) - { - /** @var ormLinkSet $value * */ - if ($value->Count() === 0) { - return ''; - } - - /** Return linked objects key as string **/ - $aValues = $value->GetValues(); - - return implode(' ', $aValues); - } - - public function GetPrerequisiteAttributes($sClass = null) - { - return $this->Get("depends_on"); - } - - /** - * @param \DBObject|null $oHostObject - * - * @return \ormLinkSet - * - * @throws \Exception - * @throws \CoreException - * @throws \CoreWarning - */ - public function GetDefaultValue(DBObject $oHostObject = null) - { - if ($oHostObject === null) { - return null; - } - - $sLinkClass = $this->GetLinkedClass(); - $sExtKeyToMe = $this->GetExtKeyToMe(); - - // The class to target is not the current class, because if this is a derived class, - // it may differ from the target class, then things start to become confusing - /** @var \AttributeExternalKey $oRemoteExtKeyAtt */ - $oRemoteExtKeyAtt = MetaModel::GetAttributeDef($sLinkClass, $sExtKeyToMe); - $sMyClass = $oRemoteExtKeyAtt->GetTargetClass(); - - $oMyselfSearch = new DBObjectSearch($sMyClass); - if ($oHostObject !== null) { - $oMyselfSearch->AddCondition('id', $oHostObject->GetKey(), '='); - } - - $oLinkSearch = new DBObjectSearch($sLinkClass); - $oLinkSearch->AddCondition_PointingTo($oMyselfSearch, $sExtKeyToMe); - if ($this->IsIndirect()) { - // Join the remote class so that the archive flag will be taken into account - /** @var \AttributeLinkedSetIndirect $this */ - $sExtKeyToRemote = $this->GetExtKeyToRemote(); - /** @var \AttributeExternalKey $oExtKeyToRemote */ - $oExtKeyToRemote = MetaModel::GetAttributeDef($sLinkClass, $sExtKeyToRemote); - $sRemoteClass = $oExtKeyToRemote->GetTargetClass(); - if (MetaModel::IsArchivable($sRemoteClass)) { - $oRemoteSearch = new DBObjectSearch($sRemoteClass); - /** @var \AttributeLinkedSetIndirect $this */ - $oLinkSearch->AddCondition_PointingTo($oRemoteSearch, $this->GetExtKeyToRemote()); - } - } - $oLinks = new DBObjectSet($oLinkSearch); - $oLinkSet = new ormLinkSet($this->GetHostClass(), $this->GetCode(), $oLinks); - - return $oLinkSet; - } - - public function GetTrackingLevel() - { - return $this->GetOptional('tracking_level', MetaModel::GetConfig()->Get('tracking_level_linked_set_default')); - } - - /** - * @return string see LINKSET_EDITMODE_* constants - */ - public function GetEditMode() - { - return $this->GetOptional('edit_mode', LINKSET_EDITMODE_ACTIONS); - } - - /** - * @return int see LINKSET_EDITWHEN_* constants - * @since 3.1.1 3.2.0 N°6385 - */ - public function GetEditWhen(): int - { - return $this->GetOptional('edit_when', LINKSET_EDITWHEN_ALWAYS); - } - - /** - * @return string see LINKSET_DISPLAY_STYLE_* constants - * @since 3.1.0 N°3190 - */ - public function GetDisplayStyle() - { - $sDisplayStyle = $this->GetOptional('display_style', LINKSET_DISPLAY_STYLE_TAB); - if ($sDisplayStyle === '') { - $sDisplayStyle = LINKSET_DISPLAY_STYLE_TAB; - } - - return $sDisplayStyle; - } - - /** - * Indicates if the current Attribute has constraints (php constraints or datamodel constraints) - * @return bool true if Attribute has constraints - * @since 3.1.0 N°6228 - */ - public function HasPHPConstraint(): bool - { - return $this->GetOptional('with_php_constraint', false); - } - - /** - * @return bool true if Attribute has computation (DB_LINKS_CHANGED event propagation, `with_php_computation` attribute xml property), false otherwise - * @since 3.1.1 3.2.0 N°6228 - */ - public function HasPHPComputation(): bool - { - return $this->GetOptional('with_php_computation', false); - } - - public function GetLinkedClass() - { - return $this->Get('linked_class'); - } - - public function GetExtKeyToMe() - { - return $this->Get('ext_key_to_me'); - } - - public function GetBasicFilterOperators() - { - return array(); - } - - public function GetBasicFilterLooseOperator() - { - return ''; - } - - public function GetBasicFilterSQLExpr($sOpCode, $value) - { - return ''; - } - - /** @inheritDoc * */ - public function GetAsHTML($sValue, $oHostObject = null, $bLocalize = true) - { - if ($this->GetDisplayStyle() === LINKSET_DISPLAY_STYLE_TAB) { - return $this->GetAsHTMLForTab($sValue, $oHostObject, $bLocalize); - } else { - return $this->GetAsHTMLForProperty($sValue, $oHostObject, $bLocalize); - } - } - - public function GetAsHTMLForTab($sValue, $oHostObject = null, $bLocalize = true) - { - if (is_object($sValue) && ($sValue instanceof ormLinkSet)) { - $sValue->Rewind(); - $aItems = array(); - while ($oObj = $sValue->Fetch()) { - // Show only relevant information (hide the external key to the current object) - $aAttributes = array(); - foreach (MetaModel::ListAttributeDefs($this->GetLinkedClass()) as $sAttCode => $oAttDef) { - if ($sAttCode == $this->GetExtKeyToMe()) { - continue; - } - if ($oAttDef->IsExternalField()) { - continue; - } - $sAttValue = $oObj->GetAsHTML($sAttCode); - if (strlen($sAttValue) > 0) { - $aAttributes[] = $sAttValue; - } - } - $sAttributes = implode(', ', $aAttributes); - $aItems[] = $sAttributes; - } - - return implode('
', $aItems); - } - - return null; - } - - public function GetAsHTMLForProperty($sValue, $oHostObject = null, $bLocalize = true): string - { - try { - - /** @var ormLinkSet $sValue */ - if (is_null($sValue) || $sValue->Count() === 0) { - return ''; - } - - $oLinkSetBlock = new \Combodo\iTop\Application\UI\Links\Set\BlockLinkSetDisplayAsProperty($this->GetCode(), $this, $sValue); - - return \Combodo\iTop\Renderer\Console\ConsoleBlockRenderer::RenderBlockTemplates($oLinkSetBlock); - } catch (Exception $e) { - $sMessage = "Error while displaying attribute {$this->GetCode()}"; - IssueLog::Error($sMessage, IssueLog::CHANNEL_DEFAULT, [ - 'host_object_class' => $this->GetHostClass(), - 'host_object_key' => $oHostObject->GetKey(), - 'attribute' => $this->GetCode(), - ]); - - return $sMessage; - } - } - - /** - * @param string $sValue - * @param \DBObject $oHostObject - * @param bool $bLocalize - * - * @return string - * - * @throws \CoreException - */ - public function GetAsXML($sValue, $oHostObject = null, $bLocalize = true) - { - if (is_object($sValue) && ($sValue instanceof ormLinkSet)) { - $sValue->Rewind(); - $sRes = "\n"; - while ($oObj = $sValue->Fetch()) { - $sObjClass = get_class($oObj); - $sRes .= "<$sObjClass id=\"" . $oObj->GetKey() . "\">\n"; - // Show only relevant information (hide the external key to the current object) - foreach (MetaModel::ListAttributeDefs($sObjClass) as $sAttCode => $oAttDef) { - if ($sAttCode == 'finalclass') { - if ($sObjClass == $this->GetLinkedClass()) { - // Simplify the output if the exact class could be determined implicitely - continue; - } - } - if ($sAttCode == $this->GetExtKeyToMe()) { - continue; - } - if ($oAttDef->IsExternalField()) { - /** @var \AttributeExternalField $oAttDef */ - if ($oAttDef->GetKeyAttCode() == $this->GetExtKeyToMe()) { - continue; - } - /** @var AttributeExternalField $oAttDef */ - if ($oAttDef->IsFriendlyName()) { - continue; - } - } - if ($oAttDef instanceof AttributeFriendlyName) { - continue; - } - if (!$oAttDef->IsScalar()) { - continue; - } - $sAttValue = $oObj->GetAsXML($sAttCode, $bLocalize); - $sRes .= "<$sAttCode>$sAttValue\n"; - } - $sRes .= "\n"; - } - $sRes .= " \n"; - } else { - $sRes = ''; - } - - return $sRes; - } - - /** - * @param $sValue - * @param string $sSeparator - * @param string $sTextQualifier - * @param \DBObject $oHostObject - * @param bool $bLocalize - * @param bool $bConvertToPlainText - * - * @return mixed|string - * @throws \CoreException - */ - public function GetAsCSV( - $sValue, $sSeparator = ',', $sTextQualifier = '"', $oHostObject = null, $bLocalize = true, - $bConvertToPlainText = false - ) - { - $sSepItem = MetaModel::GetConfig()->Get('link_set_item_separator'); - $sSepAttribute = MetaModel::GetConfig()->Get('link_set_attribute_separator'); - $sSepValue = MetaModel::GetConfig()->Get('link_set_value_separator'); - $sAttributeQualifier = MetaModel::GetConfig()->Get('link_set_attribute_qualifier'); - - if (is_object($sValue) && ($sValue instanceof ormLinkSet)) { - $sValue->Rewind(); - $aItems = array(); - while ($oObj = $sValue->Fetch()) { - $sObjClass = get_class($oObj); - // Show only relevant information (hide the external key to the current object) - $aAttributes = array(); - foreach (MetaModel::ListAttributeDefs($sObjClass) as $sAttCode => $oAttDef) { - if ($sAttCode == 'finalclass') { - if ($sObjClass == $this->GetLinkedClass()) { - // Simplify the output if the exact class could be determined implicitely - continue; - } - } - if ($sAttCode == $this->GetExtKeyToMe()) { - continue; - } - if ($oAttDef->IsExternalField()) { - continue; - } - if (!$oAttDef->IsBasedOnDBColumns()) { - continue; - } - if (!$oAttDef->IsScalar()) { - continue; - } - $sAttValue = $oObj->GetAsCSV($sAttCode, $sSepValue, '', $bLocalize); - if (strlen($sAttValue) > 0) { - $sAttributeData = str_replace($sAttributeQualifier, $sAttributeQualifier . $sAttributeQualifier, - $sAttCode . $sSepValue . $sAttValue); - $aAttributes[] = $sAttributeQualifier . $sAttributeData . $sAttributeQualifier; - } - } - $sAttributes = implode($sSepAttribute, $aAttributes); - $aItems[] = $sAttributes; - } - $sRes = implode($sSepItem, $aItems); - } else { - $sRes = ''; - } - $sRes = str_replace($sTextQualifier, $sTextQualifier . $sTextQualifier, $sRes); - $sRes = $sTextQualifier . $sRes . $sTextQualifier; - - return $sRes; - } - - /** - * List the available verbs for 'GetForTemplate' - */ - public function EnumTemplateVerbs() - { - return array( - '' => 'Plain text (unlocalized) representation', - 'html' => 'HTML representation (unordered list)', - ); - } - - /** - * Get various representations of the value, for insertion into a template (e.g. in Notifications) - * - * @param mixed $value The current value of the field - * @param string $sVerb The verb specifying the representation of the value - * @param DBObject $oHostObject The object - * @param bool $bLocalize Whether or not to localize the value - * - * @return string - * @throws \Exception - */ - public function GetForTemplate($value, $sVerb, $oHostObject = null, $bLocalize = true) - { - $sRemoteName = $this->IsIndirect() ? - /** @var \AttributeLinkedSetIndirect $this */ - $this->GetExtKeyToRemote() . '_friendlyname' : 'friendlyname'; - - $oLinkSet = clone $value; // Workaround/Safety net for Trac #887 - $iLimit = MetaModel::GetConfig()->Get('max_linkset_output'); - $iCount = 0; - $aNames = array(); - foreach ($oLinkSet as $oItem) { - if (($iLimit > 0) && ($iCount == $iLimit)) { - $iTotal = $oLinkSet->Count(); - $aNames[] = '... ' . Dict::Format('UI:TruncatedResults', $iCount, $iTotal); - break; - } - $aNames[] = $oItem->Get($sRemoteName); - $iCount++; - } - - switch ($sVerb) { - case '': - return implode("\n", $aNames); - - case 'html': - return '- ' . implode("
- ", $aNames) . '
', $aItems); + } + + return null; + } + + public function GetAsHTMLForProperty($sValue, $oHostObject = null, $bLocalize = true): string + { + try { + + /** @var ormLinkSet $sValue */ + if (is_null($sValue) || $sValue->Count() === 0) { + return ''; + } + + $oLinkSetBlock = new BlockLinkSetDisplayAsProperty($this->GetCode(), $this, $sValue); + + return ConsoleBlockRenderer::RenderBlockTemplates($oLinkSetBlock); + } + catch (Exception $e) { + $sMessage = "Error while displaying attribute {$this->GetCode()}"; + IssueLog::Error($sMessage, IssueLog::CHANNEL_DEFAULT, [ + 'host_object_class' => $this->GetHostClass(), + 'host_object_key' => $oHostObject->GetKey(), + 'attribute' => $this->GetCode(), + ]); + + return $sMessage; + } + } + + /** + * @param string $sValue + * @param DBObject $oHostObject + * @param bool $bLocalize + * + * @return string + * + * @throws CoreException + */ + public function GetAsXML($sValue, $oHostObject = null, $bLocalize = true) + { + if (is_object($sValue) && ($sValue instanceof ormLinkSet)) { + $sValue->Rewind(); + $sRes = "\n"; + while ($oObj = $sValue->Fetch()) { + $sObjClass = get_class($oObj); + $sRes .= "<$sObjClass id=\"".$oObj->GetKey()."\">\n"; + // Show only relevant information (hide the external key to the current object) + foreach (MetaModel::ListAttributeDefs($sObjClass) as $sAttCode => $oAttDef) { + if ($sAttCode == 'finalclass') { + if ($sObjClass == $this->GetLinkedClass()) { + // Simplify the output if the exact class could be determined implicitely + continue; + } + } + if ($sAttCode == $this->GetExtKeyToMe()) { + continue; + } + if ($oAttDef->IsExternalField()) { + /** @var \AttributeExternalField $oAttDef */ + if ($oAttDef->GetKeyAttCode() == $this->GetExtKeyToMe()) { + continue; + } + /** @var AttributeExternalField $oAttDef */ + if ($oAttDef->IsFriendlyName()) { + continue; + } + } + if ($oAttDef instanceof AttributeFriendlyName) { + continue; + } + if (!$oAttDef->IsScalar()) { + continue; + } + $sAttValue = $oObj->GetAsXML($sAttCode, $bLocalize); + $sRes .= "<$sAttCode>$sAttValue\n"; + } + $sRes .= "\n"; + } + $sRes .= " \n"; + } else { + $sRes = ''; + } + + return $sRes; + } + + /** + * @param $sValue + * @param string $sSeparator + * @param string $sTextQualifier + * @param DBObject $oHostObject + * @param bool $bLocalize + * @param bool $bConvertToPlainText + * + * @return mixed|string + * @throws CoreException + */ + public function GetAsCSV( + $sValue, $sSeparator = ',', $sTextQualifier = '"', $oHostObject = null, $bLocalize = true, + $bConvertToPlainText = false + ) + { + $sSepItem = MetaModel::GetConfig()->Get('link_set_item_separator'); + $sSepAttribute = MetaModel::GetConfig()->Get('link_set_attribute_separator'); + $sSepValue = MetaModel::GetConfig()->Get('link_set_value_separator'); + $sAttributeQualifier = MetaModel::GetConfig()->Get('link_set_attribute_qualifier'); + + if (is_object($sValue) && ($sValue instanceof ormLinkSet)) { + $sValue->Rewind(); + $aItems = array(); + while ($oObj = $sValue->Fetch()) { + $sObjClass = get_class($oObj); + // Show only relevant information (hide the external key to the current object) + $aAttributes = array(); + foreach (MetaModel::ListAttributeDefs($sObjClass) as $sAttCode => $oAttDef) { + if ($sAttCode == 'finalclass') { + if ($sObjClass == $this->GetLinkedClass()) { + // Simplify the output if the exact class could be determined implicitely + continue; + } + } + if ($sAttCode == $this->GetExtKeyToMe()) { + continue; + } + if ($oAttDef->IsExternalField()) { + continue; + } + if (!$oAttDef->IsBasedOnDBColumns()) { + continue; + } + if (!$oAttDef->IsScalar()) { + continue; + } + $sAttValue = $oObj->GetAsCSV($sAttCode, $sSepValue, '', $bLocalize); + if (strlen($sAttValue) > 0) { + $sAttributeData = str_replace($sAttributeQualifier, $sAttributeQualifier.$sAttributeQualifier, + $sAttCode.$sSepValue.$sAttValue); + $aAttributes[] = $sAttributeQualifier.$sAttributeData.$sAttributeQualifier; + } + } + $sAttributes = implode($sSepAttribute, $aAttributes); + $aItems[] = $sAttributes; + } + $sRes = implode($sSepItem, $aItems); + } else { + $sRes = ''; + } + $sRes = str_replace($sTextQualifier, $sTextQualifier.$sTextQualifier, $sRes); + $sRes = $sTextQualifier.$sRes.$sTextQualifier; + + return $sRes; + } + + /** + * List the available verbs for 'GetForTemplate' + */ + public function EnumTemplateVerbs() + { + return array( + '' => 'Plain text (unlocalized) representation', + 'html' => 'HTML representation (unordered list)', + ); + } + + /** + * Get various representations of the value, for insertion into a template (e.g. in Notifications) + * + * @param mixed $value The current value of the field + * @param string $sVerb The verb specifying the representation of the value + * @param DBObject $oHostObject The object + * @param bool $bLocalize Whether or not to localize the value + * + * @return string + * @throws Exception + */ + public function GetForTemplate($value, $sVerb, $oHostObject = null, $bLocalize = true) + { + $sRemoteName = $this->IsIndirect() ? + /** @var AttributeLinkedSetIndirect $this */ + $this->GetExtKeyToRemote().'_friendlyname' : 'friendlyname'; + + $oLinkSet = clone $value; // Workaround/Safety net for Trac #887 + $iLimit = MetaModel::GetConfig()->Get('max_linkset_output'); + $iCount = 0; + $aNames = array(); + foreach ($oLinkSet as $oItem) { + if (($iLimit > 0) && ($iCount == $iLimit)) { + $iTotal = $oLinkSet->Count(); + $aNames[] = '... '.Dict::Format('UI:TruncatedResults', $iCount, $iTotal); + break; + } + $aNames[] = $oItem->Get($sRemoteName); + $iCount++; + } + + switch ($sVerb) { + case '': + return implode("\n", $aNames); + + case 'html': + return '- '.implode("
- ", $aNames).'
$sValue %"; - } + return "$sValue %"; + } } \ No newline at end of file diff --git a/sources/Core/AttributeDefinition/AttributePhoneNumber.php b/sources/Core/AttributeDefinition/AttributePhoneNumber.php index 963e74217..f01289f8a 100644 --- a/sources/Core/AttributeDefinition/AttributePhoneNumber.php +++ b/sources/Core/AttributeDefinition/AttributePhoneNumber.php @@ -1,4 +1,13 @@ GetOptional('validation_pattern', - '^' . utils::GetConfig()->Get('phone_number_validation_pattern') . '$'); - } + public function GetValidationPattern() + { + return $this->GetOptional('validation_pattern', + '^'.utils::GetConfig()->Get('phone_number_validation_pattern').'$'); + } - public static function GetFormFieldClass() - { - return '\\Combodo\\iTop\\Form\\Field\\PhoneField'; - } + public static function GetFormFieldClass() + { + return '\\Combodo\\iTop\\Form\\Field\\PhoneField'; + } - public function GetAsHTML($sValue, $oHostObject = null, $bLocalize = true) - { - if (empty($sValue)) { - return ''; - } + public function GetAsHTML($sValue, $oHostObject = null, $bLocalize = true) + { + if (empty($sValue)) { + return ''; + } - $sUrlDecorationClass = utils::GetConfig()->Get('phone_number_decoration_class'); - $sUrlPattern = utils::GetConfig()->Get('phone_number_url_pattern'); - $sUrl = sprintf($sUrlPattern, $sValue); + $sUrlDecorationClass = utils::GetConfig()->Get('phone_number_decoration_class'); + $sUrlPattern = utils::GetConfig()->Get('phone_number_url_pattern'); + $sUrl = sprintf($sUrlPattern, $sValue); - return '' . parent::GetAsHTML($sValue) . ''; - } + return ''.parent::GetAsHTML($sValue).''; + } } \ No newline at end of file diff --git a/sources/Core/AttributeDefinition/AttributePropertySet.php b/sources/Core/AttributeDefinition/AttributePropertySet.php index cedad14e3..cc701f0ce 100644 --- a/sources/Core/AttributeDefinition/AttributePropertySet.php +++ b/sources/Core/AttributeDefinition/AttributePropertySet.php @@ -1,108 +1,118 @@ (string)$proposedValue); - } + // Facilitate things: allow the user to Set the value from a string + public function MakeRealValue($proposedValue, $oHostObj) + { + if (!is_array($proposedValue)) { + return array('?' => (string)$proposedValue); + } - return $proposedValue; - } + return $proposedValue; + } - public function GetAsHTML($value, $oHostObject = null, $bLocalize = true) - { - if (!is_array($value)) { - throw new CoreException('Expecting an array', array('found' => get_class($value))); - } - if (count($value) == 0) { - return ""; - } + public function GetAsHTML($value, $oHostObject = null, $bLocalize = true) + { + if (!is_array($value)) { + throw new CoreException('Expecting an array', array('found' => get_class($value))); + } + if (count($value) == 0) { + return ""; + } - $sRes = ""; - $sRes .= ""; - foreach ($value as $sProperty => $sValue) { - if ($sProperty == 'auth_pwd') { - $sValue = '*****'; - } - $sRes .= "
"; + $sRes = ""; - $sCell = str_replace("\n", " "; - } - $sRes .= ""; - $sRes .= "
\n", Str::pure2html(@(string)$sValue)); - $sRes .= "$sProperty $sCell "; - $sRes .= ""; + $sRes .= ""; + foreach ($value as $sProperty => $sValue) { + if ($sProperty == 'auth_pwd') { + $sValue = '*****'; + } + $sRes .= "
"; - return $sRes; - } + return $sRes; + } - public function GetAsCSV( - $value, $sSeparator = ',', $sTextQualifier = '"', $oHostObject = null, $bLocalize = true, - $bConvertToPlainText = false - ) - { - if (!is_array($value) || count($value) == 0) { - return ""; - } + public function GetAsCSV( + $value, $sSeparator = ',', $sTextQualifier = '"', $oHostObject = null, $bLocalize = true, + $bConvertToPlainText = false + ) + { + if (!is_array($value) || count($value) == 0) { + return ""; + } - $aRes = array(); - foreach ($value as $sProperty => $sValue) { - if ($sProperty == 'auth_pwd') { - $sValue = '*****'; - } - $sFrom = array(',', '='); - $sTo = array('\,', '\='); - $aRes[] = $sProperty . '=' . str_replace($sFrom, $sTo, (string)$sValue); - } - $sRaw = implode(',', $aRes); + $aRes = array(); + foreach ($value as $sProperty => $sValue) { + if ($sProperty == 'auth_pwd') { + $sValue = '*****'; + } + $sFrom = array(',', '='); + $sTo = array('\,', '\='); + $aRes[] = $sProperty.'='.str_replace($sFrom, $sTo, (string)$sValue); + } + $sRaw = implode(',', $aRes); - $sFrom = array("\r\n", $sTextQualifier); - $sTo = array("\n", $sTextQualifier . $sTextQualifier); - $sEscaped = str_replace($sFrom, $sTo, $sRaw); + $sFrom = array("\r\n", $sTextQualifier); + $sTo = array("\n", $sTextQualifier.$sTextQualifier); + $sEscaped = str_replace($sFrom, $sTo, $sRaw); - return $sTextQualifier . $sEscaped . $sTextQualifier; - } + return $sTextQualifier.$sEscaped.$sTextQualifier; + } - public function GetAsXML($value, $oHostObject = null, $bLocalize = true) - { - if (!is_array($value) || count($value) == 0) { - return ""; - } + public function GetAsXML($value, $oHostObject = null, $bLocalize = true) + { + if (!is_array($value) || count($value) == 0) { + return ""; + } - $sRes = ""; - foreach ($value as $sProperty => $sValue) { - if ($sProperty == 'auth_pwd') { - $sValue = '*****'; - } - $sRes .= ""; + $sCell = str_replace("\n", " "; + } + $sRes .= ""; + $sRes .= "
\n", Str::pure2html(@(string)$sValue)); + $sRes .= "$sProperty $sCell "; + $sRes .= ""; - $sRes .= Str::pure2xml((string)$sValue); - $sRes .= " "; - } + $sRes = ""; + foreach ($value as $sProperty => $sValue) { + if ($sProperty == 'auth_pwd') { + $sValue = '*****'; + } + $sRes .= ""; + $sRes .= Str::pure2xml((string)$sValue); + $sRes .= " "; + } - return $sRes; - } + return $sRes; + } } \ No newline at end of file diff --git a/sources/Core/AttributeDefinition/AttributeQueryAttCodeSet.php b/sources/Core/AttributeDefinition/AttributeQueryAttCodeSet.php index 8a63ad241..f198f4489 100644 --- a/sources/Core/AttributeDefinition/AttributeQueryAttCodeSet.php +++ b/sources/Core/AttributeDefinition/AttributeQueryAttCodeSet.php @@ -1,169 +1,191 @@ aCSSClasses[] = 'attribute-query-attcode-set'; - } + public function __construct($sCode, array $aParams) + { + parent::__construct($sCode, $aParams); + $this->aCSSClasses[] = 'attribute-query-attcode-set'; + } - public static function ListExpectedParams() - { - return array_merge(parent::ListExpectedParams(), array('query_field')); - } + public static function ListExpectedParams() + { + return array_merge(parent::ListExpectedParams(), array('query_field')); + } - protected function GetSQLCol($bFullSpec = false) - { - return "TEXT" . CMDBSource::GetSqlStringColumnDefinition(); - } + protected function GetSQLCol($bFullSpec = false) + { + return "TEXT".CMDBSource::GetSqlStringColumnDefinition(); + } - public function GetMaxSize() - { - return 65535; - } + public function GetMaxSize() + { + return 65535; + } - /** - * Get a class array indexed by alias - * @param $oHostObj - * - * @return array - */ - private function GetClassList($oHostObj) - { - try { - $sQueryField = $this->Get('query_field'); - $sQuery = $oHostObj->Get($sQueryField); - if (empty($sQuery)) { - return array(); - } - $oFilter = DBSearch::FromOQL($sQuery); - return $oFilter->GetSelectedClasses(); + /** + * Get a class array indexed by alias + * + * @param $oHostObj + * + * @return array + */ + private function GetClassList($oHostObj) + { + try { + $sQueryField = $this->Get('query_field'); + $sQuery = $oHostObj->Get($sQueryField); + if (empty($sQuery)) { + return array(); + } + $oFilter = DBSearch::FromOQL($sQuery); - } catch (OQLException $e) { - IssueLog::Warning($e->getMessage()); - } - return array(); - } + return $oFilter->GetSelectedClasses(); - public function GetAllowedValues($aArgs = array(), $sContains = '') - { - if (isset($aArgs['this'])) { - $oHostObj = $aArgs['this']; - $aClasses = $this->GetClassList($oHostObj); + } + catch (OQLException $e) { + IssueLog::Warning($e->getMessage()); + } - $aAllowedAttributes = array(); - $aAllAttributes = array(); + return array(); + } - if ((count($aClasses) == 1) && (array_keys($aClasses)[0] == array_values($aClasses)[0])) { - $sClass = reset($aClasses); - $aAttributes = MetaModel::GetAttributesList($sClass); - foreach ($aAttributes as $sAttCode) { - $aAllowedAttributes[$sAttCode] = "$sAttCode (" . MetaModel::GetLabel($sClass, $sAttCode) . ')'; - } - } else { - if (!empty($aClasses)) { - ksort($aClasses); - foreach ($aClasses as $sAlias => $sClass) { - $aAttributes = MetaModel::GetAttributesList($sClass); - foreach ($aAttributes as $sAttCode) { - $aAllAttributes[] = array('alias' => $sAlias, 'class' => $sClass, 'att_code' => $sAttCode); - } - } - } - foreach ($aAllAttributes as $aFullAttCode) { - $sAttCode = $aFullAttCode['alias'] . '.' . $aFullAttCode['att_code']; - $sClass = $aFullAttCode['class']; - $sLabel = "$sAttCode (" . MetaModel::GetLabel($sClass, $aFullAttCode['att_code']) . ')'; - $aAllowedAttributes[$sAttCode] = $sLabel; - } - } - return $aAllowedAttributes; - } + public function GetAllowedValues($aArgs = array(), $sContains = '') + { + if (isset($aArgs['this'])) { + $oHostObj = $aArgs['this']; + $aClasses = $this->GetClassList($oHostObj); - return null; - } + $aAllowedAttributes = array(); + $aAllAttributes = array(); - /** - * force an allowed value (type conversion and possibly forces a value as mySQL would do upon writing! - * - * @param $proposedValue - * @param \DBObject $oHostObj - * - * @param bool $bIgnoreErrors - * - * @return mixed - * @throws \CoreException - * @throws \CoreUnexpectedValue - * @throws \OQLException - * @throws \Exception - */ - public function MakeRealValue($proposedValue, $oHostObj, $bIgnoreErrors = false) - { - $oSet = new ormSet(MetaModel::GetAttributeOrigin($this->GetHostClass(), $this->GetCode()), $this->GetCode(), $this->GetMaxItems()); - $aArgs = array(); - if (!empty($oHostObj)) { - $aArgs['this'] = $oHostObj; - } - $aAllowedAttributes = $this->GetAllowedValues($aArgs); - $aInvalidAttCodes = array(); - if (is_string($proposedValue) && !empty($proposedValue)) { - $proposedValue = trim($proposedValue); - $aProposedValues = $this->FromStringToArray($proposedValue); - $aValues = array(); - foreach ($aProposedValues as $sValue) { - $sAttCode = trim($sValue); - if (empty($aAllowedAttributes) || isset($aAllowedAttributes[$sAttCode])) { - $aValues[$sAttCode] = $sAttCode; - } else { - $aInvalidAttCodes[] = $sAttCode; - } - } - $oSet->SetValues($aValues); - } elseif ($proposedValue instanceof ormSet) { - $oSet = $proposedValue; - } - if (!empty($aInvalidAttCodes) && !$bIgnoreErrors) { - throw new CoreUnexpectedValue("The attribute(s) " . implode(', ', $aInvalidAttCodes) . " are invalid"); - } + if ((count($aClasses) == 1) && (array_keys($aClasses)[0] == array_values($aClasses)[0])) { + $sClass = reset($aClasses); + $aAttributes = MetaModel::GetAttributesList($sClass); + foreach ($aAttributes as $sAttCode) { + $aAllowedAttributes[$sAttCode] = "$sAttCode (".MetaModel::GetLabel($sClass, $sAttCode).')'; + } + } else { + if (!empty($aClasses)) { + ksort($aClasses); + foreach ($aClasses as $sAlias => $sClass) { + $aAttributes = MetaModel::GetAttributesList($sClass); + foreach ($aAttributes as $sAttCode) { + $aAllAttributes[] = array('alias' => $sAlias, 'class' => $sClass, 'att_code' => $sAttCode); + } + } + } + foreach ($aAllAttributes as $aFullAttCode) { + $sAttCode = $aFullAttCode['alias'].'.'.$aFullAttCode['att_code']; + $sClass = $aFullAttCode['class']; + $sLabel = "$sAttCode (".MetaModel::GetLabel($sClass, $aFullAttCode['att_code']).')'; + $aAllowedAttributes[$sAttCode] = $sLabel; + } + } - return $oSet; - } + return $aAllowedAttributes; + } - /** - * @param $value - * @param \DBObject $oHostObject - * @param bool $bLocalize - * - * @return string|null - * - * @throws \Exception - */ - public function GetAsHTML($value, $oHostObject = null, $bLocalize = true) - { + return null; + } - if ($value instanceof ormSet) { - $value = $value->GetValues(); - } - if (is_array($value)) { - if (!empty($oHostObject) && $bLocalize) { - $aArgs['this'] = $oHostObject; - $aAllowedAttributes = $this->GetAllowedValues($aArgs); + /** + * force an allowed value (type conversion and possibly forces a value as mySQL would do upon writing! + * + * @param $proposedValue + * @param DBObject $oHostObj + * + * @param bool $bIgnoreErrors + * + * @return mixed + * @throws CoreException + * @throws CoreUnexpectedValue + * @throws OQLException + * @throws Exception + */ + public function MakeRealValue($proposedValue, $oHostObj, $bIgnoreErrors = false) + { + $oSet = new ormSet(MetaModel::GetAttributeOrigin($this->GetHostClass(), $this->GetCode()), $this->GetCode(), $this->GetMaxItems()); + $aArgs = array(); + if (!empty($oHostObj)) { + $aArgs['this'] = $oHostObj; + } + $aAllowedAttributes = $this->GetAllowedValues($aArgs); + $aInvalidAttCodes = array(); + if (is_string($proposedValue) && !empty($proposedValue)) { + $proposedValue = trim($proposedValue); + $aProposedValues = $this->FromStringToArray($proposedValue); + $aValues = array(); + foreach ($aProposedValues as $sValue) { + $sAttCode = trim($sValue); + if (empty($aAllowedAttributes) || isset($aAllowedAttributes[$sAttCode])) { + $aValues[$sAttCode] = $sAttCode; + } else { + $aInvalidAttCodes[] = $sAttCode; + } + } + $oSet->SetValues($aValues); + } elseif ($proposedValue instanceof ormSet) { + $oSet = $proposedValue; + } + if (!empty($aInvalidAttCodes) && !$bIgnoreErrors) { + throw new CoreUnexpectedValue("The attribute(s) ".implode(', ', $aInvalidAttCodes)." are invalid"); + } - $aLocalizedValues = array(); - foreach ($value as $sAttCode) { - if (isset($aAllowedAttributes[$sAttCode])) { - $sLabelForHtmlAttribute = utils::HtmlEntities($aAllowedAttributes[$sAttCode]); - $aLocalizedValues[] = '' . $sAttCode . ''; - } - } - $value = $aLocalizedValues; - } - $value = implode('', $value); - } + return $oSet; + } - return '' . $value . ''; - } + /** + * @param $value + * @param DBObject $oHostObject + * @param bool $bLocalize + * + * @return string|null + * + * @throws Exception + */ + public function GetAsHTML($value, $oHostObject = null, $bLocalize = true) + { + + if ($value instanceof ormSet) { + $value = $value->GetValues(); + } + if (is_array($value)) { + if (!empty($oHostObject) && $bLocalize) { + $aArgs['this'] = $oHostObject; + $aAllowedAttributes = $this->GetAllowedValues($aArgs); + + $aLocalizedValues = array(); + foreach ($value as $sAttCode) { + if (isset($aAllowedAttributes[$sAttCode])) { + $sLabelForHtmlAttribute = utils::HtmlEntities($aAllowedAttributes[$sAttCode]); + $aLocalizedValues[] = ''.$sAttCode.''; + } + } + $value = $aLocalizedValues; + } + $value = implode('', $value); + } + + return ''.$value.''; + } } \ No newline at end of file diff --git a/sources/Core/AttributeDefinition/AttributeRedundancySettings.php b/sources/Core/AttributeDefinition/AttributeRedundancySettings.php index 3cbe036db..bc233c9d2 100644 --- a/sources/Core/AttributeDefinition/AttributeRedundancySettings.php +++ b/sources/Core/AttributeDefinition/AttributeRedundancySettings.php @@ -1,4 +1,19 @@ GetSQLColSpec() : ''); - } + protected function GetSQLCol($bFullSpec = false) + { + return "VARCHAR(20)" + .CMDBSource::GetSqlStringColumnDefinition() + .($bFullSpec ? $this->GetSQLColSpec() : ''); + } - public function GetValidationPattern() - { - return "^[0-9]{1,3}|[0-9]{1,2}%|disabled$"; - } + public function GetValidationPattern() + { + return "^[0-9]{1,3}|[0-9]{1,2}%|disabled$"; + } - public function GetMaxSize() - { - return 20; - } + public function GetMaxSize() + { + return 20; + } - public function GetDefaultValue(DBObject $oHostObject = null) - { - $sRet = 'disabled'; - if ($this->Get('enabled')) { - if ($this->Get('min_up_type') == 'count') { - $sRet = (string)$this->Get('min_up'); - } else // percent - { - $sRet = $this->Get('min_up') . '%'; - } - } + public function GetDefaultValue(DBObject $oHostObject = null) + { + $sRet = 'disabled'; + if ($this->Get('enabled')) { + if ($this->Get('min_up_type') == 'count') { + $sRet = (string)$this->Get('min_up'); + } else // percent + { + $sRet = $this->Get('min_up').'%'; + } + } - return $sRet; - } + return $sRet; + } - public function IsNullAllowed() - { - return false; - } + public function IsNullAllowed() + { + return false; + } - public function GetNullValue() - { - return ''; - } + public function GetNullValue() + { + return ''; + } - public function IsNull($proposedValue) - { - return ($proposedValue == ''); - } + public function IsNull($proposedValue) + { + return ($proposedValue == ''); + } - public function MakeRealValue($proposedValue, $oHostObj) - { - if (is_null($proposedValue)) { - return ''; - } + public function MakeRealValue($proposedValue, $oHostObj) + { + if (is_null($proposedValue)) { + return ''; + } - return (string)$proposedValue; - } + return (string)$proposedValue; + } - public function ScalarToSQL($value) - { - if (!is_string($value)) { - throw new CoreException('Expected the attribute value to be a string', array( - 'found_type' => gettype($value), - 'value' => $value, - 'class' => $this->GetHostClass(), - 'attribute' => $this->GetCode() - )); - } + public function ScalarToSQL($value) + { + if (!is_string($value)) { + throw new CoreException('Expected the attribute value to be a string', array( + 'found_type' => gettype($value), + 'value' => $value, + 'class' => $this->GetHostClass(), + 'attribute' => $this->GetCode(), + )); + } - return $value; - } + return $value; + } - public function GetRelationQueryData() - { - foreach (MetaModel::EnumRelationQueries($this->GetHostClass(), $this->Get('relation_code'), - false) as $sDummy => $aQueryInfo) { - if ($aQueryInfo['sFromClass'] == $this->Get('from_class')) { - if ($aQueryInfo['sNeighbour'] == $this->Get('neighbour_id')) { - return $aQueryInfo; - } - } - } + public function GetRelationQueryData() + { + foreach (MetaModel::EnumRelationQueries($this->GetHostClass(), $this->Get('relation_code'), + false) as $sDummy => $aQueryInfo) { + if ($aQueryInfo['sFromClass'] == $this->Get('from_class')) { + if ($aQueryInfo['sNeighbour'] == $this->Get('neighbour_id')) { + return $aQueryInfo; + } + } + } - return array(); - } + return array(); + } - /** - * Find the user option label - * - * @param string $sUserOption possible values : disabled|cout|percent - * @param string $sDefault - * - * @return string - * @throws \Exception - */ - public function GetUserOptionFormat($sUserOption, $sDefault = null) - { - $sLabel = $this->SearchLabel('/Attribute:' . $this->m_sCode . '/' . $sUserOption, null, true /*user lang*/); - if (is_null($sLabel)) { - // If no default value is specified, let's define the most relevant one for developping purposes - if (is_null($sDefault)) { - $sDefault = str_replace('_', ' ', $this->m_sCode . ':' . $sUserOption . '(%1$s)'); - } - // Browse the hierarchy again, accepting default (english) translations - $sLabel = $this->SearchLabel('/Attribute:' . $this->m_sCode . '/' . $sUserOption, $sDefault, false); - } + /** + * Find the user option label + * + * @param string $sUserOption possible values : disabled|cout|percent + * @param string $sDefault + * + * @return string + * @throws Exception + */ + public function GetUserOptionFormat($sUserOption, $sDefault = null) + { + $sLabel = $this->SearchLabel('/Attribute:'.$this->m_sCode.'/'.$sUserOption, null, true /*user lang*/); + if (is_null($sLabel)) { + // If no default value is specified, let's define the most relevant one for developping purposes + if (is_null($sDefault)) { + $sDefault = str_replace('_', ' ', $this->m_sCode.':'.$sUserOption.'(%1$s)'); + } + // Browse the hierarchy again, accepting default (english) translations + $sLabel = $this->SearchLabel('/Attribute:'.$this->m_sCode.'/'.$sUserOption, $sDefault, false); + } - return $sLabel; - } + return $sLabel; + } - /** - * Override to display the value in the GUI - * - * @param string $sValue - * @param \DBObject $oHostObject - * @param bool $bLocalize - * - * @return string - * @throws \CoreException - * @throws \DictExceptionMissingString - */ - public function GetAsHTML($sValue, $oHostObject = null, $bLocalize = true) - { - $sCurrentOption = $this->GetCurrentOption($sValue); - $sClass = $oHostObject ? get_class($oHostObject) : $this->m_sHostClass; + /** + * Override to display the value in the GUI + * + * @param string $sValue + * @param DBObject $oHostObject + * @param bool $bLocalize + * + * @return string + * @throws CoreException + * @throws DictExceptionMissingString + */ + public function GetAsHTML($sValue, $oHostObject = null, $bLocalize = true) + { + $sCurrentOption = $this->GetCurrentOption($sValue); + $sClass = $oHostObject ? get_class($oHostObject) : $this->m_sHostClass; - return sprintf($this->GetUserOptionFormat($sCurrentOption), $this->GetMinUpValue($sValue), - MetaModel::GetName($sClass)); - } + return sprintf($this->GetUserOptionFormat($sCurrentOption), $this->GetMinUpValue($sValue), + MetaModel::GetName($sClass)); + } - public function GetAsCSV( - $sValue, $sSeparator = ',', $sTextQualifier = '"', $oHostObject = null, $bLocalize = true, - $bConvertToPlainText = false - ) - { - $sFrom = array("\r\n", $sTextQualifier); - $sTo = array("\n", $sTextQualifier . $sTextQualifier); - $sEscaped = str_replace($sFrom, $sTo, (string)$sValue); + public function GetAsCSV( + $sValue, $sSeparator = ',', $sTextQualifier = '"', $oHostObject = null, $bLocalize = true, + $bConvertToPlainText = false + ) + { + $sFrom = array("\r\n", $sTextQualifier); + $sTo = array("\n", $sTextQualifier.$sTextQualifier); + $sEscaped = str_replace($sFrom, $sTo, (string)$sValue); - return $sTextQualifier . $sEscaped . $sTextQualifier; - } + return $sTextQualifier.$sEscaped.$sTextQualifier; + } - /** - * Helper to interpret the value, given the current settings and string representation of the attribute - */ - public function IsEnabled($sValue) - { - if ($this->get('enabled_mode') == 'fixed') { - $bRet = $this->get('enabled'); - } else { - $bRet = ($sValue != 'disabled'); - } + /** + * Helper to interpret the value, given the current settings and string representation of the attribute + */ + public function IsEnabled($sValue) + { + if ($this->get('enabled_mode') == 'fixed') { + $bRet = $this->get('enabled'); + } else { + $bRet = ($sValue != 'disabled'); + } - return $bRet; - } + return $bRet; + } - /** - * Helper to interpret the value, given the current settings and string representation of the attribute - */ - public function GetMinUpType($sValue) - { - if ($this->get('min_up_mode') == 'fixed') { - $sRet = $this->get('min_up_type'); - } else { - $sRet = 'count'; - if (substr(trim($sValue), -1, 1) == '%') { - $sRet = 'percent'; - } - } + /** + * Helper to interpret the value, given the current settings and string representation of the attribute + */ + public function GetMinUpType($sValue) + { + if ($this->get('min_up_mode') == 'fixed') { + $sRet = $this->get('min_up_type'); + } else { + $sRet = 'count'; + if (substr(trim($sValue), -1, 1) == '%') { + $sRet = 'percent'; + } + } - return $sRet; - } + return $sRet; + } - /** - * Helper to interpret the value, given the current settings and string representation of the attribute - */ - public function GetMinUpValue($sValue) - { - if ($this->get('min_up_mode') == 'fixed') { - $iRet = (int)$this->Get('min_up'); - } else { - $sRefValue = $sValue; - if (substr(trim($sValue), -1, 1) == '%') { - $sRefValue = substr(trim($sValue), 0, -1); - } - $iRet = (int)trim($sRefValue); - } + /** + * Helper to interpret the value, given the current settings and string representation of the attribute + */ + public function GetMinUpValue($sValue) + { + if ($this->get('min_up_mode') == 'fixed') { + $iRet = (int)$this->Get('min_up'); + } else { + $sRefValue = $sValue; + if (substr(trim($sValue), -1, 1) == '%') { + $sRefValue = substr(trim($sValue), 0, -1); + } + $iRet = (int)trim($sRefValue); + } - return $iRet; - } + return $iRet; + } - /** - * Helper to determine if the redundancy can be viewed/edited by the end-user - */ - public function IsVisible() - { - $bRet = false; - if ($this->Get('enabled_mode') == 'fixed') { - $bRet = $this->Get('enabled'); - } elseif ($this->Get('enabled_mode') == 'user') { - $bRet = true; - } + /** + * Helper to determine if the redundancy can be viewed/edited by the end-user + */ + public function IsVisible() + { + $bRet = false; + if ($this->Get('enabled_mode') == 'fixed') { + $bRet = $this->Get('enabled'); + } elseif ($this->Get('enabled_mode') == 'user') { + $bRet = true; + } - return $bRet; - } + return $bRet; + } - public function IsWritable() - { - if (($this->Get('enabled_mode') == 'fixed') && ($this->Get('min_up_mode') == 'fixed')) { - return false; - } + public function IsWritable() + { + if (($this->Get('enabled_mode') == 'fixed') && ($this->Get('min_up_mode') == 'fixed')) { + return false; + } - return true; - } + return true; + } - /** - * Returns an HTML form that can be read by ReadValueFromPostedForm - */ - public function GetDisplayForm($sCurrentValue, $oPage, $bEditMode = false, $sFormPrefix = '') - { - $sRet = ''; - $aUserOptions = $this->GetUserOptions($sCurrentValue); - if (count($aUserOptions) < 2) { - $bEditOption = false; - } else { - $bEditOption = $bEditMode; - } - $sCurrentOption = $this->GetCurrentOption($sCurrentValue); - foreach ($aUserOptions as $sUserOption) { - $bSelected = ($sUserOption == $sCurrentOption); - $sRet .= ''; - $sRet .= $this->GetDisplayOption($sCurrentValue, $oPage, $sFormPrefix, $bEditOption, $sUserOption, - $bSelected); - $sRet .= ''; - } + /** + * Returns an HTML form that can be read by ReadValueFromPostedForm + */ + public function GetDisplayForm($sCurrentValue, $oPage, $bEditMode = false, $sFormPrefix = '') + { + $sRet = ''; + $aUserOptions = $this->GetUserOptions($sCurrentValue); + if (count($aUserOptions) < 2) { + $bEditOption = false; + } else { + $bEditOption = $bEditMode; + } + $sCurrentOption = $this->GetCurrentOption($sCurrentValue); + foreach ($aUserOptions as $sUserOption) { + $bSelected = ($sUserOption == $sCurrentOption); + $sRet .= ''; + $sRet .= $this->GetDisplayOption($sCurrentValue, $oPage, $sFormPrefix, $bEditOption, $sUserOption, + $bSelected); + $sRet .= ''; + } - return $sRet; - } + return $sRet; + } - const USER_OPTION_DISABLED = 'disabled'; - const USER_OPTION_ENABLED_COUNT = 'count'; - const USER_OPTION_ENABLED_PERCENT = 'percent'; + const USER_OPTION_DISABLED = 'disabled'; + const USER_OPTION_ENABLED_COUNT = 'count'; + const USER_OPTION_ENABLED_PERCENT = 'percent'; - /** - * Depending on the xxx_mode parameters, build the list of options that are allowed to the end-user - */ - protected function GetUserOptions($sValue) - { - $aRet = array(); - if ($this->Get('enabled_mode') == 'user') { - $aRet[] = self::USER_OPTION_DISABLED; - } + /** + * Depending on the xxx_mode parameters, build the list of options that are allowed to the end-user + */ + protected function GetUserOptions($sValue) + { + $aRet = array(); + if ($this->Get('enabled_mode') == 'user') { + $aRet[] = self::USER_OPTION_DISABLED; + } - if ($this->Get('min_up_mode') == 'user') { - $aRet[] = self::USER_OPTION_ENABLED_COUNT; - $aRet[] = self::USER_OPTION_ENABLED_PERCENT; - } else { - if ($this->GetMinUpType($sValue) == 'count') { - $aRet[] = self::USER_OPTION_ENABLED_COUNT; - } else { - $aRet[] = self::USER_OPTION_ENABLED_PERCENT; - } - } + if ($this->Get('min_up_mode') == 'user') { + $aRet[] = self::USER_OPTION_ENABLED_COUNT; + $aRet[] = self::USER_OPTION_ENABLED_PERCENT; + } else { + if ($this->GetMinUpType($sValue) == 'count') { + $aRet[] = self::USER_OPTION_ENABLED_COUNT; + } else { + $aRet[] = self::USER_OPTION_ENABLED_PERCENT; + } + } - return $aRet; - } + return $aRet; + } - /** - * Convert the string representation into one of the existing options - */ - protected function GetCurrentOption($sValue) - { - $sRet = self::USER_OPTION_DISABLED; - if ($this->IsEnabled($sValue)) { - if ($this->GetMinUpType($sValue) == 'count') { - $sRet = self::USER_OPTION_ENABLED_COUNT; - } else { - $sRet = self::USER_OPTION_ENABLED_PERCENT; - } - } + /** + * Convert the string representation into one of the existing options + */ + protected function GetCurrentOption($sValue) + { + $sRet = self::USER_OPTION_DISABLED; + if ($this->IsEnabled($sValue)) { + if ($this->GetMinUpType($sValue) == 'count') { + $sRet = self::USER_OPTION_ENABLED_COUNT; + } else { + $sRet = self::USER_OPTION_ENABLED_PERCENT; + } + } - return $sRet; - } + return $sRet; + } - /** - * Display an option (form, or current value) - * - * @param string $sCurrentValue - * @param \Combodo\iTop\Application\WebPage\WebPage $oPage - * @param string $sFormPrefix - * @param bool $bEditMode - * @param string $sUserOption - * @param bool $bSelected - * - * @return string - * @throws \CoreException - * @throws \DictExceptionMissingString - * @throws \Exception - */ - protected function GetDisplayOption( - $sCurrentValue, $oPage, $sFormPrefix, $bEditMode, $sUserOption, $bSelected = true - ) - { - $sRet = ''; + /** + * Display an option (form, or current value) + * + * @param string $sCurrentValue + * @param WebPage $oPage + * @param string $sFormPrefix + * @param bool $bEditMode + * @param string $sUserOption + * @param bool $bSelected + * + * @return string + * @throws CoreException + * @throws DictExceptionMissingString + * @throws Exception + */ + protected function GetDisplayOption( + $sCurrentValue, $oPage, $sFormPrefix, $bEditMode, $sUserOption, $bSelected = true + ) + { + $sRet = ''; - $iCurrentValue = $this->GetMinUpValue($sCurrentValue); - if ($bEditMode) { - $sValue = null; - $sHtmlNamesPrefix = 'rddcy_' . $this->Get('relation_code') . '_' . $this->Get('from_class') . '_' . $this->Get('neighbour_id'); - switch ($sUserOption) { - case self::USER_OPTION_DISABLED: - $sValue = ''; // Empty placeholder - break; + $iCurrentValue = $this->GetMinUpValue($sCurrentValue); + if ($bEditMode) { + $sValue = null; + $sHtmlNamesPrefix = 'rddcy_'.$this->Get('relation_code').'_'.$this->Get('from_class').'_'.$this->Get('neighbour_id'); + switch ($sUserOption) { + case self::USER_OPTION_DISABLED: + $sValue = ''; // Empty placeholder + break; - case self::USER_OPTION_ENABLED_COUNT: - if ($bEditMode) { - $sName = $sHtmlNamesPrefix . '_min_up_count'; - $sEditValue = $bSelected ? $iCurrentValue : ''; - $sValue = ''; - // To fix an issue on Firefox: focus set to the option (because the input is within the label for the option) - $oPage->add_ready_script("\$('[name=\"$sName\"]').on('click', function(){var me=this; setTimeout(function(){\$(me).trigger('focus');}, 100);});"); - } else { - $sValue = $iCurrentValue; - } - break; + case self::USER_OPTION_ENABLED_COUNT: + if ($bEditMode) { + $sName = $sHtmlNamesPrefix.'_min_up_count'; + $sEditValue = $bSelected ? $iCurrentValue : ''; + $sValue = ''; + // To fix an issue on Firefox: focus set to the option (because the input is within the label for the option) + $oPage->add_ready_script("\$('[name=\"$sName\"]').on('click', function(){var me=this; setTimeout(function(){\$(me).trigger('focus');}, 100);});"); + } else { + $sValue = $iCurrentValue; + } + break; - case self::USER_OPTION_ENABLED_PERCENT: - if ($bEditMode) { - $sName = $sHtmlNamesPrefix . '_min_up_percent'; - $sEditValue = $bSelected ? $iCurrentValue : ''; - $sValue = ''; - // To fix an issue on Firefox: focus set to the option (because the input is within the label for the option) - $oPage->add_ready_script("\$('[name=\"$sName\"]').on('click', function(){var me=this; setTimeout(function(){\$(me).trigger('focus');}, 100);});"); - } else { - $sValue = $iCurrentValue; - } - break; - } - $sLabel = sprintf($this->GetUserOptionFormat($sUserOption), $sValue, - MetaModel::GetName($this->GetHostClass())); + case self::USER_OPTION_ENABLED_PERCENT: + if ($bEditMode) { + $sName = $sHtmlNamesPrefix.'_min_up_percent'; + $sEditValue = $bSelected ? $iCurrentValue : ''; + $sValue = ''; + // To fix an issue on Firefox: focus set to the option (because the input is within the label for the option) + $oPage->add_ready_script("\$('[name=\"$sName\"]').on('click', function(){var me=this; setTimeout(function(){\$(me).trigger('focus');}, 100);});"); + } else { + $sValue = $iCurrentValue; + } + break; + } + $sLabel = sprintf($this->GetUserOptionFormat($sUserOption), $sValue, + MetaModel::GetName($this->GetHostClass())); - $sOptionName = $sHtmlNamesPrefix . '_user_option'; - $sOptionId = $sOptionName . '_' . $sUserOption; - $sChecked = $bSelected ? 'checked' : ''; - $sRet = ' '; - } else { - // Read-only: display only the currently selected option - if ($bSelected) { - $sRet = sprintf($this->GetUserOptionFormat($sUserOption), $iCurrentValue, - MetaModel::GetName($this->GetHostClass())); - } - } + $sOptionName = $sHtmlNamesPrefix.'_user_option'; + $sOptionId = $sOptionName.'_'.$sUserOption; + $sChecked = $bSelected ? 'checked' : ''; + $sRet = ' '; + } else { + // Read-only: display only the currently selected option + if ($bSelected) { + $sRet = sprintf($this->GetUserOptionFormat($sUserOption), $iCurrentValue, + MetaModel::GetName($this->GetHostClass())); + } + } - return $sRet; - } + return $sRet; + } - /** - * Makes the string representation out of the values given by the form defined in GetDisplayForm - */ - public function ReadValueFromPostedForm($sFormPrefix) - { - $sHtmlNamesPrefix = 'rddcy_' . $this->Get('relation_code') . '_' . $this->Get('from_class') . '_' . $this->Get('neighbour_id'); + /** + * Makes the string representation out of the values given by the form defined in GetDisplayForm + */ + public function ReadValueFromPostedForm($sFormPrefix) + { + $sHtmlNamesPrefix = 'rddcy_'.$this->Get('relation_code').'_'.$this->Get('from_class').'_'.$this->Get('neighbour_id'); - $iMinUpCount = (int)utils::ReadPostedParam($sHtmlNamesPrefix . '_min_up_count', null, 'raw_data'); - $iMinUpPercent = (int)utils::ReadPostedParam($sHtmlNamesPrefix . '_min_up_percent', null, 'raw_data'); - $sSelectedOption = utils::ReadPostedParam($sHtmlNamesPrefix . '_user_option', null, 'raw_data'); - switch ($sSelectedOption) { - case self::USER_OPTION_ENABLED_COUNT: - $sRet = $iMinUpCount; - break; + $iMinUpCount = (int)utils::ReadPostedParam($sHtmlNamesPrefix.'_min_up_count', null, 'raw_data'); + $iMinUpPercent = (int)utils::ReadPostedParam($sHtmlNamesPrefix.'_min_up_percent', null, 'raw_data'); + $sSelectedOption = utils::ReadPostedParam($sHtmlNamesPrefix.'_user_option', null, 'raw_data'); + switch ($sSelectedOption) { + case self::USER_OPTION_ENABLED_COUNT: + $sRet = $iMinUpCount; + break; - case self::USER_OPTION_ENABLED_PERCENT: - $sRet = $iMinUpPercent . '%'; - break; + case self::USER_OPTION_ENABLED_PERCENT: + $sRet = $iMinUpPercent.'%'; + break; - case self::USER_OPTION_DISABLED: - default: - $sRet = 'disabled'; - break; - } + case self::USER_OPTION_DISABLED: + default: + $sRet = 'disabled'; + break; + } - return $sRet; - } + return $sRet; + } } \ No newline at end of file diff --git a/sources/Core/AttributeDefinition/AttributeSet.php b/sources/Core/AttributeDefinition/AttributeSet.php index ca5e6c49e..e73f9c84c 100644 --- a/sources/Core/AttributeDefinition/AttributeSet.php +++ b/sources/Core/AttributeDefinition/AttributeSet.php @@ -1,4 +1,23 @@ aCSSClasses[] = 'attribute-set'; - $this->bDisplayLink = true; - } + public function __construct($sCode, array $aParams) + { + parent::__construct($sCode, $aParams); + $this->aCSSClasses[] = 'attribute-set'; + $this->bDisplayLink = true; + } - /** - * @param bool $bDisplayLink - */ - public function setDisplayLink($bDisplayLink) - { - $this->bDisplayLink = $bDisplayLink; - } + /** + * @param bool $bDisplayLink + */ + public function setDisplayLink($bDisplayLink) + { + $this->bDisplayLink = $bDisplayLink; + } - public static function ListExpectedParams() - { - return array_merge(parent::ListExpectedParams(), array('is_null_allowed', 'max_items')); - } + public static function ListExpectedParams() + { + return array_merge(parent::ListExpectedParams(), array('is_null_allowed', 'max_items')); + } - /** - * Allowed different values for the set values are mandatory for this attribute to be modified - * - * @param array $aArgs - * @param string $sContains - * - * @return array|null - * @throws \CoreException - * @throws \OQLException - */ - public function GetPossibleValues($aArgs = array(), $sContains = '') - { - return $this->GetAllowedValues($aArgs, $sContains); - } + /** + * Allowed different values for the set values are mandatory for this attribute to be modified + * + * @param array $aArgs + * @param string $sContains + * + * @return array|null + * @throws \CoreException + * @throws \OQLException + */ + public function GetPossibleValues($aArgs = array(), $sContains = '') + { + return $this->GetAllowedValues($aArgs, $sContains); + } - /** - * @param \ormSet $oValue - * - * @param $aArgs - * - * @return string JSON to be used in the itop.set_widget JQuery widget - * @throws \CoreException - * @throws \OQLException - */ - public function GetJsonForWidget($oValue, $aArgs = array()) - { - $aJson = array(); + /** + * @param \ormSet $oValue + * + * @param $aArgs + * + * @return string JSON to be used in the itop.set_widget JQuery widget + * @throws \CoreException + * @throws \OQLException + */ + public function GetJsonForWidget($oValue, $aArgs = array()) + { + $aJson = array(); - // possible_values - $aAllowedValues = $this->GetPossibleValues($aArgs); - $aSetKeyValData = array(); - foreach ($aAllowedValues as $sCode => $sLabel) { - $aSetKeyValData[] = [ - 'code' => $sCode, - 'label' => $sLabel, - ]; - } - $aJson['possible_values'] = $aSetKeyValData; - $aRemoved = array(); - if (is_null($oValue)) { - $aJson['partial_values'] = array(); - $aJson['orig_value'] = array(); - } else { - $aPartialValues = $oValue->GetModified(); - foreach ($aPartialValues as $key => $value) { - if (!isset($aAllowedValues[$value])) { - unset($aPartialValues[$key]); - } - } - $aJson['partial_values'] = array_values($aPartialValues); - $aOrigValues = array_merge($oValue->GetValues(), $oValue->GetModified()); - foreach ($aOrigValues as $key => $value) { - if (!isset($aAllowedValues[$value])) { - // Remove unwanted values - $aRemoved[] = $value; - unset($aOrigValues[$key]); - } - } - $aJson['orig_value'] = array_values($aOrigValues); - } - $aJson['added'] = array(); - $aJson['removed'] = $aRemoved; + // possible_values + $aAllowedValues = $this->GetPossibleValues($aArgs); + $aSetKeyValData = array(); + foreach ($aAllowedValues as $sCode => $sLabel) { + $aSetKeyValData[] = [ + 'code' => $sCode, + 'label' => $sLabel, + ]; + } + $aJson['possible_values'] = $aSetKeyValData; + $aRemoved = array(); + if (is_null($oValue)) { + $aJson['partial_values'] = array(); + $aJson['orig_value'] = array(); + } else { + $aPartialValues = $oValue->GetModified(); + foreach ($aPartialValues as $key => $value) { + if (!isset($aAllowedValues[$value])) { + unset($aPartialValues[$key]); + } + } + $aJson['partial_values'] = array_values($aPartialValues); + $aOrigValues = array_merge($oValue->GetValues(), $oValue->GetModified()); + foreach ($aOrigValues as $key => $value) { + if (!isset($aAllowedValues[$value])) { + // Remove unwanted values + $aRemoved[] = $value; + unset($aOrigValues[$key]); + } + } + $aJson['orig_value'] = array_values($aOrigValues); + } + $aJson['added'] = array(); + $aJson['removed'] = $aRemoved; - $iMaxTags = $this->GetMaxItems(); - $aJson['max_items_allowed'] = $iMaxTags; + $iMaxTags = $this->GetMaxItems(); + $aJson['max_items_allowed'] = $iMaxTags; - return json_encode($aJson); - } + return json_encode($aJson); + } - public function RequiresIndex() - { - return true; - } + public function RequiresIndex() + { + return true; + } - public function RequiresFullTextIndex() - { - return true; - } + public function RequiresFullTextIndex() + { + return true; + } - public function GetDefaultValue(DBObject $oHostObject = null) - { - return null; - } + public function GetDefaultValue(DBObject $oHostObject = null) + { + return null; + } - public function IsNullAllowed() - { - return $this->Get("is_null_allowed"); - } + public function IsNullAllowed() + { + return $this->Get("is_null_allowed"); + } - public function GetEditClass() - { - return "Set"; - } + public function GetEditClass() + { + return "Set"; + } - public function GetEditValue($value, $oHostObj = null) - { - if (is_string($value)) { - return $value; - } - if ($value instanceof ormSet) { - $value = $value->GetValues(); - } - if (is_array($value)) { - return implode(', ', $value); - } - return ''; - } + public function GetEditValue($value, $oHostObj = null) + { + if (is_string($value)) { + return $value; + } + if ($value instanceof ormSet) { + $value = $value->GetValues(); + } + if (is_array($value)) { + return implode(', ', $value); + } - protected function GetSQLCol($bFullSpec = false) - { - $iLen = $this->GetMaxSize(); - return "VARCHAR($iLen)" - . CMDBSource::GetSqlStringColumnDefinition() - . ($bFullSpec ? $this->GetSQLColSpec() : ''); - } + return ''; + } - public function GetMaxSize() - { - return 255; - } + protected function GetSQLCol($bFullSpec = false) + { + $iLen = $this->GetMaxSize(); - public function FromStringToArray($proposedValue, $sDefaultSepItem = ',') - { - $aValues = array(); - if (!empty($proposedValue)) { - $sSepItem = MetaModel::GetConfig()->Get('tag_set_item_separator'); - // convert also , separated strings - if ($sSepItem !== $sDefaultSepItem) { - $proposedValue = str_replace($sDefaultSepItem, $sSepItem, $proposedValue); - } - foreach (explode($sSepItem, $proposedValue) as $sCode) { - $sValue = trim($sCode); - if ($sValue !== '') { - $aValues[] = $sValue; - } - } - } - return $aValues; - } + return "VARCHAR($iLen)" + .CMDBSource::GetSqlStringColumnDefinition() + .($bFullSpec ? $this->GetSQLColSpec() : ''); + } - /** - * @param array $aCols - * @param string $sPrefix - * - * @return mixed - * @throws \Exception - */ - public function FromSQLToValue($aCols, $sPrefix = '') - { - $sValue = $aCols["$sPrefix"]; + public function GetMaxSize() + { + return 255; + } - return $this->MakeRealValue($sValue, null, true); - } + public function FromStringToArray($proposedValue, $sDefaultSepItem = ',') + { + $aValues = array(); + if (!empty($proposedValue)) { + $sSepItem = MetaModel::GetConfig()->Get('tag_set_item_separator'); + // convert also , separated strings + if ($sSepItem !== $sDefaultSepItem) { + $proposedValue = str_replace($sDefaultSepItem, $sSepItem, $proposedValue); + } + foreach (explode($sSepItem, $proposedValue) as $sCode) { + $sValue = trim($sCode); + if ($sValue !== '') { + $aValues[] = $sValue; + } + } + } - /** - * force an allowed value (type conversion and possibly forces a value as mySQL would do upon writing! - * - * @param $proposedValue - * @param \DBObject $oHostObj - * - * @param bool $bIgnoreErrors - * - * @return mixed - * @throws \CoreException - * @throws \CoreUnexpectedValue - */ - public function MakeRealValue($proposedValue, $oHostObj, $bIgnoreErrors = false) - { - $oSet = new ormSet(MetaModel::GetAttributeOrigin($this->GetHostClass(), $this->GetCode()), $this->GetCode(), $this->GetMaxItems()); - $aAllowedValues = $this->GetPossibleValues(); - if (is_string($proposedValue) && !empty($proposedValue)) { - $proposedValue = trim("$proposedValue"); - $aValues = $this->FromStringToArray($proposedValue); - foreach ($aValues as $i => $sValue) { - if (!isset($aAllowedValues[$sValue])) { - unset($aValues[$i]); - } - } - $oSet->SetValues($aValues); - } elseif ($proposedValue instanceof ormSet) { - $oSet = $proposedValue; - } + return $aValues; + } - return $oSet; - } + /** + * @param array $aCols + * @param string $sPrefix + * + * @return mixed + * @throws Exception + */ + public function FromSQLToValue($aCols, $sPrefix = '') + { + $sValue = $aCols["$sPrefix"]; - /** - * Get the value from a given string (plain text, CSV import) - * - * @param string $sProposedValue - * @param bool $bLocalizedValue - * @param string $sSepItem - * @param string $sSepAttribute - * @param string $sSepValue - * @param string $sAttributeQualifier - * - * @return mixed null if no match could be found - * @throws \Exception - */ - public function MakeValueFromString($sProposedValue, $bLocalizedValue = false, $sSepItem = null, $sSepAttribute = null, $sSepValue = null, $sAttributeQualifier = null) - { - return $this->MakeRealValue($sProposedValue, null); - } + return $this->MakeRealValue($sValue, null, true); + } - /** - * @return null|\ormSet - * @throws \CoreException - * @throws \Exception - */ - public function GetNullValue() - { - return new ormSet(MetaModel::GetAttributeOrigin($this->GetHostClass(), $this->GetCode()), $this->GetCode(), $this->GetMaxItems()); - } + /** + * force an allowed value (type conversion and possibly forces a value as mySQL would do upon writing! + * + * @param $proposedValue + * @param DBObject $oHostObj + * + * @param bool $bIgnoreErrors + * + * @return mixed + * @throws CoreException + * @throws CoreUnexpectedValue + */ + public function MakeRealValue($proposedValue, $oHostObj, $bIgnoreErrors = false) + { + $oSet = new ormSet(MetaModel::GetAttributeOrigin($this->GetHostClass(), $this->GetCode()), $this->GetCode(), $this->GetMaxItems()); + $aAllowedValues = $this->GetPossibleValues(); + if (is_string($proposedValue) && !empty($proposedValue)) { + $proposedValue = trim("$proposedValue"); + $aValues = $this->FromStringToArray($proposedValue); + foreach ($aValues as $i => $sValue) { + if (!isset($aAllowedValues[$sValue])) { + unset($aValues[$i]); + } + } + $oSet->SetValues($aValues); + } elseif ($proposedValue instanceof ormSet) { + $oSet = $proposedValue; + } - public function IsNull($proposedValue) - { - if (empty($proposedValue)) { - return true; - } + return $oSet; + } - /** @var \ormSet $proposedValue */ - return $proposedValue->Count() == 0; - } + /** + * Get the value from a given string (plain text, CSV import) + * + * @param string $sProposedValue + * @param bool $bLocalizedValue + * @param string $sSepItem + * @param string $sSepAttribute + * @param string $sSepValue + * @param string $sAttributeQualifier + * + * @return mixed null if no match could be found + * @throws Exception + */ + public function MakeValueFromString($sProposedValue, $bLocalizedValue = false, $sSepItem = null, $sSepAttribute = null, $sSepValue = null, $sAttributeQualifier = null) + { + return $this->MakeRealValue($sProposedValue, null); + } - /** - * @inheritDoc - */ - public function HasAValue($proposedValue): bool - { - if (false === ($proposedValue instanceof ormSet)) { - return parent::HasAValue($proposedValue); - } + /** + * @return null|ormSet + * @throws CoreException + * @throws Exception + */ + public function GetNullValue() + { + return new ormSet(MetaModel::GetAttributeOrigin($this->GetHostClass(), $this->GetCode()), $this->GetCode(), $this->GetMaxItems()); + } - return $proposedValue->Count() > 0; - } + public function IsNull($proposedValue) + { + if (empty($proposedValue)) { + return true; + } - /** - * To be overloaded for localized enums - * - * @param $sValue - * - * @return string label corresponding to the given value (in plain text) - * @throws \Exception - */ - public function GetValueLabel($sValue) - { - if ($sValue instanceof ormSet) { - $sValue = $sValue->GetValues(); - } - if (is_array($sValue)) { - return implode(', ', $sValue); - } - return $sValue; - } + /** @var ormSet $proposedValue */ + return $proposedValue->Count() == 0; + } - /** - * @param string $sValue - * @param null $oHostObj - * - * @return string - * @throws \Exception - */ - public function GetAsPlainText($sValue, $oHostObj = null) - { - return $this->GetValueLabel($sValue); - } + /** + * @inheritDoc + */ + public function HasAValue($proposedValue): bool + { + if (false === ($proposedValue instanceof ormSet)) { + return parent::HasAValue($proposedValue); + } - /** - * @param string $value - * - * @return string - */ - public function ScalarToSQL($value) - { - if (empty($value)) { - return ''; - } - if ($value instanceof ormSet) { - $value = $value->GetValues(); - } - if (is_array($value)) { - $sSepItem = MetaModel::GetConfig()->Get('tag_set_item_separator'); - $sRes = implode($sSepItem, $value); - if (!empty($sRes)) { - $value = "{$sSepItem}{$sRes}{$sSepItem}"; - } else { - $value = ''; - } - } - return $value; - } + return $proposedValue->Count() > 0; + } - /** - * @param $value - * @param \DBObject $oHostObject - * @param bool $bLocalize - * - * @return string|null - * - * @throws \Exception - */ - public function GetAsHTML($value, $oHostObject = null, $bLocalize = true) - { - if ($value instanceof ormSet) { - $aValues = $value->GetValues(); - return $this->GenerateViewHtmlForValues($aValues); - } - if (is_array($value)) { - return implode(', ', $value); - } - return $value; - } + /** + * To be overloaded for localized enums + * + * @param $sValue + * + * @return string label corresponding to the given value (in plain text) + * @throws Exception + */ + public function GetValueLabel($sValue) + { + if ($sValue instanceof ormSet) { + $sValue = $sValue->GetValues(); + } + if (is_array($sValue)) { + return implode(', ', $sValue); + } - /** - * HTML representation of a list of values (read-only) - * accept a list of strings - * - * @param array $aValues - * @param string $sCssClass - * @param bool $bWithLink if true will generate a link, otherwise just a "a" tag without href - * - * @return string - * @throws \CoreException - * @throws \OQLException - */ - public function GenerateViewHtmlForValues($aValues, $sCssClass = '', $bWithLink = true) - { - if (empty($aValues)) { - return ''; - } - $sHtml = ''; - foreach ($aValues as $sValue) { - $sClass = MetaModel::GetAttributeOrigin($this->GetHostClass(), $this->GetCode()); - $sAttCode = $this->GetCode(); - $sLabel = utils::EscapeHtml($this->GetValueLabel($sValue)); - $sDescription = utils::EscapeHtml($this->GetValueDescription($sValue)); - $oFilter = DBSearch::FromOQL("SELECT $sClass WHERE $sAttCode MATCHES '$sValue'"); - $oAppContext = new ApplicationContext(); - $sContext = $oAppContext->GetForLink(true); - $sUIPage = cmdbAbstractObject::ComputeStandardUIPage($oFilter->GetClass()); - $sFilter = rawurlencode($oFilter->serialize()); - $sLink = ''; - if ($bWithLink && $this->bDisplayLink) { - $sUrl = utils::GetAbsoluteUrlAppRoot() . "pages/$sUIPage?operation=search&filter=" . $sFilter . $sContext; - $sLink = ' href="' . $sUrl . '"'; - } + return $sValue; + } - // Prepare tooltip - if (empty($sDescription)) { - $sTooltipContent = $sLabel; - $sTooltipHtmlEnabled = 'false'; - } else { - $sTooltipContent = <<GetValueLabel($sValue); + } + + /** + * @param string $value + * + * @return string + */ + public function ScalarToSQL($value) + { + if (empty($value)) { + return ''; + } + if ($value instanceof ormSet) { + $value = $value->GetValues(); + } + if (is_array($value)) { + $sSepItem = MetaModel::GetConfig()->Get('tag_set_item_separator'); + $sRes = implode($sSepItem, $value); + if (!empty($sRes)) { + $value = "{$sSepItem}{$sRes}{$sSepItem}"; + } else { + $value = ''; + } + } + + return $value; + } + + /** + * @param $value + * @param DBObject $oHostObject + * @param bool $bLocalize + * + * @return string|null + * + * @throws \Exception + */ + public function GetAsHTML($value, $oHostObject = null, $bLocalize = true) + { + if ($value instanceof ormSet) { + $aValues = $value->GetValues(); + + return $this->GenerateViewHtmlForValues($aValues); + } + if (is_array($value)) { + return implode(', ', $value); + } + + return $value; + } + + /** + * HTML representation of a list of values (read-only) + * accept a list of strings + * + * @param array $aValues + * @param string $sCssClass + * @param bool $bWithLink if true will generate a link, otherwise just a "a" tag without href + * + * @return string + * @throws CoreException + * @throws OQLException + */ + public function GenerateViewHtmlForValues($aValues, $sCssClass = '', $bWithLink = true) + { + if (empty($aValues)) { + return ''; + } + $sHtml = ''; + foreach ($aValues as $sValue) { + $sClass = MetaModel::GetAttributeOrigin($this->GetHostClass(), $this->GetCode()); + $sAttCode = $this->GetCode(); + $sLabel = utils::EscapeHtml($this->GetValueLabel($sValue)); + $sDescription = utils::EscapeHtml($this->GetValueDescription($sValue)); + $oFilter = DBSearch::FromOQL("SELECT $sClass WHERE $sAttCode MATCHES '$sValue'"); + $oAppContext = new ApplicationContext(); + $sContext = $oAppContext->GetForLink(true); + $sUIPage = cmdbAbstractObject::ComputeStandardUIPage($oFilter->GetClass()); + $sFilter = rawurlencode($oFilter->serialize()); + $sLink = ''; + if ($bWithLink && $this->bDisplayLink) { + $sUrl = utils::GetAbsoluteUrlAppRoot()."pages/$sUIPage?operation=search&filter=".$sFilter.$sContext; + $sLink = ' href="'.$sUrl.'"'; + } + + // Prepare tooltip + if (empty($sDescription)) { + $sTooltipContent = $sLabel; + $sTooltipHtmlEnabled = 'false'; + } else { + $sTooltipContent = <<$sLabel$sDescriptionHTML; - $sTooltipHtmlEnabled = 'true'; - } - $sTooltipContent = utils::EscapeHtml($sTooltipContent); + $sTooltipHtmlEnabled = 'true'; + } + $sTooltipContent = utils::EscapeHtml($sTooltipContent); - $sHtml .= '"; - $sRes .= ""; - foreach ($value as $iRow => $aRawData) { - $sRes .= "
"; + $sRes = ""; - foreach ($aRawData as $iCol => $cell) { - // Note: avoid the warning in case the cell is made of an array - $sCell = @Str::pure2html((string)$cell); - $sCell = str_replace("\n", " "; - } - $sRes .= ""; - $sRes .= "
\n", $sCell); - $sRes .= "$sCell "; - } - $sRes .= ""; + $sRes .= ""; + foreach ($value as $iRow => $aRawData) { + $sRes .= "
"; - return $sRes; - } + return $sRes; + } - public function GetAsCSV( - $sValue, $sSeparator = ',', $sTextQualifier = '"', $oHostObject = null, $bLocalize = true, - $bConvertToPlainText = false - ) - { - // Not implemented - return ''; - } + public function GetAsCSV( + $sValue, $sSeparator = ',', $sTextQualifier = '"', $oHostObject = null, $bLocalize = true, + $bConvertToPlainText = false + ) + { + // Not implemented + return ''; + } - public function GetAsXML($value, $oHostObject = null, $bLocalize = true) - { - if (!is_array($value) || count($value) == 0) { - return ""; - } + public function GetAsXML($value, $oHostObject = null, $bLocalize = true) + { + if (!is_array($value) || count($value) == 0) { + return ""; + } - $sRes = ""; - foreach ($value as $iRow => $aRawData) { - $sRes .= ""; + foreach ($aRawData as $iCol => $cell) { + // Note: avoid the warning in case the cell is made of an array + $sCell = @Str::pure2html((string)$cell); + $sCell = str_replace("\n", " "; + } + $sRes .= ""; + $sRes .= "
\n", $sCell); + $sRes .= "$sCell "; + } + $sRes .= ""; - foreach ($aRawData as $iCol => $cell) { - $sCell = Str::pure2xml((string)$cell); - $sRes .= "
"; - } + $sRes = ""; + foreach ($value as $iRow => $aRawData) { + $sRes .= "$sCell | "; - } - $sRes .= ""; + foreach ($aRawData as $iCol => $cell) { + $sCell = Str::pure2xml((string)$cell); + $sRes .= "
"; + } - return $sRes; - } + return $sRes; + } } \ No newline at end of file diff --git a/sources/Core/AttributeDefinition/AttributeTagSet.php b/sources/Core/AttributeDefinition/AttributeTagSet.php index c58a5ad23..d05b99fe2 100644 --- a/sources/Core/AttributeDefinition/AttributeTagSet.php +++ b/sources/Core/AttributeDefinition/AttributeTagSet.php @@ -1,4 +1,23 @@ aCSSClasses[] = 'attribute-tag-set'; - } + public function __construct($sCode, array $aParams) + { + parent::__construct($sCode, $aParams); + $this->aCSSClasses[] = 'attribute-tag-set'; + } - public function GetEditClass() - { - return 'TagSet'; - } + public function GetEditClass() + { + return 'TagSet'; + } - public static function ListExpectedParams() - { - return array_merge(parent::ListExpectedParams(), array('tag_code_max_len')); - } + public static function ListExpectedParams() + { + return array_merge(parent::ListExpectedParams(), array('tag_code_max_len')); + } - /** - * @param \ormTagSet $oValue - * - * @param $aArgs - * - * @return string JSON to be used in the itop.tagset_widget JQuery widget - * @throws \CoreException - * @throws \OQLException - */ - public function GetJsonForWidget($oValue, $aArgs = array()) - { - $aJson = array(); + /** + * @param ormTagSet $oValue + * + * @param $aArgs + * + * @return string JSON to be used in the itop.tagset_widget JQuery widget + */ + public function GetJsonForWidget($oValue, $aArgs = array()) + { + $aJson = array(); - // possible_values - $aTagSetObjectData = $this->GetAllowedValues($aArgs); - $aTagSetKeyValData = array(); - foreach ($aTagSetObjectData as $sTagCode => $sTagLabel) { - $aTagSetKeyValData[] = [ - 'code' => $sTagCode, - 'label' => $sTagLabel, - ]; - } - $aJson['possible_values'] = $aTagSetKeyValData; + // possible_values + $aTagSetObjectData = $this->GetAllowedValues($aArgs); + $aTagSetKeyValData = array(); + foreach ($aTagSetObjectData as $sTagCode => $sTagLabel) { + $aTagSetKeyValData[] = [ + 'code' => $sTagCode, + 'label' => $sTagLabel, + ]; + } + $aJson['possible_values'] = $aTagSetKeyValData; - if (is_null($oValue)) { - $aJson['partial_values'] = array(); - $aJson['orig_value'] = array(); - $aJson['added'] = array(); - $aJson['removed'] = array(); - } else { - $aJson['orig_value'] = array_merge($oValue->GetValues(), $oValue->GetModified()); - $aJson['added'] = $oValue->GetAdded(); - $aJson['removed'] = $oValue->GetRemoved(); + if (is_null($oValue)) { + $aJson['partial_values'] = array(); + $aJson['orig_value'] = array(); + $aJson['added'] = array(); + $aJson['removed'] = array(); + } else { + $aJson['orig_value'] = array_merge($oValue->GetValues(), $oValue->GetModified()); + $aJson['added'] = $oValue->GetAdded(); + $aJson['removed'] = $oValue->GetRemoved(); - if ($oValue->DisplayPartial()) { - // For bulk updates - $aJson['partial_values'] = $oValue->GetModified(); - } else { - // For simple updates - $aJson['partial_values'] = array(); - } - } + if ($oValue->DisplayPartial()) { + // For bulk updates + $aJson['partial_values'] = $oValue->GetModified(); + } else { + // For simple updates + $aJson['partial_values'] = array(); + } + } - $iMaxTags = $this->GetMaxItems(); - $aJson['max_items_allowed'] = $iMaxTags; + $iMaxTags = $this->GetMaxItems(); + $aJson['max_items_allowed'] = $iMaxTags; - return json_encode($aJson); - } + return json_encode($aJson); + } - public function FromStringToArray($proposedValue, $sDefaultSepItem = ',') - { - $aValues = array(); - if (!empty($proposedValue)) { - foreach (explode(' ', $proposedValue) as $sCode) { - $sValue = trim($sCode); - $aValues[] = $sValue; - } - } - return $aValues; - } + public function FromStringToArray($proposedValue, $sDefaultSepItem = ',') + { + $aValues = array(); + if (!empty($proposedValue)) { + foreach (explode(' ', $proposedValue) as $sCode) { + $sValue = trim($sCode); + $aValues[] = $sValue; + } + } - /** - * Extract all existing tags from a string and ignore bad tags - * - * @param $sValue - * @param bool $bNoLimit : don't apply the maximum tag limit - * - * @return \ormTagSet - * @throws \CoreException - * @throws \CoreUnexpectedValue - */ - public function GetExistingTagsFromString($sValue, $bNoLimit = false) - { - $aTagCodes = $this->FromStringToArray("$sValue"); - $sAttCode = $this->GetCode(); - $sClass = MetaModel::GetAttributeOrigin($this->GetHostClass(), $sAttCode); - if ($bNoLimit) { - $oTagSet = new ormTagSet($sClass, $sAttCode, 0); - } else { - $oTagSet = new ormTagSet($sClass, $sAttCode, $this->GetMaxItems()); - } - $aGoodTags = array(); - foreach ($aTagCodes as $sTagCode) { - if ($sTagCode === '') { - continue; - } - if ($oTagSet->IsValidTag($sTagCode)) { - $aGoodTags[] = $sTagCode; - if (!$bNoLimit && (count($aGoodTags) === $this->GetMaxItems())) { - // extra and bad tags are ignored - break; - } - } - } - $oTagSet->SetValues($aGoodTags); + return $aValues; + } - return $oTagSet; - } + /** + * Extract all existing tags from a string and ignore bad tags + * + * @param $sValue + * @param bool $bNoLimit : don't apply the maximum tag limit + * + * @return ormTagSet + * @throws CoreException + * @throws CoreUnexpectedValue + */ + public function GetExistingTagsFromString($sValue, $bNoLimit = false) + { + $aTagCodes = $this->FromStringToArray("$sValue"); + $sAttCode = $this->GetCode(); + $sClass = MetaModel::GetAttributeOrigin($this->GetHostClass(), $sAttCode); + if ($bNoLimit) { + $oTagSet = new ormTagSet($sClass, $sAttCode, 0); + } else { + $oTagSet = new ormTagSet($sClass, $sAttCode, $this->GetMaxItems()); + } + $aGoodTags = array(); + foreach ($aTagCodes as $sTagCode) { + if ($sTagCode === '') { + continue; + } + if ($oTagSet->IsValidTag($sTagCode)) { + $aGoodTags[] = $sTagCode; + if (!$bNoLimit && (count($aGoodTags) === $this->GetMaxItems())) { + // extra and bad tags are ignored + break; + } + } + } + $oTagSet->SetValues($aGoodTags); - public function GetTagCodeMaxLength() - { - return $this->Get('tag_code_max_len'); - } + return $oTagSet; + } - public function GetEditValue($value, $oHostObj = null) - { - if (empty($value)) { - return ''; - } - if ($value instanceof ormTagSet) { - $aValues = $value->GetValues(); + public function GetTagCodeMaxLength() + { + return $this->Get('tag_code_max_len'); + } - return implode(' ', $aValues); - } + public function GetEditValue($value, $oHostObj = null) + { + if (empty($value)) { + return ''; + } + if ($value instanceof ormTagSet) { + $aValues = $value->GetValues(); - return ''; - } + return implode(' ', $aValues); + } - public function GetMaxSize() - { - return max(255, ($this->GetMaxItems() * $this->GetTagCodeMaxLength()) + 1); - } + return ''; + } - public function Equals($val1, $val2) - { - if (($val1 instanceof ormTagSet) && ($val2 instanceof ormTagSet)) { - return $val1->Equals($val2); - } + public function GetMaxSize() + { + return max(255, ($this->GetMaxItems() * $this->GetTagCodeMaxLength()) + 1); + } - return ($val1 == $val2); - } + public function Equals($val1, $val2) + { + if (($val1 instanceof ormTagSet) && ($val2 instanceof ormTagSet)) { + return $val1->Equals($val2); + } - public function GetAllowedValues($aArgs = array(), $sContains = '') - { - $sAttCode = $this->GetCode(); - $sClass = MetaModel::GetAttributeOrigin($this->GetHostClass(), $sAttCode); - $aAllowedTags = TagSetFieldData::GetAllowedValues($sClass, $sAttCode); - $aAllowedValues = array(); - foreach ($aAllowedTags as $oAllowedTag) { - $aAllowedValues[$oAllowedTag->Get('code')] = $oAllowedTag->Get('label'); - } + return ($val1 == $val2); + } - return $aAllowedValues; - } + public function GetAllowedValues($aArgs = array(), $sContains = '') + { + $sAttCode = $this->GetCode(); + $sClass = MetaModel::GetAttributeOrigin($this->GetHostClass(), $sAttCode); + $aAllowedTags = TagSetFieldData::GetAllowedValues($sClass, $sAttCode); + $aAllowedValues = array(); + foreach ($aAllowedTags as $oAllowedTag) { + $aAllowedValues[$oAllowedTag->Get('code')] = $oAllowedTag->Get('label'); + } - /** - * @param array $aCols - * @param string $sPrefix - * - * @return mixed - * @throws \CoreException - * @throws \Exception - */ - public function FromSQLToValue($aCols, $sPrefix = '') - { - $sValue = $aCols["$sPrefix"]; + return $aAllowedValues; + } - return $this->GetExistingTagsFromString($sValue); - } + /** + * @param array $aCols + * @param string $sPrefix + * + * @return mixed + * @throws CoreException + * @throws Exception + */ + public function FromSQLToValue($aCols, $sPrefix = '') + { + $sValue = $aCols["$sPrefix"]; - /** - * force an allowed value (type conversion and possibly forces a value as mySQL would do upon writing! - * - * @param $proposedValue - * @param $oHostObj - * - * @param bool $bIgnoreErrors - * - * @return mixed - * @throws \CoreException - * @throws \CoreUnexpectedValue - */ - public function MakeRealValue($proposedValue, $oHostObj, $bIgnoreErrors = false) - { - $oTagSet = new ormTagSet(MetaModel::GetAttributeOrigin($this->GetHostClass(), $this->GetCode()), $this->GetCode(), $this->GetMaxItems()); - if (is_string($proposedValue) && !empty($proposedValue)) { - $sJsonFromWidget = json_decode($proposedValue, true); - if (is_null($sJsonFromWidget)) { - $proposedValue = trim("$proposedValue"); - $aTagCodes = $this->FromStringToArray($proposedValue); - $oTagSet->SetValues($aTagCodes); - } - } elseif ($proposedValue instanceof ormTagSet) { - $oTagSet = $proposedValue; - } + return $this->GetExistingTagsFromString($sValue); + } - return $oTagSet; - } + /** + * force an allowed value (type conversion and possibly forces a value as mySQL would do upon writing! + * + * @param $proposedValue + * @param $oHostObj + * + * @param bool $bIgnoreErrors + * + * @return mixed + * @throws CoreException + * @throws CoreUnexpectedValue + */ + public function MakeRealValue($proposedValue, $oHostObj, $bIgnoreErrors = false) + { + $oTagSet = new ormTagSet(MetaModel::GetAttributeOrigin($this->GetHostClass(), $this->GetCode()), $this->GetCode(), $this->GetMaxItems()); + if (is_string($proposedValue) && !empty($proposedValue)) { + $sJsonFromWidget = json_decode($proposedValue, true); + if (is_null($sJsonFromWidget)) { + $proposedValue = trim("$proposedValue"); + $aTagCodes = $this->FromStringToArray($proposedValue); + $oTagSet->SetValues($aTagCodes); + } + } elseif ($proposedValue instanceof ormTagSet) { + $oTagSet = $proposedValue; + } - /** - * Get the value from a given string (plain text, CSV import) - * - * @param string $sProposedValue - * @param bool $bLocalizedValue - * @param string $sSepItem - * @param string $sSepAttribute - * @param string $sSepValue - * @param string $sAttributeQualifier - * - * @return mixed null if no match could be found - * @throws \Exception - */ - public function MakeValueFromString($sProposedValue, $bLocalizedValue = false, $sSepItem = null, $sSepAttribute = null, $sSepValue = null, $sAttributeQualifier = null) - { - if (is_null($sSepItem) || empty($sSepItem)) { - $sSepItem = MetaModel::GetConfig()->Get('tag_set_item_separator'); - } - if (!empty($sProposedValue)) { - $oTagSet = new ormTagSet(MetaModel::GetAttributeOrigin($this->GetHostClass(), $this->GetCode()), - $this->GetCode(), $this->GetMaxItems()); - $aLabels = explode($sSepItem, $sProposedValue); - $aCodes = array(); - foreach ($aLabels as $sTagLabel) { - if (!empty($sTagLabel)) { - $aCodes[] = ($bLocalizedValue) ? $oTagSet->GetTagFromLabel($sTagLabel) : $sTagLabel; - } - } - $sProposedValue = implode(' ', $aCodes); - } + return $oTagSet; + } - return $this->MakeRealValue($sProposedValue, null); - } + /** + * Get the value from a given string (plain text, CSV import) + * + * @param string $sProposedValue + * @param bool $bLocalizedValue + * @param string $sSepItem + * @param string $sSepAttribute + * @param string $sSepValue + * @param string $sAttributeQualifier + * + * @return mixed null if no match could be found + * @throws Exception + */ + public function MakeValueFromString($sProposedValue, $bLocalizedValue = false, $sSepItem = null, $sSepAttribute = null, $sSepValue = null, $sAttributeQualifier = null) + { + if (is_null($sSepItem) || empty($sSepItem)) { + $sSepItem = MetaModel::GetConfig()->Get('tag_set_item_separator'); + } + if (!empty($sProposedValue)) { + $oTagSet = new ormTagSet(MetaModel::GetAttributeOrigin($this->GetHostClass(), $this->GetCode()), + $this->GetCode(), $this->GetMaxItems()); + $aLabels = explode($sSepItem, $sProposedValue); + $aCodes = array(); + foreach ($aLabels as $sTagLabel) { + if (!empty($sTagLabel)) { + $aCodes[] = ($bLocalizedValue) ? $oTagSet->GetTagFromLabel($sTagLabel) : $sTagLabel; + } + } + $sProposedValue = implode(' ', $aCodes); + } - public function GetNullValue() - { - return new ormTagSet(MetaModel::GetAttributeOrigin($this->GetHostClass(), $this->GetCode()), $this->GetCode(), $this->GetMaxItems()); - } + return $this->MakeRealValue($sProposedValue, null); + } - public function GetDefaultValue(DBObject $oHostObject = null) - { - $oTagSet = new ormTagSet(MetaModel::GetAttributeOrigin($this->GetHostClass(), $this->GetCode()), $this->GetCode(), $this->GetMaxItems()); - $oTagSet->SetValues([]); - return $oTagSet; - } + public function GetNullValue() + { + return new ormTagSet(MetaModel::GetAttributeOrigin($this->GetHostClass(), $this->GetCode()), $this->GetCode(), $this->GetMaxItems()); + } - public function IsNull($proposedValue) - { - if (is_null($proposedValue)) { - return true; - } + public function GetDefaultValue(DBObject $oHostObject = null) + { + $oTagSet = new ormTagSet(MetaModel::GetAttributeOrigin($this->GetHostClass(), $this->GetCode()), $this->GetCode(), $this->GetMaxItems()); + $oTagSet->SetValues([]); - /** @var \ormTagSet $proposedValue */ - return count($proposedValue->GetValues()) == 0; - } + return $oTagSet; + } - /** - * To be overloaded for localized enums - * - * @param $sValue - * - * @return string label corresponding to the given value (in plain text) - * @throws \CoreWarning - * @throws \Exception - */ - public function GetValueLabel($sValue) - { - if (empty($sValue)) { - return ''; - } - if (is_string($sValue)) { - $sValue = $this->GetExistingTagsFromString($sValue); - } - if ($sValue instanceof ormTagSet) { - $aValues = $sValue->GetLabels(); + public function IsNull($proposedValue) + { + if (is_null($proposedValue)) { + return true; + } - return implode(', ', $aValues); - } - throw new CoreWarning('Expected the attribute value to be a TagSet', array( - 'found_type' => gettype($sValue), - 'value' => $sValue, - 'class' => $this->GetHostClass(), - 'attribute' => $this->GetCode() - )); - } + /** @var ormTagSet $proposedValue */ + return count($proposedValue->GetValues()) == 0; + } - /** - * @param $value - * - * @return string - * @throws \CoreWarning - */ - public function ScalarToSQL($value) - { - if (empty($value)) { - return ''; - } - if ($value instanceof ormTagSet) { - $aValues = $value->GetValues(); + /** + * To be overloaded for localized enums + * + * @param $sValue + * + * @return string label corresponding to the given value (in plain text) + * @throws CoreWarning + * @throws Exception + */ + public function GetValueLabel($sValue) + { + if (empty($sValue)) { + return ''; + } + if (is_string($sValue)) { + $sValue = $this->GetExistingTagsFromString($sValue); + } + if ($sValue instanceof ormTagSet) { + $aValues = $sValue->GetLabels(); - return implode(' ', $aValues); - } - throw new CoreWarning('Expected the attribute value to be a TagSet', array( - 'found_type' => gettype($value), - 'value' => $value, - 'class' => $this->GetHostClass(), - 'attribute' => $this->GetCode() - )); - } + return implode(', ', $aValues); + } + throw new CoreWarning('Expected the attribute value to be a TagSet', array( + 'found_type' => gettype($sValue), + 'value' => $sValue, + 'class' => $this->GetHostClass(), + 'attribute' => $this->GetCode(), + )); + } - /** - * @param $value - * @param \DBObject $oHostObject - * @param bool $bLocalize - * - * @return string|null - * - * @throws \CoreException - * @throws \Exception - */ - public function GetAsHTML($value, $oHostObject = null, $bLocalize = true) - { - if ($value instanceof ormTagSet) { - if ($bLocalize) { - $aValues = $value->GetTags(); - } else { - $aValues = $value->GetValues(); - } - if (empty($aValues)) { - return ''; - } + /** + * @param $value + * + * @return string + * @throws CoreWarning + */ + public function ScalarToSQL($value) + { + if (empty($value)) { + return ''; + } + if ($value instanceof ormTagSet) { + $aValues = $value->GetValues(); - return $this->GenerateViewHtmlForValues($aValues); - } - if (is_string($value)) { - try { - $oValue = $this->MakeRealValue($value, $oHostObject); + return implode(' ', $aValues); + } + throw new CoreWarning('Expected the attribute value to be a TagSet', array( + 'found_type' => gettype($value), + 'value' => $value, + 'class' => $this->GetHostClass(), + 'attribute' => $this->GetCode(), + )); + } - return $this->GetAsHTML($oValue, $oHostObject, $bLocalize); - } catch (Exception $e) { - // unknown tags are present display the code instead - } - $aTagCodes = $this->FromStringToArray($value); - $aValues = array(); - $oTagSet = new ormTagSet(MetaModel::GetAttributeOrigin($this->GetHostClass(), $this->GetCode()), - $this->GetCode(), $this->GetMaxItems()); - foreach ($aTagCodes as $sTagCode) { - try { - $oTagSet->Add($sTagCode); - } catch (Exception $e) { - $aValues[] = $sTagCode; - } - } - $sHTML = ''; - if (!empty($aValues)) { - $sHTML .= $this->GenerateViewHtmlForValues($aValues, 'attribute-set-item-undefined'); - } - $aValues = $oTagSet->GetTags(); - if (!empty($aValues)) { - $sHTML .= $this->GenerateViewHtmlForValues($aValues); - } + /** + * @param $value + * @param DBObject $oHostObject + * @param bool $bLocalize + * + * @return string|null + * + * @throws CoreException + * @throws Exception + */ + public function GetAsHTML($value, $oHostObject = null, $bLocalize = true) + { + if ($value instanceof ormTagSet) { + if ($bLocalize) { + $aValues = $value->GetTags(); + } else { + $aValues = $value->GetValues(); + } + if (empty($aValues)) { + return ''; + } - return $sHTML; - } + return $this->GenerateViewHtmlForValues($aValues); + } + if (is_string($value)) { + try { + $oValue = $this->MakeRealValue($value, $oHostObject); - return parent::GetAsHTML($value, $oHostObject, $bLocalize); - } + return $this->GetAsHTML($oValue, $oHostObject, $bLocalize); + } + catch (Exception $e) { + // unknown tags are present display the code instead + } + $aTagCodes = $this->FromStringToArray($value); + $aValues = array(); + $oTagSet = new ormTagSet(MetaModel::GetAttributeOrigin($this->GetHostClass(), $this->GetCode()), + $this->GetCode(), $this->GetMaxItems()); + foreach ($aTagCodes as $sTagCode) { + try { + $oTagSet->Add($sTagCode); + } + catch (Exception $e) { + $aValues[] = $sTagCode; + } + } + $sHTML = ''; + if (!empty($aValues)) { + $sHTML .= $this->GenerateViewHtmlForValues($aValues, 'attribute-set-item-undefined'); + } + $aValues = $oTagSet->GetTags(); + if (!empty($aValues)) { + $sHTML .= $this->GenerateViewHtmlForValues($aValues); + } - // Do not display friendly names in the history of change - public function DescribeChangeAsHTML($sOldValue, $sNewValue, $sLabel = null) - { - $sResult = Dict::Format('Change:AttName_Changed', $this->GetLabel()) . ", "; + return $sHTML; + } - $aNewValues = $this->FromStringToArray($sNewValue); - $aOldValues = $this->FromStringToArray($sOldValue); + return parent::GetAsHTML($value, $oHostObject, $bLocalize); + } - $aDelta['removed'] = array_diff($aOldValues, $aNewValues); - $aDelta['added'] = array_diff($aNewValues, $aOldValues); + // Do not display friendly names in the history of change + public function DescribeChangeAsHTML($sOldValue, $sNewValue, $sLabel = null) + { + $sResult = Dict::Format('Change:AttName_Changed', $this->GetLabel()).", "; - $aAllowedTags = TagSetFieldData::GetAllowedValues(MetaModel::GetAttributeOrigin($this->GetHostClass(), $this->GetCode()), $this->GetCode()); + $aNewValues = $this->FromStringToArray($sNewValue); + $aOldValues = $this->FromStringToArray($sOldValue); - if (!empty($aDelta['removed'])) { - $aRemoved = array(); - foreach ($aDelta['removed'] as $idx => $sTagCode) { - if (empty($sTagCode)) { - continue; - } - $sTagLabel = $sTagCode; - foreach ($aAllowedTags as $oTag) { - if ($sTagCode === $oTag->Get('code')) { - $sTagLabel = $oTag->Get('label'); - } - } - $aRemoved[] = $sTagLabel; - } + $aDelta['removed'] = array_diff($aOldValues, $aNewValues); + $aDelta['added'] = array_diff($aNewValues, $aOldValues); - $sRemoved = $this->GenerateViewHtmlForValues($aRemoved, 'history-removed'); - if (!empty($sRemoved)) { - $sResult .= Dict::Format('Change:LinkSet:Removed', $sRemoved); - } - } + $aAllowedTags = TagSetFieldData::GetAllowedValues(MetaModel::GetAttributeOrigin($this->GetHostClass(), $this->GetCode()), $this->GetCode()); - if (!empty($aDelta['added'])) { - if (!empty($sRemoved)) { - $sResult .= ', '; - } + if (!empty($aDelta['removed'])) { + $aRemoved = array(); + foreach ($aDelta['removed'] as $idx => $sTagCode) { + if (empty($sTagCode)) { + continue; + } + $sTagLabel = $sTagCode; + foreach ($aAllowedTags as $oTag) { + if ($sTagCode === $oTag->Get('code')) { + $sTagLabel = $oTag->Get('label'); + } + } + $aRemoved[] = $sTagLabel; + } - $aAdded = array(); - foreach ($aDelta['added'] as $idx => $sTagCode) { - if (empty($sTagCode)) { - continue; - } - $sTagLabel = $sTagCode; - foreach ($aAllowedTags as $oTag) { - if ($sTagCode === $oTag->Get('code')) { - $sTagLabel = $oTag->Get('label'); - } - } - $aAdded[] = $sTagLabel; - } + $sRemoved = $this->GenerateViewHtmlForValues($aRemoved, 'history-removed'); + if (!empty($sRemoved)) { + $sResult .= Dict::Format('Change:LinkSet:Removed', $sRemoved); + } + } - $sAdded = $this->GenerateViewHtmlForValues($aAdded, 'history-added'); - if (!empty($sAdded)) { - $sResult .= Dict::Format('Change:LinkSet:Added', $sAdded); - } - } + if (!empty($aDelta['added'])) { + if (!empty($sRemoved)) { + $sResult .= ', '; + } - return $sResult; - } + $aAdded = array(); + foreach ($aDelta['added'] as $idx => $sTagCode) { + if (empty($sTagCode)) { + continue; + } + $sTagLabel = $sTagCode; + foreach ($aAllowedTags as $oTag) { + if ($sTagCode === $oTag->Get('code')) { + $sTagLabel = $oTag->Get('label'); + } + } + $aAdded[] = $sTagLabel; + } - /** - * HTML representation of a list of tags (read-only) - * accept a list of strings or a list of TagSetFieldData - * - * @param array $aValues - * @param string $sCssClass - * @param bool $bWithLink if true will generate a link, otherwise just a "a" tag without href - * - * @return string - * @throws \CoreException - * @throws \OQLException - */ - public function GenerateViewHtmlForValues($aValues, $sCssClass = '', $bWithLink = true) - { - if (empty($aValues)) { - return ''; - } - $sHtml = ''; - foreach ($aValues as $oTag) { - if ($oTag instanceof TagSetFieldData) { - $sClass = MetaModel::GetAttributeOrigin($this->GetHostClass(), $this->GetCode()); - $sAttCode = $this->GetCode(); - $sTagCode = $oTag->Get('code'); - $sTagLabel = $oTag->Get('label'); - $sTagDescription = $oTag->Get('description'); - $oFilter = DBSearch::FromOQL("SELECT $sClass WHERE $sAttCode MATCHES '$sTagCode'"); - $oAppContext = new ApplicationContext(); - $sContext = $oAppContext->GetForLink(true); - $sUIPage = cmdbAbstractObject::ComputeStandardUIPage($oFilter->GetClass()); - $sFilter = rawurlencode($oFilter->serialize()); + $sAdded = $this->GenerateViewHtmlForValues($aAdded, 'history-added'); + if (!empty($sAdded)) { + $sResult .= Dict::Format('Change:LinkSet:Added', $sAdded); + } + } - $sLink = ''; - if ($bWithLink && $this->bDisplayLink) { - $sUrl = utils::GetAbsoluteUrlAppRoot() . "pages/$sUIPage?operation=search&filter=" . $sFilter . $sContext; - $sLink = ' href="' . $sUrl . '"'; - } + return $sResult; + } - $sLabelForHtml = utils::EscapeHtml($sTagLabel); - $sDescriptionForHtml = utils::EscapeHtml($sTagDescription); - if (empty($sTagDescription)) { - $sTooltipContent = $sTagLabel; - $sTooltipHtmlEnabled = 'false'; - } else { - $sTagLabelEscaped = utils::EscapeHtml($sTagLabel); - $sTooltipContent = <<aCSSClasses).'">'; + foreach ($aValues as $oTag) { + if ($oTag instanceof TagSetFieldData) { + $sClass = MetaModel::GetAttributeOrigin($this->GetHostClass(), $this->GetCode()); + $sAttCode = $this->GetCode(); + $sTagCode = $oTag->Get('code'); + $sTagLabel = $oTag->Get('label'); + $sTagDescription = $oTag->Get('description'); + $oFilter = DBSearch::FromOQL("SELECT $sClass WHERE $sAttCode MATCHES '$sTagCode'"); + $oAppContext = new ApplicationContext(); + $sContext = $oAppContext->GetForLink(true); + $sUIPage = cmdbAbstractObject::ComputeStandardUIPage($oFilter->GetClass()); + $sFilter = rawurlencode($oFilter->serialize()); + + $sLink = ''; + if ($bWithLink && $this->bDisplayLink) { + $sUrl = utils::GetAbsoluteUrlAppRoot()."pages/$sUIPage?operation=search&filter=".$sFilter.$sContext; + $sLink = ' href="'.$sUrl.'"'; + } + + $sLabelForHtml = utils::EscapeHtml($sTagLabel); + $sDescriptionForHtml = utils::EscapeHtml($sTagDescription); + if (empty($sTagDescription)) { + $sTooltipContent = $sTagLabel; + $sTooltipHtmlEnabled = 'false'; + } else { + $sTagLabelEscaped = utils::EscapeHtml($sTagLabel); + $sTooltipContent = <<$sTagLabelEscaped$sCell | "; + } + $sRes .= "$sTagDescriptionHTML; - $sTooltipHtmlEnabled = 'true'; - } - $sTooltipContent = utils::HtmlEntities($sTooltipContent); + $sTooltipHtmlEnabled = 'true'; + } + $sTooltipContent = utils::HtmlEntities($sTooltipContent); - $sHtml .= '\n"; - if ($bLocalize) { - $aValues = $value->GetLabels(); - } else { - $aValues = $value->GetValues(); - } - if (!empty($aValues)) { - $sRes .= ' \n"; - } else { - $sRes = ''; - } + /** + * @param $value + * @param DBObject $oHostObject + * @param bool $bLocalize + * + * @return string + * + */ + public function GetAsXML($value, $oHostObject = null, $bLocalize = true) + { + if (is_object($value) && ($value instanceof ormTagSet)) { + $sRes = "' . implode(' ', $aValues) . ' '; - } - $sRes .= "\n"; + if ($bLocalize) { + $aValues = $value->GetLabels(); + } else { + $aValues = $value->GetValues(); + } + if (!empty($aValues)) { + $sRes .= ' \n"; + } else { + $sRes = ''; + } - return $sRes; - } + return $sRes; + } - /** - * List the available verbs for 'GetForTemplate' - */ - public function EnumTemplateVerbs() - { - return array( - '' => 'Plain text representation', - 'html' => 'HTML representation (unordered list)', - ); - } + /** + * List the available verbs for 'GetForTemplate' + */ + public function EnumTemplateVerbs() + { + return array( + '' => 'Plain text representation', + 'html' => 'HTML representation (unordered list)', + ); + } - /** - * Get various representations of the value, for insertion into a template (e.g. in Notifications) - * - * @param mixed $value The current value of the field - * @param string $sVerb The verb specifying the representation of the value - * @param DBObject $oHostObject The object - * @param bool $bLocalize Whether or not to localize the value - * - * @return string - * @throws \Exception - */ - public function GetForTemplate($value, $sVerb, $oHostObject = null, $bLocalize = true) - { - if (is_object($value) && ($value instanceof ormTagSet)) { - if ($bLocalize) { - $aValues = $value->GetLabels(); - $sSep = ', '; - } else { - $aValues = $value->GetValues(); - $sSep = ' '; - } + /** + * Get various representations of the value, for insertion into a template (e.g. in Notifications) + * + * @param mixed $value The current value of the field + * @param string $sVerb The verb specifying the representation of the value + * @param DBObject $oHostObject The object + * @param bool $bLocalize Whether or not to localize the value + * + * @return string + * @throws Exception + */ + public function GetForTemplate($value, $sVerb, $oHostObject = null, $bLocalize = true) + { + if (is_object($value) && ($value instanceof ormTagSet)) { + if ($bLocalize) { + $aValues = $value->GetLabels(); + $sSep = ', '; + } else { + $aValues = $value->GetValues(); + $sSep = ' '; + } - switch ($sVerb) { - case '': - return implode($sSep, $aValues); + switch ($sVerb) { + case '': + return implode($sSep, $aValues); - case 'html': - return ''.implode(' ', $aValues).' '; + } + $sRes .= "- ' . implode("
- ", $aValues) . '
- '.implode("
- ", $aValues).'
$sValue"; - } else { - $sValue = self::RenderWikiHtml($sValue, true /* wiki only */); + return "$sValue"; + } else { + $sValue = self::RenderWikiHtml($sValue, true /* wiki only */); - return "" . InlineImage::FixUrls($sValue) . ''; - } + return "".InlineImage::FixUrls($sValue).''; + } - } + } - public function GetEditValue($sValue, $oHostObj = null) - { - // N°4517 - PHP 8.1 compatibility: str_replace call with null cause deprecated message - if ($sValue == null) { - return ''; - } + public function GetEditValue($sValue, $oHostObj = null) + { + // N°4517 - PHP 8.1 compatibility: str_replace call with null cause deprecated message + if ($sValue == null) { + return ''; + } - if ($this->GetFormat() == 'text') { - if (preg_match_all(WIKI_OBJECT_REGEXP, $sValue, $aAllMatches, PREG_SET_ORDER)) { - foreach ($aAllMatches as $iPos => $aMatches) { - $sClass = trim($aMatches[1]); - $sName = trim($aMatches[2]); - $sLabel = (!empty($aMatches[4])) ? trim($aMatches[4]) : null; + if ($this->GetFormat() == 'text') { + if (preg_match_all(WIKI_OBJECT_REGEXP, $sValue, $aAllMatches, PREG_SET_ORDER)) { + foreach ($aAllMatches as $iPos => $aMatches) { + $sClass = trim($aMatches[1]); + $sName = trim($aMatches[2]); + $sLabel = (!empty($aMatches[4])) ? trim($aMatches[4]) : null; - if (MetaModel::IsValidClass($sClass)) { - $sClassLabel = MetaModel::GetName($sClass); - $sReplacement = "[[$sClassLabel:$sName" . (!empty($sLabel) ? " | $sLabel" : "") . "]]"; - $sValue = str_replace($aMatches[0], $sReplacement, $sValue); - } - } - } - } + if (MetaModel::IsValidClass($sClass)) { + $sClassLabel = MetaModel::GetName($sClass); + $sReplacement = "[[$sClassLabel:$sName".(!empty($sLabel) ? " | $sLabel" : "")."]]"; + $sValue = str_replace($aMatches[0], $sReplacement, $sValue); + } + } + } + } - return $sValue; - } + return $sValue; + } - /** - * For fields containing a potential markup, return the value without this markup - * - * @param string $sValue - * @param \DBObject $oHostObj - * - * @return string - */ - public function GetAsPlainText($sValue, $oHostObj = null) - { - if ($this->GetFormat() == 'html') { - return (string)utils::HtmlToText($this->GetEditValue($sValue, $oHostObj)); - } else { - return parent::GetAsPlainText($sValue, $oHostObj); - } - } + /** + * For fields containing a potential markup, return the value without this markup + * + * @param string $sValue + * @param DBObject $oHostObj + * + * @return string + */ + public function GetAsPlainText($sValue, $oHostObj = null) + { + if ($this->GetFormat() == 'html') { + return (string)utils::HtmlToText($this->GetEditValue($sValue, $oHostObj)); + } else { + return parent::GetAsPlainText($sValue, $oHostObj); + } + } - public function MakeRealValue($proposedValue, $oHostObj) - { - $sValue = $proposedValue; + public function MakeRealValue($proposedValue, $oHostObj) + { + $sValue = $proposedValue; - // N°4517 - PHP 8.1 compatibility: str_replace call with null cause deprecated message - if ($sValue == null) { - return ''; - } + // N°4517 - PHP 8.1 compatibility: str_replace call with null cause deprecated message + if ($sValue == null) { + return ''; + } - switch ($this->GetFormat()) { - case 'html': - if (($sValue !== null) && ($sValue !== '')) { - $sValue = HTMLSanitizer::Sanitize($sValue); - } - break; + switch ($this->GetFormat()) { + case 'html': + if (($sValue !== null) && ($sValue !== '')) { + $sValue = HTMLSanitizer::Sanitize($sValue); + } + break; - case 'text': - default: - if (preg_match_all(WIKI_OBJECT_REGEXP, $sValue, $aAllMatches, PREG_SET_ORDER)) { - foreach ($aAllMatches as $iPos => $aMatches) { - $sClassLabel = trim($aMatches[1]); - $sName = trim($aMatches[2]); - $sLabel = (!empty($aMatches[4])) ? trim($aMatches[4]) : null; + case 'text': + default: + if (preg_match_all(WIKI_OBJECT_REGEXP, $sValue, $aAllMatches, PREG_SET_ORDER)) { + foreach ($aAllMatches as $iPos => $aMatches) { + $sClassLabel = trim($aMatches[1]); + $sName = trim($aMatches[2]); + $sLabel = (!empty($aMatches[4])) ? trim($aMatches[4]) : null; - if (!MetaModel::IsValidClass($sClassLabel)) { - $sClass = MetaModel::GetClassFromLabel($sClassLabel); - if ($sClass) { - $sReplacement = "[[$sClassLabel:$sName" . (!empty($sLabel) ? " | $sLabel" : "") . "]]"; - $sValue = str_replace($aMatches[0], $sReplacement, $sValue); - } - } - } - } - } + if (!MetaModel::IsValidClass($sClassLabel)) { + $sClass = MetaModel::GetClassFromLabel($sClassLabel); + if ($sClass) { + $sReplacement = "[[$sClassLabel:$sName".(!empty($sLabel) ? " | $sLabel" : "")."]]"; + $sValue = str_replace($aMatches[0], $sReplacement, $sValue); + } + } + } + } + } - return $sValue; - } + return $sValue; + } - public function GetAsXML($value, $oHostObject = null, $bLocalize = true) - { - return Str::pure2xml($value); - } + public function GetAsXML($value, $oHostObject = null, $bLocalize = true) + { + return Str::pure2xml($value); + } - public function GetWidth() - { - return $this->GetOptional('width', ''); - } + public function GetWidth() + { + return $this->GetOptional('width', ''); + } - public function GetHeight() - { - return $this->GetOptional('height', ''); - } + public function GetHeight() + { + return $this->GetOptional('height', ''); + } - public static function GetFormFieldClass() - { - return '\\Combodo\\iTop\\Form\\Field\\TextAreaField'; - } + public static function GetFormFieldClass() + { + return '\\Combodo\\iTop\\Form\\Field\\TextAreaField'; + } - /** - * @param \DBObject $oObject - * @param \Combodo\iTop\Form\Field\TextAreaField $oFormField - * - * @return \Combodo\iTop\Form\Field\TextAreaField - * @throws \CoreException - */ - public function MakeFormField(DBObject $oObject, $oFormField = null) - { - if ($oFormField === null) { - $sFormFieldClass = static::GetFormFieldClass(); - /** @var \Combodo\iTop\Form\Field\TextAreaField $oFormField */ - $oFormField = new $sFormFieldClass($this->GetCode(), null, $oObject); - $oFormField->SetFormat($this->GetFormat()); - } - parent::MakeFormField($oObject, $oFormField); + /** + * @param DBObject $oObject + * @param TextAreaField $oFormField + * + * @return TextAreaField + * @throws CoreException + */ + public function MakeFormField(DBObject $oObject, $oFormField = null) + { + if ($oFormField === null) { + $sFormFieldClass = static::GetFormFieldClass(); + /** @var TextAreaField $oFormField */ + $oFormField = new $sFormFieldClass($this->GetCode(), null, $oObject); + $oFormField->SetFormat($this->GetFormat()); + } + parent::MakeFormField($oObject, $oFormField); - return $oFormField; - } + return $oFormField; + } - /** - * The actual formatting of the field: either text (=plain text) or html (= text with HTML markup) - * - * @return string - */ - public function GetFormat() - { - return $this->GetOptional('format', 'text'); - } + /** + * The actual formatting of the field: either text (=plain text) or html (= text with HTML markup) + * + * @return string + */ + public function GetFormat() + { + return $this->GetOptional('format', 'text'); + } - /** - * Read the value from the row returned by the SQL query and transorms it to the appropriate - * internal format (either text or html) - * - * @param array $aCols - * @param string $sPrefix - * - * @return string - * @see AttributeDBFieldVoid::FromSQLToValue() - * - */ - public function FromSQLToValue($aCols, $sPrefix = '') - { - $value = $aCols[$sPrefix . '']; - if ($this->GetOptional('format', null) != null) { - // Read from the extra column only if the property 'format' is specified for the attribute - $sFormat = $aCols[$sPrefix . '_format']; - } else { - $sFormat = $this->GetFormat(); - } + /** + * Read the value from the row returned by the SQL query and transorms it to the appropriate + * internal format (either text or html) + * + * @see AttributeDBFieldVoid::FromSQLToValue() + * + * @param string $sPrefix + * + * @param array $aCols + * + * @return string + */ + public function FromSQLToValue($aCols, $sPrefix = '') + { + $value = $aCols[$sPrefix.'']; + if ($this->GetOptional('format', null) != null) { + // Read from the extra column only if the property 'format' is specified for the attribute + $sFormat = $aCols[$sPrefix.'_format']; + } else { + $sFormat = $this->GetFormat(); + } - switch ($sFormat) { - case 'text': - if ($this->GetFormat() == 'html') { - $value = utils::TextToHtml($value); - } - break; + switch ($sFormat) { + case 'text': + if ($this->GetFormat() == 'html') { + $value = utils::TextToHtml($value); + } + break; - case 'html': - if ($this->GetFormat() == 'text') { - $value = utils::HtmlToText($value); - } else { - $value = InlineImage::FixUrls((string)$value); - } - break; + case 'html': + if ($this->GetFormat() == 'text') { + $value = utils::HtmlToText($value); + } else { + $value = InlineImage::FixUrls((string)$value); + } + break; - default: - // unknown format ?? - } + default: + // unknown format ?? + } - return $value; - } + return $value; + } - public function GetSQLValues($value) - { - $aValues = array(); - $aValues[$this->Get("sql")] = $this->ScalarToSQL($value); - if ($this->GetOptional('format', null) != null) { - // Add the extra column only if the property 'format' is specified for the attribute - $aValues[$this->Get("sql") . '_format'] = $this->GetFormat(); - } + public function GetSQLValues($value) + { + $aValues = array(); + $aValues[$this->Get("sql")] = $this->ScalarToSQL($value); + if ($this->GetOptional('format', null) != null) { + // Add the extra column only if the property 'format' is specified for the attribute + $aValues[$this->Get("sql").'_format'] = $this->GetFormat(); + } - return $aValues; - } + return $aValues; + } - public function GetAsCSV( - $sValue, $sSeparator = ',', $sTextQualifier = '"', $oHostObject = null, $bLocalize = true, - $bConvertToPlainText = false - ) - { - switch ($this->GetFormat()) { - case 'html': - if ($bConvertToPlainText) { - $sValue = utils::HtmlToText((string)$sValue); - } - $sFrom = array("\r\n", $sTextQualifier); - $sTo = array("\n", $sTextQualifier . $sTextQualifier); - $sEscaped = str_replace($sFrom, $sTo, (string)$sValue); + public function GetAsCSV( + $sValue, $sSeparator = ',', $sTextQualifier = '"', $oHostObject = null, $bLocalize = true, + $bConvertToPlainText = false + ) + { + switch ($this->GetFormat()) { + case 'html': + if ($bConvertToPlainText) { + $sValue = utils::HtmlToText((string)$sValue); + } + $sFrom = array("\r\n", $sTextQualifier); + $sTo = array("\n", $sTextQualifier.$sTextQualifier); + $sEscaped = str_replace($sFrom, $sTo, (string)$sValue); - return $sTextQualifier . $sEscaped . $sTextQualifier; - break; + return $sTextQualifier.$sEscaped.$sTextQualifier; + break; - case 'text': - default: - return parent::GetAsCSV($sValue, $sSeparator, $sTextQualifier, $oHostObject, $bLocalize, - $bConvertToPlainText); - } - } + case 'text': + default: + return parent::GetAsCSV($sValue, $sSeparator, $sTextQualifier, $oHostObject, $bLocalize, + $bConvertToPlainText); + } + } - protected function GetChangeRecordAdditionalData(CMDBChangeOp $oMyChangeOp, DBObject $oObject, $original, $value): void - { - /** @noinspection PhpConditionCheckedByNextConditionInspection */ - if (false === is_null($original) && ($original instanceof ormCaseLog)) { - $original = $original->GetText(); - } - $oMyChangeOp->Set("prevdata", $original); - } + protected function GetChangeRecordAdditionalData(CMDBChangeOp $oMyChangeOp, DBObject $oObject, $original, $value): void + { + /** @noinspection PhpConditionCheckedByNextConditionInspection */ + if (false === is_null($original) && ($original instanceof ormCaseLog)) { + $original = $original->GetText(); + } + $oMyChangeOp->Set("prevdata", $original); + } - protected function GetChangeRecordClassName(): string - { - return ($this->GetFormat() === 'html') - ? CMDBChangeOpSetAttributeHTML::class - : CMDBChangeOpSetAttributeText::class; - } + protected function GetChangeRecordClassName(): string + { + return ($this->GetFormat() === 'html') + ? CMDBChangeOpSetAttributeHTML::class + : CMDBChangeOpSetAttributeText::class; + } } \ No newline at end of file diff --git a/sources/Core/AttributeDefinition/AttributeURL.php b/sources/Core/AttributeDefinition/AttributeURL.php index 89dc55c67..e478b30d8 100644 --- a/sources/Core/AttributeDefinition/AttributeURL.php +++ b/sources/Core/AttributeDefinition/AttributeURL.php @@ -1,4 +1,19 @@ GetSQLColSpec() : ''); - } + protected function GetSQLCol($bFullSpec = false) + { + return "VARCHAR(2048)" + .CMDBSource::GetSqlStringColumnDefinition() + .($bFullSpec ? $this->GetSQLColSpec() : ''); + } - public function GetMaxSize() - { - return 2048; - } + public function GetMaxSize() + { + return 2048; + } - public function GetEditClass() - { - return "String"; - } + public function GetEditClass() + { + return "String"; + } - public function GetAsHTML($sValue, $oHostObject = null, $bLocalize = true) - { - $sTarget = $this->Get("target"); - if (empty($sTarget)) { - $sTarget = "_blank"; - } - $sLabel = Str::pure2html($sValue); - if (strlen($sLabel) > 128) { - // Truncate the length to 128 characters, by removing the middle - $sLabel = substr($sLabel, 0, 100) . '.....' . substr($sLabel, -20); - } + public function GetAsHTML($sValue, $oHostObject = null, $bLocalize = true) + { + $sTarget = $this->Get("target"); + if (empty($sTarget)) { + $sTarget = "_blank"; + } + $sLabel = Str::pure2html($sValue); + if (strlen($sLabel) > 128) { + // Truncate the length to 128 characters, by removing the middle + $sLabel = substr($sLabel, 0, 100).'.....'.substr($sLabel, -20); + } - return "$sLabel"; - } + return "$sLabel"; + } - public function GetValidationPattern() - { - return $this->GetOptional('validation_pattern', '^' . utils::GetConfig()->Get('url_validation_pattern') . '$'); - } + public function GetValidationPattern() + { + return $this->GetOptional('validation_pattern', '^'.utils::GetConfig()->Get('url_validation_pattern').'$'); + } - public static function GetFormFieldClass() - { - return '\\Combodo\\iTop\\Form\\Field\\UrlField'; - } + public static function GetFormFieldClass() + { + return '\\Combodo\\iTop\\Form\\Field\\UrlField'; + } - /** - * @param \DBObject $oObject - * @param \Combodo\iTop\Form\Field\UrlField $oFormField - * - * @return null - * @throws \CoreException - */ - public function MakeFormField(DBObject $oObject, $oFormField = null) - { - if ($oFormField === null) { - $sFormFieldClass = static::GetFormFieldClass(); - $oFormField = new $sFormFieldClass($this->GetCode()); - } - parent::MakeFormField($oObject, $oFormField); + /** + * @param DBObject $oObject + * @param UrlField $oFormField + * + * @return null + * @throws CoreException + */ + public function MakeFormField(DBObject $oObject, $oFormField = null) + { + if ($oFormField === null) { + $sFormFieldClass = static::GetFormFieldClass(); + $oFormField = new $sFormFieldClass($this->GetCode()); + } + parent::MakeFormField($oObject, $oFormField); - $oFormField->SetTarget($this->Get('target')); + $oFormField->SetTarget($this->Get('target')); - return $oFormField; - } + return $oFormField; + } - protected function GetChangeRecordClassName(): string - { - return CMDBChangeOpSetAttributeURL::class; - } + protected function GetChangeRecordClassName(): string + { + return CMDBChangeOpSetAttributeURL::class; + } } \ No newline at end of file diff --git a/sources/Core/AttributeDefinition/MissingColumnException.php b/sources/Core/AttributeDefinition/MissingColumnException.php index 351224f58..c8b215dc4 100644 --- a/sources/Core/AttributeDefinition/MissingColumnException.php +++ b/sources/Core/AttributeDefinition/MissingColumnException.php @@ -1,4 +1,12 @@