ILIAS
release_5-4 Revision v5.4.26-12-gabc799a52e6
|
The ICollection Interface. More...
Public Member Functions | |
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... | |
The ICollection Interface.
This interface should be implemented by each class that represents a collection
Definition at line 14 of file ICollection.php.
Sabre\DAV\ICollection::childExists | ( | $name | ) |
Checks if a child-node with the specified name exists.
string | $name |
Implemented in ilObjContainerDAV, Sabre\CalDAV\CalendarHome, Sabre\CalDAV\Calendar, ilClientNodeDAV, Sabre\DAV\TreeDirectoryTester, Sabre\DAV\FS\Directory, Sabre\DAV\FSExt\Directory, ilMountPointDAV, Sabre\CalDAV\Principal\User, and Sabre\DAV\Collection.
Sabre\DAV\ICollection::createDirectory | ( | $name | ) |
Creates a new subdirectory.
string | $name |
Implemented in ilClientNodeDAV, Sabre\CalDAV\Calendar, ilMountPointDAV, Sabre\CalDAV\CalendarHome, Sabre\DAV\TreeDirectoryTester, Sabre\CardDAV\AddressBook, Sabre\CardDAV\AddressBookHome, Sabre\DAV\Mock\Collection, ilObjContainerDAV, Sabre\DAV\Collection, Sabre\DAV\FSExt\Directory, Sabre\DAV\FS\Directory, and Sabre\CalDAV\Principal\User.
Referenced by Sabre\DAV\Tree\copyNode().
Sabre\DAV\ICollection::createFile | ( | $name, | |
$data = null |
|||
) |
Creates a new file in the directory.
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.
string | $name | Name of the file |
resource | string | $data | Initial payload |
Implemented in ilClientNodeDAV, Sabre\CalDAV\Calendar, ilMountPointDAV, Sabre\CardDAV\AddressBook, Sabre\DAV\TreeDirectoryTester, Sabre\CalDAV\CalendarHome, Sabre\CardDAV\AddressBookHome, Sabre\CalDAV\Schedule\Inbox, Sabre\DAV\Mock\Collection, Sabre\DAV\Collection, ilObjContainerDAV, Sabre\DAV\FSExt\Directory, Sabre\DAV\FS\Directory, and Sabre\CalDAV\Principal\User.
Referenced by Sabre\DAV\Tree\copyNode().
Sabre\DAV\ICollection::getChild | ( | $name | ) |
Returns a specific child node, referenced by its name.
This method must throw Sabre if the node does not exist.
string | $name |
Implemented in ilObjContainerDAV, Sabre\CalDAV\CalendarHome, Sabre\DAV\TreeDirectoryTester, Sabre\CardDAV\AddressBookHome, Sabre\DAVACL\AbstractPrincipalCollection, Sabre\CalDAV\Calendar, ilClientNodeDAV, Sabre\DAV\SimpleCollection, ilMountPointDAV, Sabre\DAV\FSExt\Directory, Sabre\DAV\FS\Directory, Sabre\CardDAV\AddressBook, Sabre\DAVACL\FS\Collection, Sabre\CalDAV\Principal\User, and Sabre\DAV\Collection.
Referenced by Sabre\DAV\Tree\copyNode().
Sabre\DAV\ICollection::getChildren | ( | ) |
Returns an array with all the child nodes.
Implemented in Sabre\DAV\DirectoryMock, Sabre\CalDAV\CalendarHome, ilObjContainerDAV, Sabre\CardDAV\AddressBookHome, Sabre\CalDAV\Calendar, Sabre\DAV\FSExt\Directory, Sabre\DAV\Mock\Collection, Sabre\CalDAV\Subscriptions\Subscription, Sabre\DAV\SimpleCollection, Sabre\DAV\FS\Directory, Sabre\DAVACL\AbstractPrincipalCollection, Sabre\CardDAV\AddressBook, Sabre\CalDAV\Principal\User, ilMountPointDAV, Sabre\CalDAV\Schedule\Inbox, ilClientNodeDAV, Sabre\CalDAV\Schedule\Outbox, and Sabre\CalDAV\Notifications\Collection.
Referenced by Sabre\DAV\Mock\Collection\delete(), and Sabre\DAV\Collection\getChild().