IPrincipal interface. More...
Inheritance diagram for Sabre\DAVACL\IPrincipal:
Collaboration diagram for Sabre\DAVACL\IPrincipal:
Public Member Functions | |
| getAlternateUriSet () | |
| Returns a list of alternative urls for a principal. More... | |
| getPrincipalUrl () | |
| Returns the full principal url. More... | |
| getGroupMemberSet () | |
| Returns the list of group members. More... | |
| getGroupMembership () | |
| Returns the list of groups this principal is member of. More... | |
| setGroupMemberSet (array $principals) | |
| Sets a list of group members. More... | |
| getDisplayName () | |
| Returns the displayname. More... | |
| Public Member Functions inherited from Sabre\DAV\INode | |
| delete () | |
| Deleted the current node. More... | |
| getName () | |
| Returns the name of the node. More... | |
| setName ($name) | |
| Renames the node. More... | |
| getLastModified () | |
| Returns the last modification time, as a unix timestamp. More... | |
Detailed Description
IPrincipal interface.
Implement this interface to define your own principals
- Copyright
- Copyright (C) fruux GmbH (https://fruux.com/)
Definition at line 16 of file IPrincipal.php.
Member Function Documentation
◆ getAlternateUriSet()
| Sabre\DAVACL\IPrincipal::getAlternateUriSet | ( | ) |
Returns a list of alternative urls for a principal.
This can for example be an email address, or ldap url.
- Returns
- array
Implemented in Sabre\CalDAV\Principal\ProxyRead, Sabre\CalDAV\Principal\ProxyWrite, Sabre\DAVACL\Principal, and Sabre\DAVACL\MockPrincipal.
◆ getDisplayName()
| Sabre\DAVACL\IPrincipal::getDisplayName | ( | ) |
Returns the displayname.
This should be a human readable name for the principal. If none is available, return the nodename.
- Returns
- string
Implemented in Sabre\CalDAV\Principal\ProxyRead, Sabre\CalDAV\Principal\ProxyWrite, Sabre\DAVACL\Principal, and Sabre\DAVACL\MockPrincipal.
◆ getGroupMemberSet()
| Sabre\DAVACL\IPrincipal::getGroupMemberSet | ( | ) |
Returns the list of group members.
If this principal is a group, this function should return all member principal uri's for the group.
- Returns
- array
Implemented in Sabre\CalDAV\Principal\ProxyRead, Sabre\CalDAV\Principal\ProxyWrite, Sabre\DAVACL\Principal, and Sabre\DAVACL\MockPrincipal.
◆ getGroupMembership()
| Sabre\DAVACL\IPrincipal::getGroupMembership | ( | ) |
Returns the list of groups this principal is member of.
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.
- Returns
- array
Implemented in Sabre\CalDAV\Principal\ProxyRead, Sabre\CalDAV\Principal\ProxyWrite, and Sabre\DAVACL\Principal.
◆ getPrincipalUrl()
| Sabre\DAVACL\IPrincipal::getPrincipalUrl | ( | ) |
Returns the full principal url.
- Returns
- string
Implemented in Sabre\CalDAV\Principal\ProxyRead, Sabre\CalDAV\Principal\ProxyWrite, Sabre\DAVACL\Principal, and Sabre\DAVACL\MockPrincipal.
◆ setGroupMemberSet()
| Sabre\DAVACL\IPrincipal::setGroupMemberSet | ( | array | $principals | ) |
Sets a list of group members.
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
-
array $principals
- Returns
- void
Implemented in Sabre\DAVACL\Principal, Sabre\DAVACL\MockPrincipal, Sabre\CalDAV\Principal\ProxyRead, and Sabre\CalDAV\Principal\ProxyWrite.
The documentation for this interface was generated from the following file:
- libs/composer/vendor/sabre/dav/lib/DAVACL/IPrincipal.php
