Initial commit

application/Espo/Core/ORM/Repository/HookMediator.php

@@ -0,0 +1,121 @@
+<?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\ORM\Repository;
+
+use Espo\ORM\Entity;
+use Espo\ORM\Query\Select;
+use Espo\ORM\Repository\EmptyHookMediator;
+use Espo\Core\HookManager;
+use Espo\Core\ORM\Repository\Option\SaveOption;
+
+class HookMediator extends EmptyHookMediator
+{
+    public function __construct(protected HookManager $hookManager)
+    {}
+
+    /**
+     * @param ?array<string, mixed> $columnData
+     * @param array<string, mixed> $options
+     */
+    public function afterRelate(
+        Entity $entity,
+        string $relationName,
+        Entity $foreignEntity,
+        ?array $columnData,
+        array $options
+    ): void {
+
+        if (!empty($options[SaveOption::SKIP_HOOKS])) {
+            return;
+        }
+
+        $hookData = [
+            'relationName' => $relationName,
+            'relationData' => $columnData,
+            'foreignEntity' => $foreignEntity,
+            'foreignId' => $foreignEntity->getId(),
+        ];
+
+        $this->hookManager->process(
+            $entity->getEntityType(),
+            'afterRelate',
+            $entity,
+            $options,
+            $hookData
+        );
+    }
+
+    /**
+     * @param array<string, mixed> $options
+     */
+    public function afterUnrelate(Entity $entity, string $relationName, Entity $foreignEntity, array $options): void
+    {
+        if (!empty($options[Option\SaveOption::SKIP_HOOKS])) {
+            return;
+        }
+
+        $hookData = [
+            'relationName' => $relationName,
+            'foreignEntity' => $foreignEntity,
+            'foreignId' => $foreignEntity->getId(),
+        ];
+
+        $this->hookManager->process(
+            $entity->getEntityType(),
+            'afterUnrelate',
+            $entity,
+            $options,
+            $hookData
+        );
+    }
+
+    /**
+     * @param array<string, mixed> $options
+     */
+    public function afterMassRelate(Entity $entity, string $relationName, Select $query, array $options): void
+    {
+        if (!empty($options[SaveOption::SKIP_HOOKS])) {
+            return;
+        }
+
+        $hookData = [
+            'relationName' => $relationName,
+            'query' => $query,
+        ];
+
+        $this->hookManager->process(
+            $entity->getEntityType(),
+            'afterMassRelate',
+            $entity,
+            $options,
+            $hookData
+        );
+    }
+}

application/Espo/Core/ORM/Repository/Option/RemoveOption.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\ORM\Repository\Option;
+
+/**
+ * Save options.
+ *
+ * @since 9.2.0
+ */
+class RemoveOption
+{
+    /**
+     * Silent. Boolean.
+     * Skip stream notes, notifications, webhooks.
+     */
+    public const SILENT = 'silent';
+
+    /**
+     * Called from a Record service.
+     */
+    public const API = 'api';
+
+    /**
+     * When saved in Mass-Remove.
+     */
+    public const MASS_REMOVE = 'massRemove';
+
+    /**
+     * Override modified-by. String.
+     */
+    public const MODIFIED_BY_ID = 'modifiedById';
+}

application/Espo/Core/ORM/Repository/Option/SaveContext.php

