hook interfaces

application/Espo/Core/Hook/GeneralInvoker.php

@@ -0,0 +1,188 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM - Open Source CRM application.
+ * Copyright (C) 2014-2022 Yurii Kuznietsov, Taras Machyshyn, Oleksii Avramenko
+ * Website: https://www.espocrm.com
+ *
+ * EspoCRM is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * EspoCRM is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with EspoCRM. If not, see http://www.gnu.org/licenses/.
+ *
+ * The interactive user interfaces in modified source and object code versions
+ * of this program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU General Public License version 3,
+ * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\Core\Hook;
+
+use Espo\Core\Hook\Hook\AfterMassRelate;
+use Espo\Core\Hook\Hook\AfterRelate;
+use Espo\Core\Hook\Hook\AfterRemove;
+use Espo\Core\Hook\Hook\AfterSave;
+use Espo\Core\Hook\Hook\AfterUnrelate;
+use Espo\Core\Hook\Hook\BeforeRemove;
+use Espo\Core\Hook\Hook\BeforeSave;
+use Espo\ORM\Entity;
+use Espo\ORM\Query\Select;
+use Espo\ORM\Repository\Option\MassRelateOptions;
+use Espo\ORM\Repository\Option\RelateOptions;
+use Espo\ORM\Repository\Option\RemoveOptions;
+use Espo\ORM\Repository\Option\SaveOptions;
+use Espo\ORM\Repository\Option\UnrelateOptions;
+use LogicException;
+
+/**
+ * Invokes hook methods, prepares needed arguments for specific hooks.
+ */
+class GeneralInvoker
+{
+    private const HOOK_BEFORE_SAVE = 'beforeSave';
+    private const HOOK_AFTER_SAVE = 'afterSave';
+    private const HOOK_BEFORE_REMOVE = 'beforeRemove';
+    private const HOOK_AFTER_REMOVE = 'afterRemove';
+    private const HOOK_AFTER_RELATE = 'afterRelate';
+    private const HOOK_AFTER_UNRELATE = 'afterUnrelate';
+    private const HOOK_AFTER_MASS_RELATE = 'afterMassRelate';
+
+    /**
+     * @param object $hook A hook object.
+     * @param string $name A hook name.
+     * @param mixed $subject A subject.
+     * @param array<string, mixed> $options Options.
+     * @param array<string, mixed> $hookData Additional data.
+     */
+    public function invoke(
+        object $hook,
+        string $name,
+        mixed $subject,
+        array $options,
+        array $hookData
+    ): void {
+
+        if ($name === self::HOOK_BEFORE_SAVE && $hook instanceof BeforeSave) {
+            if (!$subject instanceof Entity) {
+                throw new LogicException();
+            }
+
+            $hook->beforeSave($subject, SaveOptions::fromAssoc($options));
+
+            return;
+        }
+
+        if ($name === self::HOOK_AFTER_SAVE && $hook instanceof AfterSave) {
+            if (!$subject instanceof Entity) {
+                throw new LogicException();
+            }
+
+            $hook->afterSave($subject, SaveOptions::fromAssoc($options));
+
+            return;
+        }
+
+        if ($name === self::HOOK_BEFORE_REMOVE &&  $hook instanceof BeforeRemove) {
+            if (!$subject instanceof Entity) {
+                throw new LogicException();
+            }
+
+            $hook->beforeRemove($subject, RemoveOptions::fromAssoc($options));
+
+            return;
+        }
+
+        if ($name === self::HOOK_AFTER_REMOVE && $hook instanceof AfterRemove) {
+            if (!$subject instanceof Entity) {
+                throw new LogicException();
+            }
+
+            $hook->afterRemove($subject, RemoveOptions::fromAssoc($options));
+
+            return;
+        }
+
+        if ($name === self::HOOK_AFTER_RELATE && $hook instanceof AfterRelate) {
+            $relationName = $hookData['relationName'] ?? null;
+            $relatedEntity = $hookData['foreignEntity'] ?? null;
+            $columnData = $hookData['relationData'] ?? [];
+
+            if (
+                !$subject instanceof Entity ||
+                !is_string($relationName) ||
+                !$relatedEntity instanceof Entity
+            ) {
+                throw new LogicException();
+            }
+
+            $hook->afterRelate(
+                $subject,
+                $relationName,
+                $relatedEntity,
+                $columnData,
+                RelateOptions::fromAssoc($options)
+            );
+
+            return;
+        }
+
+        if ($name === self::HOOK_AFTER_UNRELATE && $hook instanceof AfterUnrelate) {
+            $relationName = $hookData['relationName'] ?? null;
+            $relatedEntity = $hookData['foreignEntity'] ?? null;
+
+            if (
+                !$subject instanceof Entity ||
+                !is_string($relationName) ||
+                !$relatedEntity instanceof Entity
+            ) {
+                throw new LogicException();
+            }
+
+            $hook->afterUnrelate(
+                $subject,
+                $relationName,
+                $relatedEntity,
+                UnrelateOptions::fromAssoc($options)
+            );
+
+            return;
+        }
+
+        if ($name === self::HOOK_AFTER_MASS_RELATE && $hook instanceof AfterMassRelate) {
+            $relationName = $hookData['relationName'] ?? null;
+            $query = $hookData['query'] ?? null;
+            $columnData = $hookData['relationData'] ?? []; // Not implemented currently.
+
+            if (
+                !$subject instanceof Entity ||
+                !is_string($relationName) ||
+                !$query instanceof Select
+            ) {
+                throw new LogicException();
+            }
+
+            $hook->afterMassRelate(
+                $subject,
+                $relationName,
+                $query,
+                $columnData,
+                MassRelateOptions::fromAssoc($options)
+            );
+
+            return;
+        }
+
+        $hook->$name($subject, $options, $hookData);
+    }
+}

