ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
Sabre\DAV\ICollection Interface Reference

The ICollection Interface. More...

+ Inheritance diagram for Sabre\DAV\ICollection:
+ Collaboration diagram for Sabre\DAV\ICollection:

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...
 

Detailed Description

The ICollection Interface.

This interface should be implemented by each class that represents a collection

Author
Evert Pot (http://evertpot.com/) http://sabre.io/license/ Modified BSD License

Definition at line 14 of file ICollection.php.

Member Function Documentation

◆ childExists()

Sabre\DAV\ICollection::childExists (   $name)

◆ createDirectory()

Sabre\DAV\ICollection::createDirectory (   $name)

◆ createFile()

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.

Parameters
string$nameName of the file
resource | string$dataInitial payload
Returns
null|string

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().

+ Here is the caller graph for this function:

◆ getChild()

Sabre\DAV\ICollection::getChild (   $name)

◆ getChildren()


The documentation for this interface was generated from the following file: