You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
256 lines
5.1 KiB
256 lines
5.1 KiB
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
/**
|
|
* @copyright 2018
|
|
*
|
|
* @author Maxence Lange <maxence@artificial-owl.com>
|
|
*
|
|
* @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 OCP\FullTextSearch\Model;
|
|
|
|
/**
|
|
* Interface IDocumentAccess
|
|
*
|
|
* This object is used as a data transfer object when
|
|
*
|
|
* - indexing a document,
|
|
* - generating a search request.
|
|
*
|
|
* During the index, it is used to define which users, groups, circles, ...
|
|
* have access to the IIndexDocument
|
|
*
|
|
* During the search, it is internally use to define to which group, circles, ...
|
|
* a user that perform the search belongs to.
|
|
*
|
|
* @see IIndexDocument::setAccess
|
|
*
|
|
* @since 16.0.0
|
|
*
|
|
*/
|
|
interface IDocumentAccess {
|
|
|
|
|
|
/**
|
|
* Owner of the document can be set at the init of the object.
|
|
*
|
|
* @since 16.0.0
|
|
*
|
|
* IDocumentAccess constructor.
|
|
*
|
|
* @param string $ownerId
|
|
*/
|
|
public function __construct(string $ownerId = '');
|
|
|
|
|
|
/**
|
|
* Set the Owner of the document.
|
|
*
|
|
* @since 16.0.0
|
|
*
|
|
* @param string $ownerId
|
|
*
|
|
* @return IDocumentAccess
|
|
*/
|
|
public function setOwnerId(string $ownerId): IDocumentAccess;
|
|
|
|
/**
|
|
* Get the Owner of the document.
|
|
*
|
|
* @since 16.0.0
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getOwnerId(): string;
|
|
|
|
|
|
/**
|
|
* Set the viewer of the document.
|
|
*
|
|
* @since 16.0.0
|
|
*
|
|
* @param string $viewerId
|
|
*
|
|
* @return IDocumentAccess
|
|
*/
|
|
public function setViewerId(string $viewerId): IDocumentAccess;
|
|
|
|
/**
|
|
* Get the viewer of the document.
|
|
*
|
|
* @since 16.0.0
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getViewerId(): string;
|
|
|
|
|
|
/**
|
|
* Set the list of users that have read access to the document.
|
|
*
|
|
* @since 16.0.0
|
|
*
|
|
* @param array $users
|
|
*
|
|
* @return IDocumentAccess
|
|
*/
|
|
public function setUsers(array $users): IDocumentAccess;
|
|
|
|
/**
|
|
* Add an entry to the list of users that have read access to the document.
|
|
*
|
|
* @since 16.0.0
|
|
*
|
|
* @param string $user
|
|
*
|
|
* @return IDocumentAccess
|
|
*/
|
|
public function addUser(string $user): IDocumentAccess;
|
|
|
|
/**
|
|
* Add multiple entries to the list of users that have read access to the
|
|
* document.
|
|
*
|
|
* @since 16.0.0
|
|
*
|
|
* @param array $users
|
|
*
|
|
* @return IDocumentAccess
|
|
*/
|
|
public function addUsers($users): IDocumentAccess;
|
|
|
|
/**
|
|
* Get the complete list of users that have read access to the document.
|
|
*
|
|
* @since 16.0.0
|
|
*
|
|
* @return array
|
|
*/
|
|
public function getUsers(): array;
|
|
|
|
|
|
/**
|
|
* Set the list of groups that have read access to the document.
|
|
*
|
|
* @since 16.0.0
|
|
*
|
|
* @param array $groups
|
|
*
|
|
* @return IDocumentAccess
|
|
*/
|
|
public function setGroups(array $groups): IDocumentAccess;
|
|
|
|
/**
|
|
* Add an entry to the list of groups that have read access to the document.
|
|
*
|
|
* @since 16.0.0
|
|
*
|
|
* @param string $group
|
|
*
|
|
* @return IDocumentAccess
|
|
*/
|
|
public function addGroup(string $group): IDocumentAccess;
|
|
|
|
/**
|
|
* Add multiple entries to the list of groups that have read access to the
|
|
* document.
|
|
*
|
|
* @since 16.0.0
|
|
*
|
|
* @param array $groups
|
|
*
|
|
* @return IDocumentAccess
|
|
*/
|
|
public function addGroups(array $groups);
|
|
|
|
/**
|
|
* Get the complete list of groups that have read access to the document.
|
|
*
|
|
* @since 16.0.0
|
|
*
|
|
* @return array
|
|
*/
|
|
public function getGroups(): array;
|
|
|
|
|
|
/**
|
|
* Set the list of circles that have read access to the document.
|
|
*
|
|
* @since 16.0.0
|
|
*
|
|
* @param array $circles
|
|
*
|
|
* @return IDocumentAccess
|
|
*/
|
|
public function setCircles(array $circles): IDocumentAccess;
|
|
|
|
/**
|
|
* Add an entry to the list of circles that have read access to the document.
|
|
*
|
|
* @since 16.0.0
|
|
*
|
|
* @param string $circle
|
|
*
|
|
* @return IDocumentAccess
|
|
*/
|
|
public function addCircle(string $circle): IDocumentAccess;
|
|
|
|
/**
|
|
* Add multiple entries to the list of groups that have read access to the
|
|
* document.
|
|
*
|
|
* @since 16.0.0
|
|
*
|
|
* @param array $circles
|
|
*
|
|
* @return IDocumentAccess
|
|
*/
|
|
public function addCircles(array $circles): IDocumentAccess;
|
|
|
|
/**
|
|
* Get the complete list of circles that have read access to the document.
|
|
*
|
|
* @since 16.0.0
|
|
*
|
|
* @return array
|
|
*/
|
|
public function getCircles(): array;
|
|
|
|
|
|
/**
|
|
* Set the list of links that have read access to the document.
|
|
*
|
|
* @since 16.0.0
|
|
*
|
|
* @param array $links
|
|
*
|
|
* @return IDocumentAccess
|
|
*/
|
|
public function setLinks(array $links): IDocumentAccess;
|
|
|
|
/**
|
|
* Get the list of links that have read access to the document.
|
|
*
|
|
* @since 16.0.0
|
|
*
|
|
* @return array
|
|
*/
|
|
public function getLinks(): array;
|
|
}
|