diff options
Diffstat (limited to 'vendor/sabre/dav/lib/Sabre/DAVACL/IPrincipalCollection.php')
-rw-r--r-- | vendor/sabre/dav/lib/Sabre/DAVACL/IPrincipalCollection.php | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/vendor/sabre/dav/lib/Sabre/DAVACL/IPrincipalCollection.php b/vendor/sabre/dav/lib/Sabre/DAVACL/IPrincipalCollection.php new file mode 100644 index 000000000..655f9ba6d --- /dev/null +++ b/vendor/sabre/dav/lib/Sabre/DAVACL/IPrincipalCollection.php @@ -0,0 +1,42 @@ +<?php + +namespace Sabre\DAVACL; + +use Sabre\DAV; + +/** + * Principal Collection interface. + * + * Implement this interface to ensure that your principal collection can be + * searched using the principal-property-search REPORT. + * + * @copyright Copyright (C) 2007-2014 fruux GmbH (https://fruux.com/). + * @author Evert Pot (http://evertpot.com/) + * @license http://code.google.com/p/sabredav/wiki/License Modified BSD License + */ +interface IPrincipalCollection extends DAV\INode { + + /** + * This method is used to search for principals matching a set of + * properties. + * + * 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. + * + * If multiple properties are being searched on, the search should be + * AND'ed. + * + * This method should simply return a list of 'child names', which may be + * used to call $this->getChild in the future. + * + * @param array $searchProperties + * @return array + */ + function searchPrincipals(array $searchProperties); + +} |