ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
Sabre\CalDAV\ICalendarObjectContainer Interface Reference

This interface represents a node that may contain calendar objects. More...

+ Inheritance diagram for Sabre\CalDAV\ICalendarObjectContainer:
+ Collaboration diagram for Sabre\CalDAV\ICalendarObjectContainer:

Public Member Functions

 calendarQuery (array $filters)
 Performs a calendar-query on the contents of this calendar. 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

This interface represents a node that may contain calendar objects.

This is the shared parent for both the Inbox collection and calendars resources.

In most cases you will likely want to look at ICalendar instead of this interface.

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

Definition at line 18 of file ICalendarObjectContainer.php.

Member Function Documentation

◆ calendarQuery()

Sabre\CalDAV\ICalendarObjectContainer::calendarQuery ( array  $filters)

Performs a calendar-query on the contents of this calendar.

The calendar-query is defined in RFC4791 : CalDAV. Using the calendar-query it is possible for a client to request a specific set of object, based on contents of iCalendar properties, date-ranges and iCalendar component types (VTODO, VEVENT).

This method should just return a list of (relative) urls that match this query.

The list of filters are specified as an array. The exact array is documented by .

Parameters
array$filters
Returns
array

Implemented in Sabre\CalDAV\Calendar, and Sabre\CalDAV\Schedule\Inbox.


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