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

IMultiGet. More...

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

Public Member Functions

 getMultipleChildren (array $paths)
 This method receives a list of paths in it's first argument. 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

IMultiGet.

This interface adds a tiny bit of functionality to collections.

There a certain situations, in particular in relation to WebDAV-Sync, CalDAV and CardDAV, where information for a list of items will be requested.

Because the getChild() call is the main abstraction method, this can in reality result in many database calls, which could potentially be optimized.

The MultiGet interface is used by the server in these cases.

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

Definition at line 23 of file IMultiGet.php.

Member Function Documentation

◆ getMultipleChildren()

Sabre\DAV\IMultiGet::getMultipleChildren ( array  $paths)

This method receives a list of paths in it's first argument.

It must return an array with Node objects.

If any children are not found, you do not have to return them.

Parameters
string[]$paths
Returns
array

Implemented in Sabre\DAV\TreeMultiGetTester, Sabre\CalDAV\Calendar, and Sabre\CardDAV\AddressBook.


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