application/Espo/Core/Hook/Hook/AfterMassRelate.php

@@ -0,0 +1,59 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM - Open Source CRM application.
+ * Copyright (C) 2014-2022 Yurii Kuznietsov, Taras Machyshyn, Oleksii Avramenko
+ * Website: https://www.espocrm.com
+ *
+ * EspoCRM is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * EspoCRM is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with EspoCRM. If not, see http://www.gnu.org/licenses/.
+ *
+ * The interactive user interfaces in modified source and object code versions
+ * of this program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU General Public License version 3,
+ * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\Core\Hook\Hook;
+
+use Espo\ORM\Entity;
+use Espo\ORM\Query\Select;
+use Espo\ORM\Repository\Option\MassRelateOptions;
+
+/**
+ * An afterMassRelate hook.
+ *
+ * @template TEntity of Entity
+ */
+interface AfterMassRelate
+{
+    /**
+     * Processed after an entity is mass-related. Called from within a repository.
+     *
+     * @param TEntity $entity An entity.
+     * @param string $relationName A relation name.
+     * @param Select $query A select query for records to be related.
+     * @param array<string, mixed> $columnData Middle table role values.
+     * @param MassRelateOptions $options Options.
+     */
+    public function afterMassRelate(
+        Entity $entity,
+        string $relationName,
+        Select $query,
+        array $columnData,
+        MassRelateOptions $options
+    ): void;
+}

application/Espo/Core/Hook/Hook/AfterRelate.php

@@ -0,0 +1,58 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM - Open Source CRM application.
+ * Copyright (C) 2014-2022 Yurii Kuznietsov, Taras Machyshyn, Oleksii Avramenko
+ * Website: https://www.espocrm.com
+ *
+ * EspoCRM is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * EspoCRM is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with EspoCRM. If not, see http://www.gnu.org/licenses/.
+ *
+ * The interactive user interfaces in modified source and object code versions
+ * of this program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU General Public License version 3,
+ * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\Core\Hook\Hook;
+
+use Espo\ORM\Entity;
+use Espo\ORM\Repository\Option\RelateOptions;
+
+/**
+ * An afterRelate hook.
+ *
+ * @template TEntity of Entity
+ */
+interface AfterRelate
+{
+    /**
+     * Processed after an entity is related with another entity. Called from within a repository.
+     *
+     * @param TEntity $entity An entity.
+     * @param string $relationName A relation name.
+     * @param Entity $relatedEntity An entity is being related.
+     * @param array<string, mixed> $columnData Middle table role values.
+     * @param RelateOptions $options Options.
+     */
+    public function afterRelate(
+        Entity $entity,
+        string $relationName,
+        Entity $relatedEntity,
+        array $columnData,
+        RelateOptions $options
+    ): void;
+}

application/Espo/Core/Hook/Hook/AfterRemove.php

