Initial commit

application/Espo/Core/Hook/Deprecations/BaseHook.php

@@ -0,0 +1,73 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2025 EspoCRM, Inc.
+ * Website: https://www.espocrm.com
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://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 Affero General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
+ * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\Core\Hook\Deprecations;
+
+use Espo\Core\Utils\Config;
+use Espo\Core\Utils\Log;
+use Espo\Entities\User;
+use Espo\ORM\EntityManager;
+
+/**
+ * For backward compatibility.
+ *
+ * @deprecated Not to be used.
+ * @todo Remove in v10.0.
+ */
+class BaseHook
+{
+    public function __construct(
+        private EntityManager $entityManager,
+        private User $user,
+        private Log $log,
+        private Config $config,
+    ) {
+        $className = get_class($this);
+
+        $message = "Important: Your hook $className extends from Espo\\Core\\Hooks\\Base. " .
+            "This class is going to be removed. You need to fix your hooks.";
+
+        $this->log->warning($message);
+    }
+
+    protected function getEntityManager(): EntityManager
+    {
+        return $this->entityManager;
+    }
+
+    protected function getUser(): User
+    {
+        return $this->user;
+    }
+
+    protected function getConfig(): Config
+    {
+        return $this->config;
+    }
+}

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-2025 EspoCRM, Inc.
+ * Website: https://www.espocrm.com
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://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 Affero General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU Affero 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-2025 EspoCRM, Inc.
+ * Website: https://www.espocrm.com
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://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 Affero General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU Affero 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 = 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,59 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2025 EspoCRM, Inc.
+ * Website: https://www.espocrm.com
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://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 Affero General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU Affero 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 = Entity
+ * @template TRelatedEntity of Entity = 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 TRelatedEntity $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-2025 EspoCRM, Inc.
+ * Website: https://www.espocrm.com
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://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 Affero General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU Affero 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 = 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-2025 EspoCRM, Inc.
+ * Website: https://www.espocrm.com
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://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 Affero General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU Affero 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 = 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,57 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2025 EspoCRM, Inc.
+ * Website: https://www.espocrm.com
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://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 Affero General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU Affero 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 = Entity
+ * @template TRelatedEntity of Entity = 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 TRelatedEntity $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-2025 EspoCRM, Inc.
+ * Website: https://www.espocrm.com
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://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 Affero General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU Affero 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 = 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-2025 EspoCRM, Inc.
+ * Website: https://www.espocrm.com
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://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 Affero General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU Affero 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 = 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;
+}