Adds support for sharing features to a CalDAV server. More...
Inheritance diagram for Sabre\CalDAV\Backend\SharingSupport:
Collaboration diagram for Sabre\CalDAV\Backend\SharingSupport:
Public Member Functions | |
| updateInvites ($calendarId, array $sharees) | |
| Updates the list of shares. More... | |
| getInvites ($calendarId) | |
| Returns the list of people whom this calendar is shared with. More... | |
| setPublishStatus ($calendarId, $value) | |
| Publishes a 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
Adds support for sharing features to a CalDAV server.
CalDAV backends that implement this interface, must make the following modifications to getCalendarsForUser:
- Return shared calendars for users.
- For every calendar, return calendar-resource-uri. This strings is a URI or relative URI reference that must be unique for every calendar, but identical for every instance of the same shared calendar.
- For every calendar, you must return a share-access element. This element should contain one of the Sabre\DAV\Sharing\Plugin:ACCESS_* constants and indicates the access level the user has.
- Copyright
- Copyright (C) fruux GmbH (https://fruux.com/)
Definition at line 23 of file SharingSupport.php.
Member Function Documentation
◆ getInvites()
| Sabre\CalDAV\Backend\SharingSupport::getInvites | ( | $calendarId | ) |
Returns the list of people whom this calendar is shared with.
Every item in the returned list must be a Sharee object with at least the following properties set: $href $shareAccess $inviteStatus
and optionally: $properties
- Parameters
-
mixed $calendarId
- Returns
- \Sabre\DAV\Xml\Element\Sharee[]
Implemented in Sabre\CalDAV\Backend\PDO, and Sabre\CalDAV\Backend\MockSharing.
◆ setPublishStatus()
| Sabre\CalDAV\Backend\SharingSupport::setPublishStatus | ( | $calendarId, | |
| $value | |||
| ) |
Publishes a calendar.
- Parameters
-
mixed $calendarId bool $value
- Returns
- void
Implemented in Sabre\CalDAV\Backend\PDO, and Sabre\CalDAV\Backend\MockSharing.
◆ updateInvites()
| Sabre\CalDAV\Backend\SharingSupport::updateInvites | ( | $calendarId, | |
| array | $sharees | ||
| ) |
Updates the list of shares.
- Parameters
-
mixed $calendarId \Sabre\DAV\Xml\Element\Sharee[] $sharees
- Returns
- void
Implemented in Sabre\CalDAV\Backend\PDO, and Sabre\CalDAV\Backend\MockSharing.
The documentation for this interface was generated from the following file:
- libs/composer/vendor/sabre/dav/lib/CalDAV/Backend/SharingSupport.php
