N°8210 - Remove iApplicationObjectExtension

Author: bdalsass

application/applicationextension.inc.php

@@ -553,173 +553,6 @@ public function EnumAllowedActions(DBObjectSet $oSet)
 
 }
 
-/**
- * Implement this interface to perform specific operations when objects are manipulated
- *
- * Note that those methods will be called when objects are manipulated, either in a programmatic way
- * or through the GUI.
- *
- * @api
- * @deprecated  3.1.0 N°4756 use the new event service instead, see {@see DBObject::FireEvent()} method. More details on each method PHPDoc.
- * @package     ORMExtensibilityAPI
- */
-interface iApplicationObjectExtension
-{
-	/**
-	 * Invoked to determine whether an object has been modified in memory
-	 *
-	 * The GUI calls this verb to determine the message that will be displayed to the end-user.
-	 * Anyhow, this API can be called in other contexts such as the CSV import tool.
-	 *
-	 * If the extension returns false, then the framework will perform the usual evaluation.
-	 * Otherwise, the answer is definitively "yes, the object has changed".
-	 *
-	 * @api
-	 * @deprecated 3.1.0 N°4756 No alternative available, this API was unstable and is abandoned
-	 * @param \cmdbAbstractObject $oObject The target object
-	 *
-	 * @return boolean True if something has changed for the target object
-	 */
-	public function OnIsModified($oObject);
-
-	/**
-	 * Invoked to determine whether an object can be written to the database
-	 *
-	 * The GUI calls this verb and reports any issue.
-	 * Anyhow, this API can be called in other contexts such as the CSV import tool.
-	 *
-	 * @api
-	 * @deprecated 3.1.0 N°4756 Use EVENT_DB_CHECK_TO_WRITE event instead
-	 * @param \cmdbAbstractObject $oObject The target object
-	 *
-	 * @return string[] A list of errors message. An error message is made of one line and it can be displayed to the end-user.
-	 */
-	public function OnCheckToWrite($oObject);
-
-	/**
-	 * Invoked to determine wether an object can be deleted from the database
-	 *
-	 * The GUI calls this verb and stops the deletion process if any issue is reported.
-	 *
-	 * Please not that it is not possible to cascade deletion by this mean: only stopper issues can be handled.
-	 *
-	 * @api
-	 * @deprecated 3.1.0 N°4756 Use EVENT_DB_CHECK_TO_DELETE event instead
-	 * @param \cmdbAbstractObject $oObject The target object
-	 *
-	 * @return string[] A list of errors message. An error message is made of one line and it can be displayed to the end-user.
-	 */
-	public function OnCheckToDelete($oObject);
-
-	/**
-	 * Invoked when an object is updated into the database. The method is called right <b>after</b> the object has been written to the
-	 * database.
-	 *
-	 * Useful methods you can call on $oObject :
-	 *
-	 * * {@see DBObject::ListPreviousValuesForUpdatedAttributes()} : list of changed attributes and their values before the change
-	 * * {@see DBObject::Get()} : for a given attribute the new value that was persisted
-	 *
-	 * @api
-	 * @deprecated 3.1.0 N°4756 Use EVENT_DB_AFTER_WRITE event instead
-	 * @param \cmdbAbstractObject $oObject The target object
-	 * @param CMDBChange|null $oChange A change context. Since 2.0 it is fine to ignore it, as the framework does maintain this information
-	 *     once for all the changes made within the current page
-	 *
-	 * @return void
-	 *
-	 * @since 2.7.0 N°2293 can access object changes by calling {@see DBObject::ListPreviousValuesForUpdatedAttributes()} on $oObject
-	 */
-	public function OnDBUpdate($oObject, $oChange = null);
-
-	/**
-	 * Invoked when an object is created into the database
-	 *
-	 * The method is called right <b>after</b> the object has been written to the database.
-	 *
-	 * @api
-	 * @deprecated 3.1.0 N°4756 Use EVENT_DB_AFTER_WRITE event instead
-	 * @param \cmdbAbstractObject $oObject The target object
-	 * @param CMDBChange|null $oChange A change context. Since 2.0 it is fine to ignore it, as the framework does maintain this information
-	 *     once for all the changes made within the current page
-	 *
-	 * @return void
-	 */
-	public function OnDBInsert($oObject, $oChange = null);
-
-	/**
-	 * Invoked when an object is deleted from the database
-	 *
-	 * The method is called right <b>before</b> the object will be deleted from the database.
-	 *
-	 * @api
-	 * @deprecated 3.1.0 N°4756 Use EVENT_DB_AFTER_DELETE event instead
-	 * @param \cmdbAbstractObject $oObject The target object
-	 * @param CMDBChange|null $oChange A change context. Since 2.0 it is fine to ignore it, as the framework does maintain this information
-	 *     once for all the changes made within the current page
-	 *
-	 * @return void
-	 */
-	public function OnDBDelete($oObject, $oChange = null);
-}
-
-/**
- * Extend this class instead of iApplicationObjectExtension if you don't need to overload all methods
- *
- * @api
- * @deprecated  3.1.0 N°4756 use the new event service instead, see {@see DBObject::FireEvent()} method
- * @package     ORMExtensibilityAPI
- * @since       2.7.0
- */
-abstract class AbstractApplicationObjectExtension implements iApplicationObjectExtension
-{
-	/**
-	 * @inheritDoc
-	 */
-	public function OnIsModified($oObject)
-	{
-		return false;
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function OnCheckToWrite($oObject)
-	{
-		return array();
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function OnCheckToDelete($oObject)
-	{
-		return array();
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function OnDBUpdate($oObject, $oChange = null)
-	{
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function OnDBInsert($oObject, $oChange = null)
-	{
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function OnDBDelete($oObject, $oChange = null)
-	{
-	}
-
-}
-
 /**
  * New extension to add menu items in the "popup" menus inside iTop. Provides a greater flexibility than
  * iApplicationUIExtension::EnumAllowedActions.

application/cmdbabstract.class.inc.php

@@ -4542,21 +4542,6 @@ public function DBInsertNoReload()
 		return $res;
 	}
 
-	protected function PostInsertActions(): void
-	{
-		parent::PostInsertActions();
-
-		// Invoke extensions after insertion (the object must exist, have an id, etc.)
-		/** @var \iApplicationObjectExtension $oExtensionInstance */
-		foreach (MetaModel::EnumPlugins(iApplicationObjectExtension::class) as $oExtensionInstance) {
-			$sExtensionClass = get_class($oExtensionInstance);
-			$this->LogCRUDDebug(__METHOD__, "Calling $sExtensionClass::OnDBInsert()");
-			$oKPI = new ExecutionKPI();
-			$oExtensionInstance->OnDBInsert($this, self::GetCurrentChange());
-			$oKPI->ComputeStatsForExtension($oExtensionInstance, 'OnDBInsert');
-		}
-	}
-
 	/**
 	 * @inheritdoc
 	 * Attaches InlineImages to the current object
@@ -4589,21 +4574,6 @@ public function DBUpdate()
 		return $res;
 	}
 
-	protected function PostUpdateActions(array $aChanges): void
-	{
-		parent::PostUpdateActions($aChanges);
-
-		// Invoke extensions after the update (could be before)
-		/** @var \iApplicationObjectExtension $oExtensionInstance */
-		foreach (MetaModel::EnumPlugins(iApplicationObjectExtension::class) as $oExtensionInstance) {
-			$sExtensionClass = get_class($oExtensionInstance);
-			$this->LogCRUDDebug(__METHOD__, "Calling $sExtensionClass::OnDBUpdate()");
-			$oKPI = new ExecutionKPI();
-			$oExtensionInstance->OnDBUpdate($this, self::GetCurrentChange());
-			$oKPI->ComputeStatsForExtension($oExtensionInstance, 'OnDBUpdate');
-		}
-	}
-
 	/**
 	 * @param string $sMessageIdPrefix
 	 *
@@ -4639,21 +4609,6 @@ public function DBDelete(&$oDeletionPlan = null)
 		return $oDeletionPlan;
 	}
 
-	final protected function PreDeleteActions(): void
-	{
-		/** @var \iApplicationObjectExtension $oExtensionInstance */
-		foreach(MetaModel::EnumPlugins('iApplicationObjectExtension') as $oExtensionInstance)
-		{
-			$sExtensionClass = get_class($oExtensionInstance);
-			$this->LogCRUDDebug(__METHOD__, "Calling $sExtensionClass::OnDBDelete()");
-			$oKPI = new ExecutionKPI();
-			$oExtensionInstance->OnDBDelete($this, self::GetCurrentChange());
-			$oKPI->ComputeStatsForExtension($oExtensionInstance, 'OnDBDelete');
-		}
-
-		parent::PreDeleteActions();
-	}
-
 	final protected function PostDeleteActions(): void
 	{
 		parent::PostDeleteActions();
@@ -4666,24 +4621,6 @@ public function IsModified()
 			return true;
 		}
 
-		// Plugins
-		//
-		/** @var \iApplicationObjectExtension $oExtensionInstance */
-		foreach(MetaModel::EnumPlugins('iApplicationObjectExtension') as $oExtensionInstance)
-		{
-			$sExtensionClass = get_class($oExtensionInstance);
-			$this->LogCRUDDebug(__METHOD__, "Calling $sExtensionClass::OnIsModified()");
-			$oKPI = new ExecutionKPI();
-			$bIsModified = $oExtensionInstance->OnIsModified($this);
-			$oKPI->ComputeStatsForExtension($oExtensionInstance, 'OnIsModified');
-			if ($bIsModified) {
-				$this->LogCRUDDebug(__METHOD__, "Calling $sExtensionClass::OnIsModified() -> true");
-				return true;
-			} else {
-				$this->LogCRUDDebug(__METHOD__, "Calling $sExtensionClass::OnIsModified() -> false");
-			}
-		}
-
 		return false;
 	}
 
@@ -4698,7 +4635,7 @@ public function AllowWrite($bAllow = true)
 	}
 
 	/**
-	 * Whether to bypass the checks of user rights when writing this object, could be used in {@link \iApplicationObjectExtension::OnCheckToWrite()}
+	 * Whether to bypass the checks of user rights when writing this object
 	 *
 	 * @return bool
 	 */
