Sabre\CalDAV\Backend\SyncSupport Interface Reference

WebDAV-sync support for CalDAV backends. More...

Inheritance diagram for Sabre\CalDAV\Backend\SyncSupport:

Collaboration diagram for Sabre\CalDAV\Backend\SyncSupport:

Public Member Functions
	getChangesForCalendar ($calendarId, $syncToken, $syncLevel, $limit=null)
	The getChanges method returns all the changes that have happened, since the specified syncToken in the specified calendar. 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

WebDAV-sync support for CalDAV backends.

In order for backends to advertise support for WebDAV-sync, this interface must be implemented.

Implementing this can result in a significant reduction of bandwidth and CPU time.

For this to work, you must return a {http://sabredav.org/ns}sync-token property from getCalendarsFromUser.

Copyright

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

Author

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

Definition at line 21 of file SyncSupport.php.

Member Function Documentation

getChangesForCalendar()

Sabre\CalDAV\Backend\SyncSupport::getChangesForCalendar	(		$calendarId,
			$syncToken,
			$syncLevel,
			$limit = null
	)

The getChanges method returns all the changes that have happened, since the specified syncToken in the specified calendar.

This function should return an array, such as the following:

[ 'syncToken' => 'The current synctoken', 'added' => [ 'new.txt', ], 'modified' => [ 'modified.txt', ], 'deleted' => [ 'foo.php.bak', 'old.txt' ] );

The returned syncToken property should reflect the current syncToken of the calendar, as reported in the {http://sabredav.org/ns}sync-token property This is * needed here too, to ensure the operation is atomic.

If the $syncToken argument is specified as null, this is an initial sync, and all members should be reported.

The modified property is an array of nodenames that have changed since the last token.

The deleted property is an array with nodenames, that have been deleted from collection.

The $syncLevel argument is basically the 'depth' of the report. If it's 1, you only have to report changes that happened only directly in immediate descendants. If it's 2, it should also include changes from the nodes below the child collections. (grandchildren)

The $limit argument allows a client to specify how many results should be returned at most. If the limit is not specified, it should be treated as infinite.

If the limit (infinite or not) is higher than you're willing to return, you should throw a Sabre() exception.

If the syncToken is expired (due to data cleanup) or unknown, you must return null.

The limit is 'suggestive'. You are free to ignore it.

Parameters

string	$calendarId
string	$syncToken
int	$syncLevel
int	$limit

Returns

array

Implemented in Sabre\CalDAV\Backend\PDO.

---

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

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