composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-04-23 02:28:44 +02:00
Code Issues Packages Projects Releases Wiki Activity

N°6043 - Booking: Add prerequisites in iTop core - Attribute extensibility

Browse Source
This commit is contained in:
Pierre Goiffon
2023-03-16 10:44:32 +01:00
parent fa17a7db2d
commit d8d8756623
4 changed files with 70 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files

80
core/attributedef.class.inc.php
View File

@@ -453,11 +453,49 @@ abstract class AttributeDefinition
/**
* @return bool true if the attribute value comes from the database in one way or another
*/
public static function LoadFromDB()
public static function LoadFromClassTables()
{
return true;
}
/**
* Write attribute values outside the current class tables
*
* @param \DBObject $oHostObject
*
* @return void
* @since 3.1.0
*/
public function WriteExternalValues(DBObject $oHostObject): void
{
}
/**
* Read the data from where it has been stored (outside the current class tables).
* This verb must be implemented as soon as LoadFromClassTables returns false and LoadInObject returns true
*
* @param DBObject $oHostObject
*
* @return mixed|null
* @since 3.1.0
*/
public function ReadExternalValues(DBObject $oHostObject)
{
return null;
}
/**
* Cleanup data upon object deletion (outside the current class tables)
* object id still available here
*
* @param \DBObject $oHostObject
*
* @since 3.1.0
*/
public function DeleteExternalValues(DBObject $oHostObject): void
{
}
/**
* @return bool true if the attribute should be loaded anytime (in addition to the column selected by the user)
*/
@@ -7068,19 +7106,6 @@ class AttributeExternalKey extends AttributeDBFieldVoid
return $oRet;
}
/**
* Return the deletion option for the target attribute
* i.e. should the target object be deleted when the host object is deleted
*
* @return int DEL_AUTO (yes explicit), DEL_SILENT (yes implicit), DEL_MANUAL (no = default)
*
* @since 3.1.0
*/
public function GetDeletionOptionForTargetObject(): int
{
return $this->GetOptional('on_host_delete', DEL_MANUAL);
}
public static function GetFormFieldClass()
{
return '\\Combodo\\iTop\\Form\\Field\\SelectObjectField';
@@ -12827,7 +12852,7 @@ class AttributeCustomFields extends AttributeDefinition
return true;
}
public static function LoadFromDB()
public static function LoadFromClassTables()
{
return false;
} // See ReadValue...
@@ -12970,14 +12995,15 @@ class AttributeCustomFields extends AttributeDefinition
}
/**
* Read the data from where it has been stored. This verb must be implemented as soon as LoadFromDB returns false
* Read the data from where it has been stored. This verb must be implemented as soon as LoadFromClassTables returns false
* and LoadInObject returns true
*
* @param $oHostObject
* @param DBObject $oHostObject
*
* @return ormCustomFieldsValue
* @return mixed|null
* @since 3.1.0
*/
public function ReadValue($oHostObject)
public function ReadExternalValues(DBObject $oHostObject)
{
try
{
@@ -12997,11 +13023,13 @@ class AttributeCustomFields extends AttributeDefinition
* It is assumed that the data has been checked prior to calling Write()
*
* @param DBObject $oHostObject
* @param ormCustomFieldsValue|null $oValue (null is the default value)
*
* @since 3.1.0
*/
public function WriteValue(DBObject $oHostObject, ormCustomFieldsValue $oValue = null)
public function WriteExternalValues(DBObject $oHostObject): void
{
if (is_null($oValue))
$oValue = $oHostObject->Get($this->GetCode());
if (!($oValue instanceof ormCustomFieldsValue))
{
$oHandler = $this->GetHandler();
$aValues = array();
@@ -13015,7 +13043,7 @@ class AttributeCustomFields extends AttributeDefinition
$aValues = $oForm->GetCurrentValues();
}
return $oHandler->WriteValues($oHostObject, $aValues);
$oHandler->WriteValues($oHostObject, $aValues);
}
/**
@@ -13074,15 +13102,15 @@ class AttributeCustomFields extends AttributeDefinition
*
* @param DBObject $oHostObject
*
* @return
* @throws \CoreException
* @since 3.1.0
*/
public function DeleteValue(DBObject $oHostObject)
public function DeleteExternalValues(DBObject $oHostObject): void
{
$oValue = $oHostObject->Get($this->GetCode());
$oHandler = $this->GetHandler($oValue->GetValues());
return $oHandler->DeleteValues($oHostObject);
$oHandler->DeleteValues($oHostObject);
}
public function GetAsHTML($value, $oHostObject = null, $bLocalize = true)

10
core/datamodel.core.xml
View File

@@ -371,25 +371,25 @@
<php_param>target</php_param>
<mandatory>false</mandatory>
<type>string</type>
<default>''</default>
<default/>
</property>
<property id="default_value">
<php_param>default_value</php_param>
<mandatory>false</mandatory>
<type>string</type>
<default>''</default>
<default/>
</property>
<property id="attribute_definition_list">
<php_param>attribute_definition_list</php_param>
<mandatory>false</mandatory>
<type>string</type>
<default>''</default>
<default/>
</property>
<property id="attribute_definition_exclusion_list">
<php_param>attribute_definition_exclusion_list</php_param>
<mandatory>false</mandatory>
<type>string</type>
<default>''</default>
<default/>
</property>
<property id="min_up">
<php_param>min_up</php_param>
@@ -502,7 +502,7 @@
<php_param>working_time_computing</php_param>
<mandatory>false</mandatory>
<type>string</type>
<default>''</default>
<default/>
</property>
</properties>
</attribute_properties_definition>

30
core/dbobject.class.php
View File

@@ -464,13 +464,14 @@ abstract class DBObject implements iDisplay
foreach($aAttList as $sAttCode=>$oAttDef)
{
// Skip links (could not be loaded by the mean of this query)
/** @var \AttributeDefinition $oAttDef */
if ($oAttDef->IsLinkSet()) continue;
if (!$oAttDef->LoadInObject()) continue;
unset($value);
$bIsDefined = false;
if ($oAttDef->LoadFromDB())
if ($oAttDef->LoadFromClassTables())
{
// Note: we assume that, for a given attribute, if it can be loaded,
// then one column will be found with an empty suffix, the others have a suffix
@@ -496,8 +497,7 @@ abstract class DBObject implements iDisplay
}
else
{
/** @var \AttributeCustomFields $oAttDef */
$value = $oAttDef->ReadValue($this);
$value = $oAttDef->ReadExternalValues($this);
$bIsDefined = true;
}
@@ -2674,11 +2674,9 @@ abstract class DBObject implements iDisplay
foreach (MetaModel::ListAttributeDefs(get_class($this)) as $sAttCode => $oAttDef)
{
if (!$oAttDef->LoadInObject()) continue;
if ($oAttDef->LoadFromDB()) continue;
if (!array_key_exists($sAttCode, $this->m_aTouchedAtt)) continue;
if (array_key_exists($sAttCode, $this->m_aModifiedAtt) && ($this->m_aModifiedAtt[$sAttCode] == false)) continue;
/** @var \AttributeCustomFields $oAttDef */
$oAttDef->WriteValue($this, $this->m_aCurrValues[$sAttCode]);
if (array_key_exists($sAttCode, $this->m_aModifiedAtt) && ($this->m_aModifiedAtt[$sAttCode] === false)) continue;
$oAttDef->WriteExternalValues($this);
}
}
@@ -3676,11 +3674,7 @@ abstract class DBObject implements iDisplay
}
MetaModel::HKReplugBranch($iNewLeft, $iNewLeft + $iDelta - 1, $oAttDef, $sTable);
}
elseif (!$oAttDef->LoadFromDB())
{
/** @var \AttributeCustomFields $oAttDef */
$oAttDef->DeleteValue($this);
}
$oAttDef->DeleteExternalValues($this);
}
$iTransactionRetry = 1;
$bIsTransactionEnabled = MetaModel::GetConfig()->Get('db_core_transactions_enabled');
@@ -4890,18 +4884,6 @@ abstract class DBObject implements iDisplay
}
$aVisited[$sClass] = $iThisId;
// Delete possible target objects
foreach (MetaModel::ListAttributeDefs($sClass) as $sAttCode => $oAttDef) {
if ($oAttDef instanceof AttributeExternalKey && $oAttDef->IsExternalKey(EXTKEY_ABSOLUTE)) {
$iOption = $oAttDef->GetDeletionOptionForTargetObject();
if ($iOption === DEL_SILENT || $iOption === DEL_AUTO) {
// Delete target object
$oTargetObject = MetaModel::GetObject($oAttDef->GetTargetClass(), $this->Get($sAttCode));
$oTargetObject->MakeDeletionPlan($oDeletionPlan, $aVisited, $iOption);
}
}
}
if ($iDeleteOption == DEL_MANUAL)
{
// Stop the recursion here

6
setup/compiler.class.inc.php
View File

@@ -3914,7 +3914,11 @@ PHP;
$aDefinition['type'] = $oNode->GetText();
}
if ($oNode = $oProperty->GetOptionalElement('default')) {
$aDefinition['default'] = $oNode->GetText();
if ($aDefinition['type'] === 'string') {
$aDefinition['default'] = $oNode->GetText('');
} else {
$aDefinition['default'] = $oNode->GetText();
}
}
return $aDefinition;