@@ -4727,22 +4664,6 @@ public function DoCheckToWrite()
 	{
 		parent::DoCheckToWrite();
 
-		// Plugins
-		//
-		/** @var \iApplicationObjectExtension $oExtensionInstance */
-		foreach(MetaModel::EnumPlugins('iApplicationObjectExtension') as $oExtensionInstance)
-		{
-			$sExtensionClass = get_class($oExtensionInstance);
-			$this->LogCRUDDebug(__METHOD__, "Calling $sExtensionClass::OnCheckToWrite()");
-            $oKPI = new ExecutionKPI();
-			$aNewIssues = $oExtensionInstance->OnCheckToWrite($this);
-            $oKPI->ComputeStatsForExtension($oExtensionInstance, 'OnCheckToWrite');
-			if (is_array($aNewIssues) && (count($aNewIssues) > 0)) // Some extensions return null instead of an empty array
-			{
-				$this->m_aCheckIssues = array_merge($this->m_aCheckIssues, $aNewIssues);
-			}
-		}
-
 		// User rights
 		//
 		if (!$this->bAllowWrite)
@@ -4779,22 +4700,6 @@ protected function DoCheckToDelete(&$oDeletionPlan)
 	{
 		parent::DoCheckToDelete($oDeletionPlan);
 
-		// Plugins
-		//
-		/** @var \iApplicationObjectExtension $oExtensionInstance */
-		foreach(MetaModel::EnumPlugins('iApplicationObjectExtension') as $oExtensionInstance)
-		{
-			$sExtensionClass = get_class($oExtensionInstance);
-			$this->LogCRUDDebug(__METHOD__, "Calling $sExtensionClass::OnCheckToDelete()");
-            $oKPI = new ExecutionKPI();
-			$aNewIssues = $oExtensionInstance->OnCheckToDelete($this);
-            $oKPI->ComputeStatsForExtension($oExtensionInstance, 'OnCheckToDelete');
-			if (is_array($aNewIssues) && count($aNewIssues) > 0)
-			{
-				$this->m_aDeleteIssues = array_merge($this->m_aDeleteIssues, $aNewIssues);
-			}
-		}
-
 		// User rights
 		//
 		if (! $this->bAllowDelete)

core/metamodel.class.php

@@ -7709,7 +7709,6 @@ public static function InitExtensions()
 			'iLoginUIExtension',
 			'iPreferencesExtension',
 			'iApplicationUIExtension',
-			'iApplicationObjectExtension',
 			'iPopupMenuExtension',
 			'iPageUIBlockExtension',
 			'iBackofficeLinkedScriptsExtension',