IDocumentAccess
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.
Tags
Table of Contents
- __construct() : mixed
- Owner of the document can be set at the init of the object.
- addCircle() : IDocumentAccess
- Add an entry to the list of circles that have read access to the document.
- addCircles() : IDocumentAccess
- Add multiple entries to the list of groups that have read access to the document.
- addGroup() : IDocumentAccess
- Add an entry to the list of groups that have read access to the document.
- addGroups() : IDocumentAccess
- Add multiple entries to the list of groups that have read access to the document.
- addUser() : IDocumentAccess
- Add an entry to the list of users that have read access to the document.
- addUsers() : IDocumentAccess
- Add multiple entries to the list of users that have read access to the document.
- getCircles() : array
- Get the complete list of circles that have read access to the document.
- getGroups() : array
- Get the complete list of groups that have read access to the document.
- getLinks() : array
- Get the list of links that have read access to the document.
- getOwnerId() : string
- Get the Owner of the document.
- getUsers() : array
- Get the complete list of users that have read access to the document.
- getViewerId() : string
- Get the viewer of the document.
- setCircles() : IDocumentAccess
- Set the list of circles that have read access to the document.
- setGroups() : IDocumentAccess
- Set the list of groups that have read access to the document.
- setLinks() : IDocumentAccess
- Set the list of links that have read access to the document.
- setOwnerId() : IDocumentAccess
- Set the Owner of the document.
- setUsers() : IDocumentAccess
- Set the list of users that have read access to the document.
- setViewerId() : IDocumentAccess
- Set the viewer of the document.
Methods
__construct()
Owner of the document can be set at the init of the object.
public
__construct([string $ownerId = '' ]) : mixed
Parameters
- $ownerId : string = ''
Tags
Return values
mixed —addCircle()
Add an entry to the list of circles that have read access to the document.
public
addCircle(string $circle) : IDocumentAccess
Parameters
- $circle : string
Tags
Return values
IDocumentAccess —addCircles()
Add multiple entries to the list of groups that have read access to the document.
public
addCircles(array $circles) : IDocumentAccess
Parameters
- $circles : array
Tags
Return values
IDocumentAccess —addGroup()
Add an entry to the list of groups that have read access to the document.
public
addGroup(string $group) : IDocumentAccess
Parameters
- $group : string
Tags
Return values
IDocumentAccess —addGroups()
Add multiple entries to the list of groups that have read access to the document.
public
addGroups(array $groups) : IDocumentAccess
Parameters
- $groups : array
Tags
Return values
IDocumentAccess —addUser()
Add an entry to the list of users that have read access to the document.
public
addUser(string $user) : IDocumentAccess
Parameters
- $user : string
Tags
Return values
IDocumentAccess —addUsers()
Add multiple entries to the list of users that have read access to the document.
public
addUsers(array $users) : IDocumentAccess
Parameters
- $users : array
Tags
Return values
IDocumentAccess —getCircles()
Get the complete list of circles that have read access to the document.
public
getCircles() : array
Tags
Return values
array —getGroups()
Get the complete list of groups that have read access to the document.
public
getGroups() : array
Tags
Return values
array —getLinks()
Get the list of links that have read access to the document.
public
getLinks() : array
Tags
Return values
array —getOwnerId()
Get the Owner of the document.
public
getOwnerId() : string
Tags
Return values
string —getUsers()
Get the complete list of users that have read access to the document.
public
getUsers() : array
Tags
Return values
array —getViewerId()
Get the viewer of the document.
public
getViewerId() : string
Tags
Return values
string —setCircles()
Set the list of circles that have read access to the document.
public
setCircles(array $circles) : IDocumentAccess
Parameters
- $circles : array
Tags
Return values
IDocumentAccess —setGroups()
Set the list of groups that have read access to the document.
public
setGroups(array $groups) : IDocumentAccess
Parameters
- $groups : array
Tags
Return values
IDocumentAccess —setLinks()
Set the list of links that have read access to the document.
public
setLinks(array $links) : IDocumentAccess
Parameters
- $links : array
Tags
Return values
IDocumentAccess —setOwnerId()
Set the Owner of the document.
public
setOwnerId(string $ownerId) : IDocumentAccess
Parameters
- $ownerId : string
Tags
Return values
IDocumentAccess —setUsers()
Set the list of users that have read access to the document.
public
setUsers(array $users) : IDocumentAccess
Parameters
- $users : array
Tags
Return values
IDocumentAccess —setViewerId()
Set the viewer of the document.
public
setViewerId(string $viewerId) : IDocumentAccess
Parameters
- $viewerId : string