Sabre\CalDAV\Backend\SchedulingSupport Interface Reference

Implementing this interface adds CalDAV Scheduling support to your caldav server, as defined in rfc6638. More...

Inheritance diagram for Sabre\CalDAV\Backend\SchedulingSupport:

Collaboration diagram for Sabre\CalDAV\Backend\SchedulingSupport:

Public Member Functions
	getSchedulingObject ($principalUri, $objectUri)
	Returns a single scheduling object for the inbox collection. More...
	getSchedulingObjects ($principalUri)
	Returns all scheduling objects for the inbox collection. More...
	deleteSchedulingObject ($principalUri, $objectUri)
	Deletes a scheduling object from the inbox collection. More...
	createSchedulingObject ($principalUri, $objectUri, $objectData)
	Creates a new scheduling object. More...
Public Member Functions inherited from Sabre\CalDAV\Backend\BackendInterface
	getCalendarsForUser ($principalUri)
	Returns a list of calendars for a principal. More...
	createCalendar ($principalUri, $calendarUri, array $properties)
	Creates a new calendar for a principal. More...
	updateCalendar ($calendarId, \Sabre\DAV\PropPatch $propPatch)
	Updates properties for a calendar. More...
	deleteCalendar ($calendarId)
	Delete a calendar and all its objects. More...
	getCalendarObjects ($calendarId)
	Returns all calendar objects within a calendar. More...
	getCalendarObject ($calendarId, $objectUri)
	Returns information from a single calendar object, based on it's object uri. More...
	getMultipleCalendarObjects ($calendarId, array $uris)
	Returns a list of calendar objects. More...
	createCalendarObject ($calendarId, $objectUri, $calendarData)
	Creates a new calendar object. More...
	updateCalendarObject ($calendarId, $objectUri, $calendarData)
	Updates an existing calendarobject, based on it's uri. More...
	deleteCalendarObject ($calendarId, $objectUri)
	Deletes an existing calendar object. More...
	calendarQuery ($calendarId, array $filters)
	Performs a calendar-query on the contents of this calendar. More...
	getCalendarObjectByUID ($principalUri, $uid)
	Searches through all of a users calendars and calendar objects to find an object with a specific UID. More...

Detailed Description

Implementing this interface adds CalDAV Scheduling support to your caldav server, as defined in rfc6638.

Copyright

Copyright (C) fruux GmbH (https://fruux.com/)

Author

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

Definition at line 13 of file SchedulingSupport.php.

Member Function Documentation

createSchedulingObject()

Sabre\CalDAV\Backend\SchedulingSupport::createSchedulingObject	(		$principalUri,
			$objectUri,
			$objectData
	)

Creates a new scheduling object.

This should land in a users' inbox.

Parameters

string	$principalUri
string	$objectUri
string	$objectData

Returns

void

Implemented in Sabre\CalDAV\Backend\PDO, and Sabre\CalDAV\Backend\MockScheduling.

deleteSchedulingObject()

Sabre\CalDAV\Backend\SchedulingSupport::deleteSchedulingObject	(		$principalUri,
			$objectUri
	)

Deletes a scheduling object from the inbox collection.

Parameters

string	$principalUri
string	$objectUri

Returns

void

Implemented in Sabre\CalDAV\Backend\PDO, and Sabre\CalDAV\Backend\MockScheduling.

getSchedulingObject()

Sabre\CalDAV\Backend\SchedulingSupport::getSchedulingObject	(		$principalUri,
			$objectUri
	)

Returns a single scheduling object for the inbox collection.

The returned array should contain the following elements:

• uri - A unique basename for the object. This will be used to construct a full uri.
• calendardata - The iCalendar object
• lastmodified - The last modification date. Can be an int for a unix timestamp, or a PHP DateTime object.
• etag - A unique token that must change if the object changed.
• size - The size of the object, in bytes.

Parameters

string	$principalUri
string	$objectUri

Returns

array

Implemented in Sabre\CalDAV\Backend\PDO, and Sabre\CalDAV\Backend\MockScheduling.

getSchedulingObjects()

Sabre\CalDAV\Backend\SchedulingSupport::getSchedulingObjects

(

$principalUri

)

Returns all scheduling objects for the inbox collection.

These objects should be returned as an array. Every item in the array should follow the same structure as returned from getSchedulingObject.

The main difference is that 'calendardata' is optional.

Parameters

string

$principalUri

Returns

array

Implemented in Sabre\CalDAV\Backend\PDO, and Sabre\CalDAV\Backend\MockScheduling.

---

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

• libs/composer/vendor/sabre/dav/lib/CalDAV/Backend/SchedulingSupport.php