IProxyWrite
extends
IPrincipal
in
ProxyWrite principal interface.
Any principal node implementing this interface will be picked up as a 'proxy principal group'.
Tags
Table of Contents
- delete() : mixed
- Deleted 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() : int|null
- Returns the last modification time, as a unix timestamp. Return null if the information is not available.
- getName() : string
- Returns the name of the node.
- getPrincipalUrl() : string
- Returns the full principal url.
- setGroupMemberSet() : mixed
- Sets a list of group members.
- setName() : mixed
- Renames the node.
Methods
delete()
Deleted the current node.
public
delete() : mixed
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, as a unix timestamp. Return null if the information is not available.
public
getLastModified() : int|null
Return values
int|null —getName()
Returns the name of the node.
public
getName() : string
This is used to generate the url.
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