circles/lib/IEntity.php
Maxence Lange d68ca65322 IEntity and getLink()
Signed-off-by: Maxence Lange <maxence@artificial-owl.com>
2021-08-05 12:20:36 -01:00

70 lines
1.7 KiB
PHP

<?php
declare(strict_types=1);
/**
* Circles - Bring cloud-users closer together.
*
* This file is licensed under the Affero General Public License version 3 or
* later. See the COPYING file.
*
* @author Maxence Lange <maxence@artificial-owl.com>
* @copyright 2021
* @license GNU AGPL version 3 or any later version
*
* 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 <http://www.gnu.org/licenses/>.
*
*/
namespace OCA\Circles;
use OCA\Circles\Exceptions\MembershipNotFoundException;
use OCA\Circles\Model\Membership;
/**
* Interface IMemberships
*
* @package OCA\Circles
*/
interface IEntity {
/**
* @return string
*/
public function getSingleId(): string;
/**
* @param Membership[] $memberships
*
* @return $this
*/
public function setMemberships(array $memberships): self;
/**
* @return Membership[]
*/
public function getMemberships(): array;
/**
* @param string $singleId
* @param bool $detailed
*
* @return Membership
* @throws MembershipNotFoundException
*/
public function getLink(string $singleId, bool $detailed = false): Membership;
}