composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-02-13 07:24:13 +01:00
Code Issues Packages Projects Releases Wiki Activity

N°4756 - Ease extensibility for CRUD operations

Browse Source 
- Change event order in CRUD
 - Add LinkHostObject for link update
 - Add events EVENT_SERVICE_DB_ARCHIVE and  EVENT_SERVICE_DB_UNARCHIVE
This commit is contained in:
Eric Espie
2022-07-08 10:19:54 +02:00
parent fe28319d22
commit 2c265aab44
4 changed files with 114 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
application/cmdbabstract.class.inc.php
View File

@@ -5825,4 +5825,15 @@ JS
$this->FireEvent(EVENT_SERVICE_DB_DELETE_DONE);
}
final protected function EventArchive()
{
$this->FireEvent(EVENT_SERVICE_DB_ARCHIVE);
}
final protected function EventUnarchive()
{
$this->FireEvent(EVENT_SERVICE_DB_UNARCHIVE);
}
}

32
application/datamodel.application.xml
View File

@@ -497,6 +497,38 @@
</event_datum>
</event_data>
</event>
<event id="EVENT_SERVICE_DB_ARCHIVE" _delta="define">
<description>An object has been archived</description>
<sources>
<source id="cmdbAbstractObject">cmdbAbstractObject</source>
</sources>
<event_data>
<event_datum id="object">
<description>The object archived</description>
<type>DBObject</type>
</event_datum>
<event_datum id="debug_info">
<description>Debug string</description>
<type>string</type>
</event_datum>
</event_data>
</event>
<event id="EVENT_SERVICE_DB_UNARCHIVE" _delta="define">
<description>An object has been unarchived</description>
<sources>
<source id="cmdbAbstractObject">cmdbAbstractObject</source>
</sources>
<event_data>
<event_datum id="object">
<description>The object unarchived</description>
<type>DBObject</type>
</event_datum>
<event_datum id="debug_info">
<description>Debug string</description>
<type>string</type>
</event_datum>
</event_data>
</event>
<event id="EVENT_SERVICE_DOWNLOAD_DOCUMENT" _delta="define">
<description>A document has been downloaded from the GUI</description>
<sources>

116
core/dbobject.class.php
View File

