Files
espocrm/application/Espo/ORM/Repository/Repository.php
Yuri Kuznetsov a5dc3aae70 fix phpdoc
2022-12-04 14:09:27 +02:00

71 lines
2.1 KiB
PHP

<?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;
use Espo\ORM\Entity;
/**
* An access point for fetching and storing records.
*
* @template TEntity of Entity
*/
interface Repository
{
/**
* Get a new entity.
*
* @return TEntity
*/
public function getNew(): Entity;
/**
* Fetch an entity by ID.
*
* @return ?TEntity
*/
public function getById(string $id): ?Entity;
/**
* Store an entity.
*
* @param TEntity $entity
* @param array<string,mixed> $options
*/
public function save(Entity $entity, array $options = []): void;
/**
* Remove an entity.
*
* @param TEntity $entity
* @param array<string,mixed> $options
*/
public function remove(Entity $entity, array $options = []): void;
}