Skip to content

EspoCRM – Open Source CRM Application

entity manager before update hook

Yurii30a9d6d3e269
diff --git a/application/Espo/Core/Utils/Metadata/Builder.php b/application/Espo/Core/Utils/Metadata/Builder.php
index 2117b590b5..41c8b53b49 100644
--- a/application/Espo/Core/Utils/Metadata/Builder.php
+++ b/application/Espo/Core/Utils/Metadata/Builder.php
@@ -51,6 +51,7 @@ class Builder
['app', 'api', 'controllerActionMiddlewareClassNameListMap', self::ANY_KEY],
['app', 'entityManager', 'createHookClassNameList'],
['app', 'entityManager', 'deleteHookClassNameList'],
+ ['app', 'entityManager', 'beforeUpdateHookClassNameList'],
['app', 'entityManager', 'updateHookClassNameList'],
['app', 'linkManager', 'createHookClassNameList'],
['app', 'linkManager', 'deleteHookClassNameList'],
diff --git a/application/Espo/Tools/EntityManager/EntityManager.php b/application/Espo/Tools/EntityManager/EntityManager.php
index fe4f166de5..4c4fd9730f 100644
--- a/application/Espo/Tools/EntityManager/EntityManager.php
+++ b/application/Espo/Tools/EntityManager/EntityManager.php
@@ -417,6 +417,8 @@ class EntityManager
$entityTypeParams = new Params($name, $type, array_merge($this->getCurrentParams($name), $params));
$previousEntityTypeParams = new Params($name, $type, $this->getCurrentParams($name));
+ $this->processBeforeUpdateHook($entityTypeParams, $previousEntityTypeParams);
+
if (array_key_exists('stream', $params)) {
$this->metadata->set('scopes', $name, ['stream' => (bool) $params['stream']]);
}
@@ -675,6 +677,18 @@ class EntityManager
$this->dataManager->clearCache();
}
+ private function processBeforeUpdateHook(Params $params, Params $previousParams): void
+ {
+ /** @var class-string<UpdateHook>[] $classNameList */
+ $classNameList = $this->metadata->get(['app', 'entityManager', 'beforeUpdateHookClassNameList']) ?? [];
+
+ foreach ($classNameList as $className) {
+ $hook = $this->injectableFactory->create($className);
+
+ $hook->process($params, $previousParams);
+ }
+ }
+
private function processUpdateHook(Params $params, Params $previousParams): void
{
/** @var class-string<UpdateHook>[] $classNameList */
diff --git a/schema/metadata/app/entityManager.json b/schema/metadata/app/entityManager.json
index 52fe1b9dd8..f00955abc4 100644
--- a/schema/metadata/app/entityManager.json
+++ b/schema/metadata/app/entityManager.json
@@ -29,6 +29,18 @@
]
}
},
+ "beforeUpdateHookClassNameList": {
+ "type": "array",
+ "description": "Hooks called before updating an entity (in the Entity Manager tool). Can be used for validation purpose. Use __APPEND__ for extending. Should implement Espo\\Tools\\EntityManager\\Hook\\UpdateHook. As of v9.4.0.",
+ "items": {
+ "anyOf": [
+ {"const": "__APPEND__"},
+ {
+ "type": "string"
+ }
+ ]
+ }
+ },
"updateHookClassNameList": {
"type": "array",
"description": "Hooks called when updating an entity (in the Entity Manager tool). Use __APPEND__ for extending. Should implement Espo\\Tools\\EntityManager\\Hook\\UpdateHook.",