@@ -153,6 +153,9 @@ abstract class DBObject implements iDisplay
protected $m_bIsReadOnly = false;
protected $m_sReadOnlyMessage = '';
/** @var \DBObject Source object when updating links */
protected $m_oLinkHostObject = null;
/**
* DBObject constructor.
*
@@ -689,7 +692,37 @@ abstract class DBObject implements iDisplay
$this->Set($sAttCode, $sValue);
}
/**
/**
* Compute (and optionally start) the StopWatches deadlines
*
* @param string $sClass
* @param bool $bStartStopWatches
*
* @throws \ArchivedObjectException
* @throws \CoreException
* @throws \CoreUnexpectedValue
*/
private function ComputeStopWatchesDeadline(bool $bStartStopWatches)
{
$sState = $this->GetState();
if ($sState != '') {
foreach (MetaModel::ListAttributeDefs(get_class($this)) as $sAttCode => $oAttDef) {
if ($oAttDef instanceof AttributeStopWatch) {
if (in_array($sState, $oAttDef->GetStates())) {
/** @var \ormStopWatch $oSW */
$oSW = $this->Get($sAttCode);
if ($bStartStopWatches) {
$oSW->Start($this, $oAttDef);
}
$oSW->ComputeDeadlines($this, $oAttDef);
$this->Set($sAttCode, $oSW);
}
}
}
}
}
/**
* Get the label of an attribute.
*
* Shortcut to the field's AttributeDefinition->GetLabel()
@@ -2929,8 +2962,8 @@ abstract class DBObject implements iDisplay
// Ensure the update of the values (we are accessing the data directly)
$this->DoComputeValues();
$this->OnInsert();
$this->EventInsertRequested();
$this->OnInsert();
if ($this->m_iKey < 0) {
// This was a temporary "memory" key: discard it so that DBInsertSingleTable will not try to use it!
@@ -2951,23 +2984,7 @@ abstract class DBObject implements iDisplay
if (!$bRes) {
throw new CoreCannotSaveObjectException(array('issues' => $aIssues, 'class' => get_class($this), 'id' => $this->GetKey()));
}
// Stop watches
$sState = $this->GetState();
if ($sState != '') {
foreach (MetaModel::ListAttributeDefs($sClass) as $sAttCode => $oAttDef) {
if ($oAttDef instanceof AttributeStopWatch) {
if (in_array($sState, $oAttDef->GetStates())) {
// Start the stop watch and compute the deadlines
/** @var \ormStopWatch $oSW */
$oSW = $this->Get($sAttCode);
$oSW->Start($this, $oAttDef);
$oSW->ComputeDeadlines($this, $oAttDef);
$this->Set($sAttCode, $oSW);
}
}
}
}
$this->ComputeStopWatchesDeadline(true);
$this->SetReadOnly('No modification allowed during The Event :'.EVENT_SERVICE_DB_ABOUT_TO_INSERT);
$this->EventInsertBefore();
@@ -3050,9 +3067,8 @@ abstract class DBObject implements iDisplay
// Prevent DBUpdate at this point (reentrance protection)
MetaModel::StartReentranceProtection(Metamodel::REENTRANCE_TYPE_UPDATE, $this);
$this->AfterInsert();
$this->EventInsertAfter();
$this->AfterInsert();
// Activate any existing trigger
$sClass = get_class($this);
@@ -3151,27 +3167,9 @@ abstract class DBObject implements iDisplay
try
{
$this->DoComputeValues();
// Stop watches
$sState = $this->GetState();
if ($sState != '')
{
foreach (MetaModel::ListAttributeDefs($sClass) as $sAttCode => $oAttDef)
{
if ($oAttDef instanceof AttributeStopWatch)
{
if (in_array($sState, $oAttDef->GetStates()))
{
// Compute or recompute the deadlines
/** @var \ormStopWatch $oSW */
$oSW = $this->Get($sAttCode);
$oSW->ComputeDeadlines($this, $oAttDef);
$this->Set($sAttCode, $oSW);
}
}
}
}
$this->OnUpdate();
$this->ComputeStopWatchesDeadline(false);
$this->EventUpdateRequested();
$this->OnUpdate();
// Freeze the changes at this point
$this->InitPreviousValuesForUpdatedAttributes();
@@ -3364,9 +3362,8 @@ abstract class DBObject implements iDisplay
}
}
$this->AfterUpdate();
$this->EventUpdateAfter(['changes' => $aChanges]);
$this->AfterUpdate();
// - TriggerOnObjectUpdate
$aParams = array('class_list' => MetaModel::EnumParentClasses($sClass, ENUM_PARENT_CLASSES_ALL));
@@ -3606,8 +3603,8 @@ abstract class DBObject implements iDisplay
return;
}
$this->OnDelete();
$this->EventDeleteBefore();
$this->OnDelete();
// Activate any existing trigger
$sClass = get_class($this);
@@ -3717,8 +3714,8 @@ abstract class DBObject implements iDisplay
}
}
$this->AfterDelete();
$this->EventDeleteAfter();
$this->AfterDelete();
$this->m_bIsInDB = false;
@@ -3794,7 +3791,7 @@ abstract class DBObject implements iDisplay
foreach ($oDeletionPlan->ListUpdates() as $sClass => $aToUpdate)
{
foreach ($aToUpdate as $iId => $aData)
foreach ($aToUpdate as $aData)
{
$oToUpdate = $aData['to_reset'];
/** @var \DBObject $oToUpdate */
@@ -5608,6 +5605,7 @@ abstract class DBObject implements iDisplay
$this->DBWriteArchiveFlag(true);
$this->m_aCurrValues['archive_flag'] = true;
$this->m_aOrigValues['archive_flag'] = true;
$this->EventArchive();
}
/**
@@ -5621,6 +5619,7 @@ abstract class DBObject implements iDisplay
$this->m_aOrigValues['archive_flag'] = false;
$this->m_aCurrValues['archive_date'] = null;
$this->m_aOrigValues['archive_date'] = null;
$this->EventUnarchive();
}
@@ -5799,6 +5798,22 @@ abstract class DBObject implements iDisplay
return $this->m_sObjectUniqId;
}
/**
* @param \DBObject|null $m_oLinkHostObject
*/
public function SetLinkHostObject(?DBObject $m_oLinkHostObject): void
{
$this->m_oLinkHostObject = $m_oLinkHostObject;
}
/**
* @return \DBObject
*/
public function GetLinkHostObject(): ?DBObject
{
return $this->m_oLinkHostObject;
}
/**
* @param $sEvent
* @param array $aEventData
@@ -5860,5 +5875,14 @@ abstract class DBObject implements iDisplay
protected function EventDeleteAfter()
{
}
protected function EventArchive()
{
}
protected function EventUnarchive()
{
}
}

1
core/ormlinkset.class.inc.php
View File

@@ -732,6 +732,7 @@ class ormLinkSet implements iDBObjectSetIterator, Iterator, SeekableIterator
$oLink->DBClone();
}
}
$oLink->SetLinkHostObject($oHostObject);
$oLink->DBWrite();
$this->aPreserved[$oLink->GetKey()] = $oLink;