@@ -0,0 +1,49 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM - Open Source CRM application.
+ * Copyright (C) 2014-2022 Yurii Kuznietsov, Taras Machyshyn, Oleksii Avramenko
+ * Website: https://www.espocrm.com
+ *
+ * EspoCRM is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * EspoCRM is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with EspoCRM. If not, see http://www.gnu.org/licenses/.
+ *
+ * The interactive user interfaces in modified source and object code versions
+ * of this program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU General Public License version 3,
+ * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\Core\Hook\Hook;
+
+use Espo\ORM\Entity;
+use Espo\ORM\Repository\Option\RemoveOptions;
+
+/**
+ * An afterRemove hook.
+ *
+ * @template TEntity of Entity
+ */
+interface AfterRemove
+{
+    /**
+     * Processed after an entity is remove from within a repository.
+     *
+     * @param TEntity $entity An entity.
+     * @param RemoveOptions $options Options.
+     */
+    public function afterRemove(Entity $entity, RemoveOptions $options): void;
+}

application/Espo/Core/Hook/Hook/AfterSave.php

@@ -0,0 +1,49 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM - Open Source CRM application.
+ * Copyright (C) 2014-2022 Yurii Kuznietsov, Taras Machyshyn, Oleksii Avramenko
+ * Website: https://www.espocrm.com
+ *
+ * EspoCRM is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * EspoCRM is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with EspoCRM. If not, see http://www.gnu.org/licenses/.
+ *
+ * The interactive user interfaces in modified source and object code versions
+ * of this program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU General Public License version 3,
+ * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\Core\Hook\Hook;
+
+use Espo\ORM\Entity;
+use Espo\ORM\Repository\Option\SaveOptions;
+
+/**
+ * An afterSave hook.
+ *
+ * @template TEntity of Entity
+ */
+interface AfterSave
+{
+    /**
+     * Processed after an entity is saved from within a repository.
+     *
+     * @param TEntity $entity An entity.
+     * @param SaveOptions $options Save options.
+     */
+    public function afterSave(Entity $entity, SaveOptions $options): void;
+}

application/Espo/Core/Hook/Hook/AfterUnrelate.php

@@ -0,0 +1,56 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM - Open Source CRM application.
+ * Copyright (C) 2014-2022 Yurii Kuznietsov, Taras Machyshyn, Oleksii Avramenko
+ * Website: https://www.espocrm.com
+ *
+ * EspoCRM is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * EspoCRM is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with EspoCRM. If not, see http://www.gnu.org/licenses/.
+ *
+ * The interactive user interfaces in modified source and object code versions
+ * of this program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU General Public License version 3,
+ * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\Core\Hook\Hook;
+
+use Espo\ORM\Entity;
+use Espo\ORM\Repository\Option\UnrelateOptions;
+
+/**
+ * An afterUnrelate hook.
+ *
+ * @template TEntity of Entity
+ */
+interface AfterUnrelate
+{
+    /**
+     * Processed after an entity is unrelated from another entity. Called from within a repository.
+     *
+     * @param TEntity $entity An entity.
+     * @param string $relationName A relation name.
+     * @param Entity $relatedEntity An entity is being unrelated.
+     * @param UnrelateOptions $options Options.
+     */
+    public function afterUnrelate(
+        Entity $entity,
+        string $relationName,
+        Entity $relatedEntity,
+        UnrelateOptions $options
+    ): void;
+}

application/Espo/Core/Hook/Hook/BeforeRemove.php

@@ -0,0 +1,49 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM - Open Source CRM application.
+ * Copyright (C) 2014-2022 Yurii Kuznietsov, Taras Machyshyn, Oleksii Avramenko
+ * Website: https://www.espocrm.com
+ *
+ * EspoCRM is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * EspoCRM is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with EspoCRM. If not, see http://www.gnu.org/licenses/.
+ *
+ * The interactive user interfaces in modified source and object code versions
+ * of this program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU General Public License version 3,
+ * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\Core\Hook\Hook;
+
+use Espo\ORM\Entity;
+use Espo\ORM\Repository\Option\RemoveOptions;
+
+/**
+ * An beforeRemove hook.
+ *
+ * @template TEntity of Entity
+ */
+interface BeforeRemove
+{
+    /**
+     * Processed before an entity is remove from within a repository.
+     *
+     * @param TEntity $entity An entity.
+     * @param RemoveOptions $options Options.
+     */
+    public function beforeRemove(Entity $entity, RemoveOptions $options): void;
+}

