The IExtendedCollection interface. More...
Inheritance diagram for Sabre\DAV\IExtendedCollection:
Collaboration diagram for Sabre\DAV\IExtendedCollection:
Public Member Functions | |
| createExtendedCollection ($name, MkCol $mkCol) | |
| Creates a new collection. More... | |
| Public Member Functions inherited from Sabre\DAV\ICollection | |
| createFile ($name, $data=null) | |
| Creates a new file in the directory. More... | |
| createDirectory ($name) | |
| Creates a new subdirectory. More... | |
| getChild ($name) | |
| Returns a specific child node, referenced by its name. More... | |
| getChildren () | |
| Returns an array with all the child nodes. More... | |
| childExists ($name) | |
| Checks if a child-node with the specified name exists. 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
The IExtendedCollection interface.
This interface can be used to create special-type of collection-resources as defined by RFC 5689.
- Copyright
- Copyright (C) fruux GmbH (https://fruux.com/)
Definition at line 15 of file IExtendedCollection.php.
Member Function Documentation
◆ createExtendedCollection()
| Sabre\DAV\IExtendedCollection::createExtendedCollection | ( | $name, | |
| MkCol | $mkCol | ||
| ) |
Creates a new collection.
This method will receive a MkCol object with all the information about the new collection that's being created.
The MkCol object contains information about the resourceType of the new collection. If you don't support the specified resourceType, you should throw Exception.
The object also contains a list of WebDAV properties for the new collection.
You should call the handle() method on this object to specify exactly which properties you are storing. This allows the system to figure out exactly which properties you didn't store, which in turn allows other plugins (such as the propertystorage plugin) to handle storing the property for you.
- Parameters
-
string $name MkCol $mkCol
- Exceptions
-
Exception
Implemented in Sabre\CalDAV\CalendarHome, Sabre\CardDAV\AddressBookHome, and Sabre\DAVACL\PrincipalCollection.
The documentation for this interface was generated from the following file:
- libs/composer/vendor/sabre/dav/lib/DAV/IExtendedCollection.php
