Files
espocrm/application/Espo/ORM/Repository/HookMediator.php
Yuri Kuznetsov fdb24513b5 cs
2023-04-29 10:49:25 +03:00

101 lines
3.2 KiB
PHP

<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM - Open Source CRM application.
* Copyright (C) 2014-2023 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;
use Espo\ORM\Entity;
use Espo\ORM\Query\Select;
interface HookMediator
{
/**
* @param array<string, mixed> $options
*/
public function beforeSave(Entity $entity, array $options): void;
/**
* @param array<string, mixed> $options
*/
public function afterSave(Entity $entity, array $options): void;
/**
* @param array<string, mixed> $options
*/
public function beforeRemove(Entity $entity, array $options): void;
/**
* @param array<string, mixed> $options
*/
public function afterRemove(Entity $entity, array $options): void;
/**
* @param array<string, mixed>|null $columnData Role values.
* @param array<string, mixed> $options
*/
public function beforeRelate(
Entity $entity,
string $relationName,
Entity $foreignEntity,
?array $columnData,
array $options
): void;
/**
* @param array<string, mixed>|null $columnData Role values.
* @param array<string, mixed> $options
*/
public function afterRelate(
Entity $entity,
string $relationName,
Entity $foreignEntity,
?array $columnData,
array $options
): void;
/**
* @param array<string, mixed> $options
*/
public function beforeUnrelate(Entity $entity, string $relationName, Entity $foreignEntity, array $options): void;
/**
* @param array<string, mixed> $options
*/
public function afterUnrelate(Entity $entity, string $relationName, Entity $foreignEntity, array $options): void;
/**
* @param array<string, mixed> $options
*/
public function beforeMassRelate(Entity $entity, string $relationName, Select $query, array $options): void;
/**
* @param array<string, mixed> $options
*/
public function afterMassRelate(Entity $entity, string $relationName, Select $query, array $options): void;
}