IPrincipalCollection
extends
ICollection
in
Principal Collection interface.
Implement this interface to ensure that your principal collection can be searched using the principal-property-search REPORT.
Tags
Table of Contents
- childExists() : bool
- Checks if a child-node with the specified name exists.
- createDirectory() : mixed
- Creates a new subdirectory.
- createFile() : string|null
- Creates a new file in the directory.
- delete() : mixed
- Deleted the current node.
- findByUri() : string
- Finds a principal by its URI.
- getChild() : INode
- Returns a specific child node, referenced by its name.
- getChildren() : array<string|int, INode>
- Returns an array with all the child nodes.
- 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.
- searchPrincipals() : array<string|int, mixed>
- This method is used to search for principals matching a set of properties.
- setName() : mixed
- Renames the node.
Methods
childExists()
Checks if a child-node with the specified name exists.
public
childExists(string $name) : bool
Parameters
- $name : string
Return values
bool —createDirectory()
Creates a new subdirectory.
public
createDirectory(string $name) : mixed
Parameters
- $name : string
Return values
mixed —createFile()
Creates a new file in the directory.
public
createFile(string $name[, resource|string $data = null ]) : string|null
Data will either be supplied as a stream resource, or in certain cases as a string. Keep in mind that you may have to support either.
After successful creation of the file, you may choose to return the ETag of the new file here.
The returned ETag must be surrounded by double-quotes (The quotes should be part of the actual string).
If you cannot accurately determine the ETag, you should not return it. If you don't store the file exactly as-is (you're transforming it somehow) you should also not return an ETag.
This means that if a subsequent GET to this new file does not exactly return the same contents of what was submitted here, you are strongly recommended to omit the ETag.
Parameters
- $name : string
-
Name of the file
- $data : resource|string = null
-
Initial payload
Return values
string|null —delete()
Deleted the current node.
public
delete() : mixed
Return values
mixed —findByUri()
Finds a principal by its URI.
public
findByUri(string $uri) : string
This method may receive any type of uri, but mailto: addresses will be the most common.
Implementation of this API is optional. It is currently used by the CalDAV system to find principals based on their email addresses. If this API is not implemented, some features may not work correctly.
This method must return a relative principal path, or null, if the principal was not found or you refuse to find it.
Parameters
- $uri : string
Return values
string —getChild()
Returns a specific child node, referenced by its name.
public
getChild(string $name) : INode
This method must throw Sabre\DAV\Exception\NotFound if the node does not exist.
Parameters
- $name : string
Return values
INode —getChildren()
Returns an array with all the child nodes.
public
getChildren() : array<string|int, INode>
Return values
array<string|int, INode> —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 —searchPrincipals()
This method is used to search for principals matching a set of properties.
public
searchPrincipals(array<string|int, mixed> $searchProperties[, string $test = 'allof' ]) : array<string|int, mixed>
This search is specifically used by RFC3744's principal-property-search REPORT. You should at least allow searching on http://sabredav.org/ns}email-address.
The actual search should be a unicode-non-case-sensitive search. The keys in searchProperties are the WebDAV property names, while the values are the property values to search on.
By default, if multiple properties are submitted to this method, the various properties should be combined with 'AND'. If $test is set to 'anyof', it should be combined using 'OR'.
This method should simply return a list of 'child names', which may be used to call $this->getChild in the future.
Parameters
- $searchProperties : array<string|int, mixed>
- $test : string = 'allof'
Return values
array<string|int, mixed> —setName()
Renames the node.
public
setName(string $name) : mixed
Parameters
- $name : string
-
The new name