4 * IProperties interface
6 * Implement this interface to support custom WebDAV properties requested and sent from clients.
10 * @copyright Copyright (C) 2007-2012 Rooftop Solutions. All rights reserved.
11 * @author Evert Pot (http://www.rooftopsolutions.nl/)
12 * @license http://code.google.com/p/sabredav/wiki/License Modified BSD License
14 interface Sabre_DAV_IProperties extends Sabre_DAV_INode {
17 * Updates properties on this node,
19 * The properties array uses the propertyName in clark-notation as key,
20 * and the array value for the property value. In the case a property
21 * should be deleted, the property value will be null.
23 * This method must be atomic. If one property cannot be changed, the
24 * entire operation must fail.
26 * If the operation was successful, true can be returned.
27 * If the operation failed, false can be returned.
29 * Deletion of a non-existent property is always successful.
31 * Lastly, it is optional to return detailed information about any
32 * failures. In this case an array should be returned with the following
37 * '{DAV:}displayname' => null,
40 * '{DAV:}owner' => null,
44 * In this example it was forbidden to update {DAV:}displayname.
45 * (403 Forbidden), which in turn also caused {DAV:}owner to fail
46 * (424 Failed Dependency) because the request needs to be atomic.
48 * @param array $mutations
51 function updateProperties($mutations);
54 * Returns a list of properties for this nodes.
56 * The properties list is a list of propertynames the client requested,
57 * encoded in clark-notation {xmlnamespace}tagname
59 * If the array is empty, it means 'all properties' were requested.
61 * @param array $properties
64 function getProperties($properties);