application/Espo/Core/Hook/Hook/BeforeSave.php

@@ -0,0 +1,49 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM - Open Source CRM application.
+ * Copyright (C) 2014-2022 Yurii Kuznietsov, Taras Machyshyn, Oleksii Avramenko
+ * Website: https://www.espocrm.com
+ *
+ * EspoCRM is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * EspoCRM is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with EspoCRM. If not, see http://www.gnu.org/licenses/.
+ *
+ * The interactive user interfaces in modified source and object code versions
+ * of this program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU General Public License version 3,
+ * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\Core\Hook\Hook;
+
+use Espo\ORM\Entity;
+use Espo\ORM\Repository\Option\SaveOptions;
+
+/**
+ * A beforeSave hook.
+ *
+ * @template TEntity of Entity
+ */
+interface BeforeSave
+{
+    /**
+     * Processed before an entity is saved from within a repository.
+     *
+     * @param TEntity $entity An entity.
+     * @param SaveOptions $options Save options.
+     */
+    public function beforeSave(Entity $entity, SaveOptions $options): void;
+}

application/Espo/Core/HookManager.php

@@ -29,6 +29,7 @@
 
 namespace Espo\Core;
 
+use Espo\Core\Hook\GeneralInvoker;
 use Espo\Core\Utils\Config;
 use Espo\Core\Utils\DataCache;
 use Espo\Core\Utils\File\Manager as FileManager;
@@ -39,8 +40,14 @@ use Espo\Core\Utils\Util;
 
 /**
  * Runs hooks. E.g. beforeSave, afterSave. Hooks can be located in a folder
- * that matches a certain *entityType* or in the `Common` folder.
+ * that matches a certain entity type or in the `Common` folder.
  * Common hooks are applied to all entity types.
+ *
+ * - `Espo\Hooks\Common\MyHook` – a common hook;
+ * - `Espo\Hooks\{EntityType}\MyHook` – an entity type specific hook;
+ * - `Espo\Modules\{ModuleName}\Hooks\{EntityType}\MyHook` – in a module.
+ *
+ * @link https://docs.espocrm.com/development/hooks/
  */
 class HookManager
 {
@@ -68,18 +75,21 @@ class HookManager
         private Config $config,
         private DataCache $dataCache,
         private Log $log,
-        private PathProvider $pathProvider
+        private PathProvider $pathProvider,
+        private GeneralInvoker $generalInvoker
     ) {}
 
     /**
-     * @param mixed $injection
-     * @param array<string,mixed> $options
-     * @param array<string,mixed> $hookData
+     * @param string $scope A scope (entity type).
+     * @param string $hookName A hook name.
+     * @param mixed $injection A subject (usually an entity).
+     * @param array<string, mixed> $options Options.
+     * @param array<string, mixed> $hookData Additional hook data.
      */
     public function process(
         string $scope,
         string $hookName,
-        $injection = null,
+        mixed $injection = null,
         array $options = [],
         array $hookData = []
     ): void {
@@ -105,7 +115,13 @@ class HookManager
 
             $hook = $this->hooks[$className];
 
-            $hook->$hookName($injection, $options, $hookData);
+            $this->generalInvoker->invoke(
+                $hook,
+                $hookName,
+                $injection,
+                $options,
+                $hookData
+            );
         }
     }
 

application/Espo/Hooks/Common/Stream.php

@@ -29,67 +29,75 @@
 
 namespace Espo\Hooks\Common;
 
+use Espo\Core\Hook\Hook\AfterRelate;
+use Espo\Core\Hook\Hook\AfterRemove;
+use Espo\Core\Hook\Hook\AfterSave;
+use Espo\Core\Hook\Hook\AfterUnrelate;
 use Espo\Core\ORM\Repository\Option\SaveOption;
 use Espo\ORM\Entity;
+use Espo\ORM\Repository\Option\RelateOptions;
+use Espo\ORM\Repository\Option\RemoveOptions;
+use Espo\ORM\Repository\Option\SaveOptions;
+use Espo\ORM\Repository\Option\UnrelateOptions;
 use Espo\Tools\Stream\HookProcessor;
 