@@ -0,0 +1,162 @@
+<?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\ORM\Repository\Option;
+
+use Closure;
+use Espo\Core\Utils\Util;
+use Espo\ORM\Repository\Option\SaveOptions;
+
+/**
+ * A save context.
+ *
+ * If a save invokes another save, the context instance should not be re-used.
+ * If a save invokes a relate action, the context can be passed to that action.
+ *
+ * @since 9.1.0
+ */
+class SaveContext
+{
+    public const NAME = 'context';
+
+    private string $actionId;
+    private bool $linkUpdated = false;
+
+    /** @var Closure[] */
+    private array $deferredActions = [];
+
+    /**
+     * @param ?string $actionId An action ID.
+     */
+    public function __construct(
+        ?string $actionId = null,
+    ) {
+        $this->actionId = $actionId ?? Util::generateId();
+    }
+
+    /**
+     * An action ID. Used to group notifications. If a save invokes another save, the same ID can be re-used,
+     * but the context instance should not be re-used. Create a derived context for this.
+     *
+     * @since 9.2.0
+     */
+    public function getActionId(): string
+    {
+        return $this->actionId;
+    }
+
+    /**
+     * @deprecated Since v9.2.0. Use `getActionId`.
+     */
+    public function getId(): string
+    {
+        return $this->getActionId();
+    }
+
+    public function setLinkUpdated(): self
+    {
+        $this->linkUpdated = true;
+
+        return $this;
+    }
+
+    public function isLinkUpdated(): bool
+    {
+        return $this->linkUpdated;
+    }
+
+    /**
+     * Obtain from save options.
+     *
+     * @return ?self
+     * @since 9.2.0.
+     */
+    public static function obtainFromOptions(SaveOptions $options): ?self
+    {
+        $saveContext = $options->get(self::NAME);
+
+        if (!$saveContext instanceof self) {
+            return null;
+        }
+
+        return $saveContext;
+    }
+
+    /**
+     * Obtain from raw save options.
+     *
+     * @param array<string, mixed> $options
+     * @return ?self
+     * @since 9.2.0.
+     */
+    public static function obtainFromRawOptions(array $options): ?self
+    {
+        $saveContext = $options[self::NAME] ?? null;
+
+        if (!$saveContext instanceof self) {
+            return null;
+        }
+
+        return $saveContext;
+    }
+
+    /**
+     * Add a deferred action.
+     *
+     * @param Closure $callback A callback.
+     * @since 9.2.0.
+     */
+    public function addDeferredAction(Closure $callback): void
+    {
+        $this->deferredActions[] = $callback;
+    }
+
+    /**
+     * @internal
+     * @since 9.2.0.
+     */
+    public function callDeferredActions(): void
+    {
+        foreach ($this->deferredActions as $callback) {
+            $callback();
+        }
+
+        $this->deferredActions = [];
+    }
+
+    /**
+     * Create a derived context. To be used for nested saves.
+     *
+     * @since 9.2.0
+     */
+    public function createDerived(): self
+    {
+        return new self($this->actionId);
+    }
+}

application/Espo/Core/ORM/Repository/Option/SaveOption.php

@@ -0,0 +1,117 @@
+<?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\ORM\Repository\Option;
+
+use Espo\ORM\Repository\Option\SaveOption as BaseSaveOption;
+
+/**
+ * Save options.
+ */
+class SaveOption
+{
+    /**
+     * Silent. Boolean.
+     * Skip stream notes, notifications, webhooks.
+     */
+    public const SILENT = 'silent';
+    /**
+     * Import. Boolean.
+     */
+    public const IMPORT = 'import';
+    /**
+     * Called from a Record service.
+     * @since 8.0.1
+     */
+    public const API = 'api';
+    /**
+     * Skip all additional processing. Boolean.
+     */
+    public const SKIP_ALL = BaseSaveOption::SKIP_ALL;
+    /**
+     * Keep new. Boolean.
+     */
+    public const KEEP_NEW = BaseSaveOption::KEEP_NEW;
+    /**
+     * Keep dirty. Boolean.
+     */
+    public const KEEP_DIRTY = BaseSaveOption::KEEP_DIRTY;
+    /**
+     * Keep an entity relations map. Boolean.
+     * @since 9.0.0
+     */
+    public const KEEP_RELATIONS = BaseSaveOption::KEEP_RELATIONS;
+    /**
+     * Skip hooks. Boolean.
+     */
+    public const SKIP_HOOKS = 'skipHooks';
+    /**
+     * Skip setting created-by. Boolean.
+     */
+    public const SKIP_CREATED_BY = 'skipCreatedBy';
+    /**
+     * Skip setting modified-by. Boolean.
+     */
+    public const SKIP_MODIFIED_BY = 'skipModifiedBy';
+    /**
+     * Override created-by. String.
+     */
+    public const CREATED_BY_ID = 'createdById';
+    /**
+     * Override modified-by. String.
+     */
+    public const MODIFIED_BY_ID = 'modifiedById';
+    /**
+     * A duplicate source ID. A record that is being duplicated.
+     * @since 8.4.0
+     */
+    public const DUPLICATE_SOURCE_ID = 'duplicateSourceId';
+
+    /**
+     * When saved in Mass-Update.
+     * @since 8.4.0
+     */
+    public const MASS_UPDATE = 'massUpdate';
+    /**
+     * Skip stream notes. Boolean.
+     * @since 9.0.0
+     */
+    public const NO_STREAM = 'noStream';
+    /**
+     * Skip notification. Boolean.
+     * @since 9.0.0
+     */
+    public const NO_NOTIFICATIONS = 'noNotifications';
+
+    /**
+     * Skip audit log records.
+     * @since 9.1.0
+     */
+    public const SKIP_AUDITED = 'skipAudited';
+}