ProxyRead
in package
implements
IProxyRead
ProxyRead principal.
This class represents a principal group, hosted under the main principal. This is needed to implement 'Calendar delegation' support. This class is instantiated by User.
Tags
Interfaces, Classes and Traits
- IProxyRead
- ProxyRead principal interface.
Table of Contents
- $principalBackend : BackendInterface
- Principal backend.
- $principalInfo : array<string|int, mixed>
- Principal information from the parent principal.
- __construct() : mixed
- Creates the object.
- delete() : mixed
- Deletes the current node.
- getAlternateUriSet() : array<string|int, mixed>
- Returns a list of alternative urls for a principal.
- getDisplayName() : string
- Returns the displayname.
- getGroupMemberSet() : array<string|int, mixed>
- Returns the list of group members.
- getGroupMembership() : array<string|int, mixed>
- Returns the list of groups this principal is member of.
- getLastModified() : mixed
- Returns the last modification time.
- getName() : string
- Returns this principals name.
- getPrincipalUrl() : string
- Returns the full principal url.
- setGroupMemberSet() : mixed
- Sets a list of group members.
- setName() : mixed
- Renames the node.
Properties
$principalBackend
Principal backend.
protected
BackendInterface
$principalBackend
$principalInfo
Principal information from the parent principal.
protected
array<string|int, mixed>
$principalInfo
Methods
__construct()
Creates the object.
public
__construct(BackendInterface $principalBackend, array<string|int, mixed> $principalInfo) : mixed
Note that you MUST supply the parent principal information.
Parameters
- $principalBackend : BackendInterface
- $principalInfo : array<string|int, mixed>
Return values
mixed —delete()
Deletes the current node.
public
delete() : mixed
Tags
Return values
mixed —getAlternateUriSet()
Returns a list of alternative urls for a principal.
public
getAlternateUriSet() : array<string|int, mixed>
This can for example be an email address, or ldap url.
Return values
array<string|int, mixed> —getDisplayName()
Returns the displayname.
public
getDisplayName() : string
This should be a human readable name for the principal. If none is available, return the nodename.
Return values
string —getGroupMemberSet()
Returns the list of group members.
public
getGroupMemberSet() : array<string|int, mixed>
If this principal is a group, this function should return all member principal uri's for the group.
Return values
array<string|int, mixed> —getGroupMembership()
Returns the list of groups this principal is member of.
public
getGroupMembership() : array<string|int, mixed>
If this principal is a member of a (list of) groups, this function should return a list of principal uri's for it's members.
Return values
array<string|int, mixed> —getLastModified()
Returns the last modification time.
public
getLastModified() : mixed
Return values
mixed —getName()
Returns this principals name.
public
getName() : string
Return values
string —getPrincipalUrl()
Returns the full principal url.
public
getPrincipalUrl() : string
Return values
string —setGroupMemberSet()
Sets a list of group members.
public
setGroupMemberSet(array<string|int, mixed> $principals) : mixed
If this principal is a group, this method sets all the group members. The list of members is always overwritten, never appended to.
This method should throw an exception if the members could not be set.
Parameters
- $principals : array<string|int, mixed>
Return values
mixed —setName()
Renames the node.
public
setName(string $name) : mixed
Parameters
- $name : string
-
The new name