-class Stream
+/**
+ * @implements AfterSave<Entity>
+ * @implements AfterRemove<Entity>
+ * @implements AfterRelate<Entity>
+ * @implements AfterUnrelate<Entity>
+ */
+class Stream implements AfterSave, AfterRemove, AfterRelate, AfterUnrelate
 {
     public static int $order = 9;
 
-    private HookProcessor $processor;
+    public function __construct(private HookProcessor $processor)
+    {}
 
-    public function __construct(HookProcessor $processor)
+    public function afterSave(Entity $entity, SaveOptions $options): void
     {
-        $this->processor = $processor;
-    }
-
-    /**
-     * @param array<string,mixed> $options
-     */
-    public function afterSave(Entity $entity, array $options): void
-    {
-        if (!empty($options[SaveOption::SILENT])) {
+        if ($options->get(SaveOption::SILENT)) {
             return;
         }
 
-        $this->processor->afterSave($entity, $options);
+        $this->processor->afterSave($entity, $options->toAssoc());
     }
 
-    public function afterRemove(Entity $entity): void
+    public function afterRemove(Entity $entity, RemoveOptions $options): void
     {
+        if ($options->get(SaveOption::SILENT)) {
+            return;
+        }
+
         $this->processor->afterRemove($entity);
     }
 
-    /**
-     * @param array<string,mixed> $options
-     * @param array<string,mixed> $data
-     */
-    public function afterRelate(Entity $entity, array $options, array $data): void
-    {
-        $link = $data['relationName'] ?? null;
-        $foreignEntity = $data['foreignEntity'] ?? null;
+    public function afterRelate(
+        Entity $entity,
+        string $relationName,
+        Entity $relatedEntity,
+        array $columnData,
+        RelateOptions $options
+    ): void {
 
-        if (!$link || !$foreignEntity instanceof Entity) {
+        if ($options->get(SaveOption::SILENT)) {
             return;
         }
 
-        $this->processor->afterRelate($entity, $foreignEntity, $link, $options);
+        $this->processor->afterRelate($entity, $relatedEntity, $relationName, $options->toAssoc());
     }
 
-    /**
-     * @param array<string,mixed> $options
-     * @param array<string,mixed> $data
-     */
-    public function afterUnrelate(Entity $entity, array $options, array $data): void
-    {
-        $link = $data['relationName'] ?? null;
-        $foreignEntity = $data['foreignEntity'] ?? null;
+    public function afterUnrelate(
+        Entity $entity,
+        string $relationName,
+        Entity $relatedEntity,
+        UnrelateOptions $options
+    ): void {
 
-        if (!$link || !$foreignEntity instanceof Entity) {
+        if ($options->get(SaveOption::SILENT)) {
             return;
         }
 
-        $this->processor->afterUnrelate($entity, $foreignEntity, $link, $options);
+        $this->processor->afterUnrelate($entity, $relatedEntity, $relationName, $options->toAssoc());
     }
 }

application/Espo/ORM/Repository/Option/MassRelateOptions.php

@@ -0,0 +1,42 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM - Open Source CRM application.
+ * Copyright (C) 2014-2022 Yurii Kuznietsov, Taras Machyshyn, Oleksii Avramenko
+ * Website: https://www.espocrm.com
+ *
+ * EspoCRM is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * EspoCRM is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with EspoCRM. If not, see http://www.gnu.org/licenses/.
+ *
+ * The interactive user interfaces in modified source and object code versions
+ * of this program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU General Public License version 3,
+ * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\ORM\Repository\Option;
+
+use Espo\ORM\Repository\Option\Traits\Options;
+
+/**
+ * Mass-relate options.
+ *
+ * @immutable
+ */
+class MassRelateOptions
+{
+    use Options;
+}

application/Espo/ORM/Repository/Option/RelateOptions.php

@@ -0,0 +1,42 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM - Open Source CRM application.
+ * Copyright (C) 2014-2022 Yurii Kuznietsov, Taras Machyshyn, Oleksii Avramenko
+ * Website: https://www.espocrm.com
+ *
+ * EspoCRM is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * EspoCRM is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with EspoCRM. If not, see http://www.gnu.org/licenses/.
+ *
+ * The interactive user interfaces in modified source and object code versions
+ * of this program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU General Public License version 3,
+ * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\ORM\Repository\Option;
+
+use Espo\ORM\Repository\Option\Traits\Options;
+
+/**
+ * Relate options.
+ *
+ * @immutable
+ */
+class RelateOptions
+{
+    use Options;
+}

application/Espo/ORM/Repository/Option/RemoveOptions.php

@@ -0,0 +1,42 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM - Open Source CRM application.
+ * Copyright (C) 2014-2022 Yurii Kuznietsov, Taras Machyshyn, Oleksii Avramenko
+ * Website: https://www.espocrm.com
+ *
+ * EspoCRM is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * EspoCRM is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with EspoCRM. If not, see http://www.gnu.org/licenses/.
+ *
+ * The interactive user interfaces in modified source and object code versions
+ * of this program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU General Public License version 3,
+ * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\ORM\Repository\Option;
+
+use Espo\ORM\Repository\Option\Traits\Options;
+
+/**
+ * Remove options.
+ *
+ * @immutable
+ */
+class RemoveOptions
+{
+    use Options;
+}

application/Espo/ORM/Repository/Option/SaveOptions.php

@@ -0,0 +1,42 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM - Open Source CRM application.
+ * Copyright (C) 2014-2022 Yurii Kuznietsov, Taras Machyshyn, Oleksii Avramenko
+ * Website: https://www.espocrm.com
+ *
+ * EspoCRM is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * EspoCRM is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with EspoCRM. If not, see http://www.gnu.org/licenses/.
+ *
+ * The interactive user interfaces in modified source and object code versions
+ * of this program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU General Public License version 3,
+ * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\ORM\Repository\Option;
+
+use Espo\ORM\Repository\Option\Traits\Options;
+
+/**
+ * Save options.
+ *
+ * @immutable
+ */
+class SaveOptions
+{
+    use Options;
+}

application/Espo/ORM/Repository/Option/Traits/Options.php

@@ -0,0 +1,100 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM - Open Source CRM application.
+ * Copyright (C) 2014-2022 Yurii Kuznietsov, Taras Machyshyn, Oleksii Avramenko
+ * Website: https://www.espocrm.com
+ *
+ * EspoCRM is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * EspoCRM is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with EspoCRM. If not, see http://www.gnu.org/licenses/.
+ *
+ * The interactive user interfaces in modified source and object code versions
+ * of this program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU General Public License version 3,
+ * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\ORM\Repository\Option\Traits;
+
+trait Options
+{
+    /** @var array<string, mixed> */
+    private array $options;
+
+    /**
+     * @param array<string, mixed> $options
+     */
+    private function __construct(array $options)
+    {
+        $this->options = $options;
+    }
+
+    /**
+     * Create from an associative array.
+     *
+     * @param array<string, mixed> $options
+     */
+    public static function fromAssoc(array $options): self
+    {
+        return new self($options);
+    }
+
+    /**
+     * Get an option value. Returns `null` if not set.
+     */
+    public function get(string $option): mixed
+    {
+        return $this->options[$option] ?? null;
+    }
+
+    /**
+     * Whether an option is set.
+     */
+    public function has(string $option): bool
+    {
+        return array_key_exists($option, $this->options);
+    }
+
+    /**
+     * Clone with an option value.
+     */
+    public function with(string $option, mixed $value): self
+    {
+        $obj = clone $this;
+        $obj->options[$option] = $value;
+
+        return $obj;
+    }
+
+    /**
+     * Clone with an option removed.
+     */
+    public function without(string $option): self
+    {
+        $obj = clone $this;
+        unset($obj->options[$option]);
+
+        return $obj;
+    }
+
+    /**
+     * @return array<string, mixed>
+     */
+    public function toAssoc(): array
+    {
+        return $this->options;
+    }
+}

application/Espo/ORM/Repository/Option/UnrelateOptions.php

@@ -0,0 +1,42 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM - Open Source CRM application.
+ * Copyright (C) 2014-2022 Yurii Kuznietsov, Taras Machyshyn, Oleksii Avramenko
+ * Website: https://www.espocrm.com
+ *
+ * EspoCRM is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * EspoCRM is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with EspoCRM. If not, see http://www.gnu.org/licenses/.
+ *
+ * The interactive user interfaces in modified source and object code versions
+ * of this program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU General Public License version 3,
+ * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\ORM\Repository\Option;
+
+use Espo\ORM\Repository\Option\Traits\Options;
+
+/**
+ * Unrelate options.
+ *
+ * @immutable
+ */
+class UnrelateOptions
+{
+    use Options;
+}