IPrincipal

IPrincipal interface.

Implement this interface to define your own principals

Methods

Returns a list of alternative urls for a principal.

public getAlternateUriSet(): array

This can for example be an email address, or ldap url.

Returns the full principal url.

public getPrincipalUrl(): string

Returns the list of group members.

public getGroupMemberSet(): array

If this principal is a group, this function should return all member principal uri's for the group.

Returns the list of groups this principal is member of.

public getGroupMembership(): array

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.

Sets a list of group members.

public setGroupMemberSet(array $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:

Parameter	Type	Description
`$principals`	array

Returns the displayname.

public getDisplayName(): string

This should be a human readable name for the principal. If none is available, return the nodename.

Deleted the current node.

public delete(): mixed

Returns the name of the node.

public getName(): string

This is used to generate the url.

Renames the node.

public setName(string $name): mixed

Parameters:

Parameter	Type	Description
`$name`	string	The new name

Returns the last modification time, as a unix timestamp. Return null if the information is not available.

public getLastModified(): int|null

Automatically generated on 2025-03-18