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

N°4756 - Ease extensibility for CRUD operations : Events renamed

Browse Source
This commit is contained in:
Eric Espie
2022-12-22 15:16:52 +01:00
parent eff2afbc69
commit 44fac686f9
4 changed files with 455 additions and 193 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -5661,31 +5661,160 @@ JS
);
}
//////////////////
/// CREATE
///
/**
* @inheritDoc
* @throws \CoreException
* @since 3.1.0
*/
final protected function EventInsertRequested(): void
final protected function EventCreateComputeValues(): void
{
$this->FireEvent(EVENT_SERVICE_DB_INSERT_REQUESTED);
$this->FireEvent(EVENT_DB_CREATE_COMPUTE_VALUES);
}
/**
* @inheritDoc
* @throws \CoreException
* @since 3.1.0
*/
final protected function EventInsertBefore(): void
final protected function EventCreateRequested(): void
{
$this->FireEvent(EVENT_SERVICE_DB_ABOUT_TO_INSERT);
$this->FireEvent(EVENT_DB_CREATE_REQUESTED);
}
/**
* @inheritDoc
* @throws \CoreException
* @since 3.1.0
*/
final protected function EventInsertAfter(): void
final protected function EventCheckToCreate(): void
{
$this->FireEvent(EVENT_SERVICE_DB_INSERT_DONE);
$this->FireEvent(EVENT_DB_CHECK_TO_CREATE);
}
/**
* @inheritDoc
* @since 3.1.0
*/
final protected function EventCheckToCreateFailed(array $aData): void
{
$this->FireEvent(EVENT_DB_CHECK_TO_CREATE_FAILED, $aData);
}
/**
* @inheritDoc
* @since 3.1.0
*/
final protected function EventAboutToCreate(): void
{
$this->FireEvent(EVENT_DB_ABOUT_TO_CREATE);
}
/**
* @inheritDoc
* @since 3.1.0
*/
final protected function EventCreateDone(): void
{
$this->FireEvent(EVENT_DB_CREATE_DONE);
}
/////////////
/// UPDATE
///
/**
* @inheritDoc
* @since 3.1.0
*/
final protected function EventUpdateComputeValues(): void
{
$this->FireEvent(EVENT_DB_UPDATE_COMPUTE_VALUES);
}
/**
* @inheritDoc
* @since 3.1.0
*/
final protected function EventUpdateRequested(): void
{
$this->FireEvent(EVENT_DB_UPDATE_REQUESTED);
}
/**
* @inheritDoc
* @since 3.1.0
*/
final protected function EventCheckToUpdate(): void
{
$this->FireEvent(EVENT_DB_CHECK_TO_UPDATE);
}
/**
* @inheritDoc
* @since 3.1.0
*/
final protected function EventCheckToUpdateFailed(array $aData): void
{
$this->FireEvent(EVENT_DB_CHECK_TO_UPDATE_FAILED, $aData);
}
/**
* @inheritDoc
* @since 3.1.0
*/
final protected function EventAboutToUpdate(): void
{
$this->FireEvent(EVENT_DB_ABOUT_TO_UPDATE);
}
/**
* @inheritDoc
* @since 3.1.0
*/
final protected function EventUpdateDone(array $aData): void
{
$this->FireEvent(EVENT_DB_UPDATE_DONE, $aData);
}
//////////////
/// DELETE
///
/**
* @inheritDoc
* @since 3.1.0
*/
final protected function EventCheckToDelete(): void
{
$this->FireEvent(EVENT_DB_CHECK_TO_DELETE);
}
/**
* @inheritDoc
* @since 3.1.0
*/
final protected function EventCheckToDeleteFailed(array $aData): void
{
$this->FireEvent(EVENT_DB_CHECK_TO_DELETE_FAILED, $aData);
}
/**
* @inheritDoc
* @since 3.1.0
*/
final protected function EventAboutToDelete(): void
{
$this->FireEvent(EVENT_DB_ABOUT_TO_DELETE);
}
/**
* @inheritDoc
* @since 3.1.0
*/
final protected function EventDeleteDone(): void
{
$this->FireEvent(EVENT_DB_DELETE_DONE);
}
/**
@@ -5694,70 +5823,7 @@ JS
*/
final protected function EventComputeValues(): void
{
$this->FireEvent(EVENT_SERVICE_DB_COMPUTE_VALUES);
}
/**
* @inheritDoc
* @throws \CoreException
*/
final protected function EventCheckToWrite(): void
{
$this->FireEvent(EVENT_SERVICE_DB_CHECK_TO_WRITE);
}
/**
* @inheritDoc
* @throws \CoreException
*/
final protected function EventCheckToDelete(): void
{
$this->FireEvent(EVENT_SERVICE_DB_CHECK_TO_DELETE);
}
/**
* @inheritDoc
* @throws \CoreException
*/
final protected function EventUpdateRequested(): void
{
$this->FireEvent(EVENT_SERVICE_DB_UPDATE_REQUESTED);
}
/**
* @inheritDoc
* @throws \CoreException
*/
final protected function EventUpdateBefore(): void
{
$this->FireEvent(EVENT_SERVICE_DB_ABOUT_TO_UPDATE);
}
/**
* @inheritDoc
* @throws \CoreException
*/
final protected function EventUpdateAfter(array $aEventData): void
{
$this->FireEvent(EVENT_SERVICE_DB_UPDATE_DONE, $aEventData);
}
/**
* @inheritDoc
* @throws \CoreException
*/
final protected function EventDeleteBefore(): void
{
$this->FireEvent(EVENT_SERVICE_DB_ABOUT_TO_DELETE);
}
/**
* @inheritDoc
* @throws \CoreException
*/
final protected function EventDeleteAfter(): void
{
$this->FireEvent(EVENT_SERVICE_DB_DELETE_DONE);
$this->FireEvent(EVENT_DB_COMPUTE_VALUES);
}
/**
@@ -5766,21 +5832,22 @@ JS
*/
final protected function EventArchive(): void
{
$this->FireEvent(EVENT_SERVICE_DB_ARCHIVE);
$this->FireEvent(EVENT_DB_ARCHIVE);
}
/**
* @inheritDoc
* @throws \CoreException
*/
final protected function EventUnarchive(): void
final protected function EventUnArchive(): void
{
$this->FireEvent(EVENT_SERVICE_DB_UNARCHIVE);
$this->FireEvent(EVENT_DB_UNARCHIVE);
}
/**
* Append $iFlags to $sAttCode attribute in $sTargetState
*
* @api
* @param string $sAttCode
* @param int $iFlags
* @param string $sTargetState
@@ -5803,6 +5870,7 @@ JS
/**
* Force $iFlags to $sAttCode attribute in $sTargetState
*
* @api
* @param string $sAttCode
* @param int $iFlags
* @param string $sTargetState
@@ -5833,7 +5901,7 @@ JS
$aEventData = [
'target_state' => $sTargetState,
];
$this->FireEvent(EVENT_SERVICE_DB_SET_ATTRIBUTES_FLAGS, $aEventData);
$this->FireEvent(EVENT_DB_SET_ATTRIBUTES_FLAGS, $aEventData);
}
$iFlags = $this->aAttributesFlags[$sTargetState][$sAttCode]['flags'] ?? 0;
$aReasons += ($this->aAttributesFlags[$sTargetState][$sAttCode]['reasons'] ?? []);
@@ -5845,6 +5913,7 @@ JS
/**
* Append $iFlags to $sAttCode attribute in initial state
*
* @api
* @param string $sAttCode
* @param int $iFlags
* @param string|null $sReason
@@ -5866,6 +5935,7 @@ JS
/**
* Force $iFlags to $sAttCode attribute in initial state
*
* @api
* @param string $sAttCode
* @param int $iFlags
* @param string|null $sReason
@@ -5892,7 +5962,7 @@ JS
{
if (!isset($this->aInitialAttributesFlags)) {
$this->aInitialAttributesFlags = [];
$this->FireEvent(EVENT_SERVICE_DB_SET_INITIAL_ATTRIBUTES_FLAGS);
$this->FireEvent(EVENT_DB_SET_INITIAL_ATTRIBUTES_FLAGS);
}
$iFlags = $this->aInitialAttributesFlags[$sAttCode]['flags'] ?? 0;
$aReasons += ($this->aInitialAttributesFlags[$sAttCode]['reasons'] ?? []);

224
application/datamodel.application.xml
View File

@@ -186,8 +186,25 @@
</menu>
</menus>
<events>
<event id="EVENT_SERVICE_DB_INSERT_REQUESTED" _delta="define">
<description>An object insert in the database has been requested. All changes to the object will be persisted automatically.</description>
<event id="EVENT_DB_CREATE_COMPUTE_VALUES" _delta="define">
<description>An object needs to be recomputed after changes</description>
<sources>
<source id="cmdbAbstractObject">cmdbAbstractObject</source>
</sources>
<replaces>DBObject::ComputeValues</replaces>
<event_data>
<event_datum id="object">
<description>The object inserted</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_DB_CREATE_REQUESTED" _delta="define">
<description>An object create in the database has been requested. All changes to the object will be persisted automatically.</description>
<sources>
<source id="cmdbAbstractObject">cmdbAbstractObject</source>
</sources>
@@ -203,8 +220,46 @@
</event_datum>
</event_data>
</event>
<event id="EVENT_SERVICE_DB_ABOUT_TO_INSERT" _delta="define">
<description>An object is about to be inserted in the database (no change possible)</description>
<event id="EVENT_DB_CHECK_TO_CREATE" _delta="define">
<description>Check an object before it is created into the database (no change possible). Call DBObject::AddCheckIssue() to signal an issue</description>
<sources>
<source id="cmdbAbstractObject">cmdbAbstractObject</source>
</sources>
<replaces>cmdbAbstractObject::DoCheckToWrite</replaces>
<event_data>
<event_datum id="object">
<description>The object to check</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_DB_CHECK_TO_CREATE_FAILED" _delta="define">
<description>A check has failed, it is not possible to create the object</description>
<sources>
<source id="cmdbAbstractObject">cmdbAbstractObject</source>
</sources>
<replaces>cmdbAbstractObject::DoCheckToWrite</replaces>
<event_data>
<event_datum id="check_issues">
<description>Array of the issues (string) that prevented the object creation</description>
<type>array</type>
</event_datum>
<event_datum id="object">
<description>The object to check</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_DB_ABOUT_TO_CREATE" _delta="define">
<description>An object is about to be created in the database (no change possible)</description>
<sources>
<source id="cmdbAbstractObject">cmdbAbstractObject</source>
</sources>
@@ -220,8 +275,8 @@
</event_datum>
</event_data>
</event>
<event id="EVENT_SERVICE_DB_INSERT_DONE" _delta="define">
<description>An object has been inserted into the database (but not reloaded). All changes to the object will be persisted automatically.</description>
<event id="EVENT_DB_CREATE_DONE" _delta="define">
<description>An object has been created into the database. The modifications can be propagated to other objects.</description>
<sources>
<source id="cmdbAbstractObject">cmdbAbstractObject</source>
</sources>
@@ -237,7 +292,24 @@
</event_datum>
</event_data>
</event>
<event id="EVENT_SERVICE_DB_UPDATE_REQUESTED" _delta="define">
<event id="EVENT_DB_UPDATE_COMPUTE_VALUES" _delta="define">
<description>An object needs to be recomputed after changes</description>
<sources>
<source id="cmdbAbstractObject">cmdbAbstractObject</source>
</sources>
<replaces>DBObject::ComputeValues</replaces>
<event_data>
<event_datum id="object">
<description>The object inserted</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_DB_UPDATE_REQUESTED" _delta="define">
<description>An object update has been requested. All changes to the object will be persisted automatically.</description>
<sources>
<source id="cmdbAbstractObject">cmdbAbstractObject</source>
@@ -254,7 +326,45 @@
</event_datum>
</event_data>
</event>
<event id="EVENT_SERVICE_DB_ABOUT_TO_UPDATE" _delta="define">
<event id="EVENT_DB_CHECK_TO_UPDATE" _delta="define">
<description>Check an object before it is written into the database (no change possible). Call DBObject::AddCheckIssue() to signal an issue</description>
<sources>
<source id="cmdbAbstractObject">cmdbAbstractObject</source>
</sources>
<replaces>cmdbAbstractObject::DoCheckToWrite</replaces>
<event_data>
<event_datum id="object">
<description>The object to check</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_DB_CHECK_TO_UPDATE_FAILED" _delta="define">
<description>A check has failed, it is not possible to update the object</description>
<sources>
<source id="cmdbAbstractObject">cmdbAbstractObject</source>
</sources>
<replaces>cmdbAbstractObject::DoCheckToWrite</replaces>
<event_data>
<event_datum id="check_issues">
<description>Array of the issues (string) that prevented the object update</description>
<type>array</type>
</event_datum>
<event_datum id="object">
<description>The object to check</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_DB_ABOUT_TO_UPDATE" _delta="define">
<description>An object is about to be updated in the database (no change possible)</description>
<sources>
<source id="cmdbAbstractObject">cmdbAbstractObject</source>
@@ -271,8 +381,8 @@
</event_datum>
</event_data>
</event>
<event id="EVENT_SERVICE_DB_UPDATE_DONE" _delta="define">
<description>An object has been updated into the database and reloaded. All changes to the object will be persisted automatically.</description>
<event id="EVENT_DB_UPDATE_DONE" _delta="define">
<description>An object has been updated into the database and reloaded.</description>
<sources>
<source id="cmdbAbstractObject">cmdbAbstractObject</source>
</sources>
@@ -288,7 +398,45 @@
</event_datum>
</event_data>
</event>
<event id="EVENT_SERVICE_DB_ABOUT_TO_DELETE" _delta="define">
<event id="EVENT_DB_CHECK_TO_DELETE" _delta="define">
<description>Check an object before it is deleted from the database. Call DBObject::AddDeleteIssue() to signal an issue</description>
<sources>
<source id="cmdbAbstractObject">cmdbAbstractObject</source>
</sources>
<replaces>cmdbAbstractObject::DoCheckToDelete</replaces>
<event_data>
<event_datum id="object">
<description>The object to check</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_DB_CHECK_TO_DELETE_FAILED" _delta="define">
<description>A check has failed, it is not possible to delete the object</description>
<sources>
<source id="cmdbAbstractObject">cmdbAbstractObject</source>
</sources>
<replaces>cmdbAbstractObject::DoCheckToWrite</replaces>
<event_data>
<event_datum id="check_issues">
<description>Array of the issues (string) that prevented the object deletion</description>
<type>array</type>
</event_datum>
<event_datum id="object">
<description>The object to check</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_DB_ABOUT_TO_DELETE" _delta="define">
<description>An object is about to be deleted in the database</description>
<sources>
<source id="cmdbAbstractObject">cmdbAbstractObject</source>
@@ -305,7 +453,7 @@
</event_datum>
</event_data>
</event>
<event id="EVENT_SERVICE_DB_DELETE_DONE" _delta="define">
<event id="EVENT_DB_DELETE_DONE" _delta="define">
<description>An object has been deleted into the database</description>
<sources>
<source id="cmdbAbstractObject">cmdbAbstractObject</source>
@@ -322,7 +470,7 @@
</event_datum>
</event_data>
</event>
<event id="EVENT_SERVICE_DB_BEFORE_APPLY_STIMULUS" _delta="define">
<event id="EVENT_DB_BEFORE_APPLY_STIMULUS" _delta="define">
<description>A stimulus is about to be applied to an object</description>
<sources>
<source id="cmdbAbstractObject">cmdbAbstractObject</source>
@@ -354,7 +502,7 @@
</event_datum>
</event_data>
</event>
<event id="EVENT_SERVICE_DB_AFTER_APPLY_STIMULUS" _delta="define">
<event id="EVENT_DB_AFTER_APPLY_STIMULUS" _delta="define">
<description>A stimulus has been applied to an object</description>
<sources>
<source id="cmdbAbstractObject">cmdbAbstractObject</source>
@@ -386,7 +534,7 @@
</event_datum>
</event_data>
</event>
<event id="EVENT_SERVICE_DB_APPLY_STIMULUS_FAILED" _delta="define">
<event id="EVENT_DB_APPLY_STIMULUS_FAILED" _delta="define">
<description>A stimulus has failed</description>
<sources>
<source id="cmdbAbstractObject">cmdbAbstractObject</source>
@@ -422,7 +570,7 @@
</event_datum>
</event_data>
</event>
<event id="EVENT_SERVICE_DB_OBJECT_RELOAD" _delta="define">
<event id="EVENT_DB_OBJECT_RELOAD" _delta="define">
<description>An object has been re-loaded from the database</description>
<sources>
<source id="cmdbAbstractObject">cmdbAbstractObject</source>
@@ -438,7 +586,7 @@
</event_datum>
</event_data>
</event>
<event id="EVENT_SERVICE_DB_COMPUTE_VALUES" _delta="define">
<event id="EVENT_DB_COMPUTE_VALUES" _delta="define">
<description>An object needs to be recomputed after changes</description>
<sources>
<source id="cmdbAbstractObject">cmdbAbstractObject</source>
@@ -455,41 +603,7 @@
</event_datum>
</event_data>
</event>
<event id="EVENT_SERVICE_DB_CHECK_TO_WRITE" _delta="define">
<description>Check an object before it is written into the database (no change possible). Call DBObject::AddCheckIssue() to signal an issue</description>
<sources>
<source id="cmdbAbstractObject">cmdbAbstractObject</source>
</sources>
<replaces>cmdbAbstractObject::DoCheckToWrite</replaces>
<event_data>
<event_datum id="object">
<description>The object to check</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_CHECK_TO_DELETE" _delta="define">
<description>Check an object before it is deleted from the database (no change possible). Call DBObject::AddDeleteIssue() to signal an issue</description>
<sources>
<source id="cmdbAbstractObject">cmdbAbstractObject</source>
</sources>
<replaces>cmdbAbstractObject::DoCheckToDelete</replaces>
<event_data>
<event_datum id="object">
<description>The object to check</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_ARCHIVE" _delta="define">
<event id="EVENT_DB_ARCHIVE" _delta="define">
<description>An object has been archived</description>
<sources>
<source id="cmdbAbstractObject">cmdbAbstractObject</source>
@@ -505,7 +619,7 @@
</event_datum>
</event_data>
</event>
<event id="EVENT_SERVICE_DB_UNARCHIVE" _delta="define">
<event id="EVENT_DB_UNARCHIVE" _delta="define">
<description>An object has been unarchived</description>
<sources>
<source id="cmdbAbstractObject">cmdbAbstractObject</source>
@@ -521,7 +635,7 @@
</event_datum>
</event_data>
</event>
<event id="EVENT_SERVICE_DB_SET_ATTRIBUTES_FLAGS" _delta="define">
<event id="EVENT_DB_SET_ATTRIBUTES_FLAGS" _delta="define">
<description>Set object attributes flags. Call cmdbAbstractObject::AddAttributeFlags() for all the attributes to be set for this target state.</description>
<sources>
<source id="cmdbAbstractObject">cmdbAbstractObject</source>
@@ -541,7 +655,7 @@
</event_datum>
</event_data>
</event>
<event id="EVENT_SERVICE_DB_SET_INITIAL_ATTRIBUTES_FLAGS" _delta="define">
<event id="EVENT_DB_SET_INITIAL_ATTRIBUTES_FLAGS" _delta="define">
<description>Set object initial attributes flags. Call cmdbAbstractObject::AddInitialAttributeFlags() for all the initial attributes to be set initially.</description>
<sources>
<source id="cmdbAbstractObject">cmdbAbstractObject</source>