IProperties interface. More...
Inheritance diagram for Sabre\DAV\IProperties:
Collaboration diagram for Sabre\DAV\IProperties:
Public Member Functions | |
| propPatch (PropPatch $propPatch) | |
| Updates properties on this node. More... | |
| getProperties ($properties) | |
| Returns a list of properties for this nodes. 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
IProperties interface.
Implement this interface to support custom WebDAV properties requested and sent from clients.
- Copyright
- Copyright (C) fruux GmbH (https://fruux.com/)
Definition at line 14 of file IProperties.php.
Member Function Documentation
◆ getProperties()
| Sabre\DAV\IProperties::getProperties | ( | $properties | ) |
Returns a list of properties for this nodes.
The properties list is a list of propertynames the client requested, encoded in clark-notation {xmlnamespace}tagname
If the array is empty, it means 'all properties' were requested.
Note that it's fine to liberally give properties back, instead of conforming to the list of requested properties. The Server class will filter out the extra.
- Parameters
-
array $properties
- Returns
- array
Implemented in Sabre\CardDAV\AddressBook, Sabre\DAV\TreeFileTester, Sabre\DAVACL\Principal, Sabre\CalDAV\Subscriptions\Subscription, Sabre\CalDAV\Calendar, and Sabre\DAV\Mock\PropertiesCollection.
◆ propPatch()
| Sabre\DAV\IProperties::propPatch | ( | PropPatch | $propPatch | ) |
Updates properties on this node.
This method received a PropPatch object, which contains all the information about the update.
To update specific properties, call the 'handle' method on this object. Read the PropPatch documentation for more information.
- Parameters
-
PropPatch $propPatch
- Returns
- void
Implemented in Sabre\DAV\TreeFileTester, Sabre\CalDAV\Subscriptions\Subscription, Sabre\CalDAV\Calendar, and Sabre\DAV\Mock\PropertiesCollection.
The documentation for this interface was generated from the following file:
- libs/composer/vendor/sabre/dav/lib/DAV/IProperties.php
