Documentation

MockSharing extends Mock
in package

Application

implements NotificationSupport, SharingSupport

Abstract Calendaring backend. Extend this class to create your own backends.

Checkout the BackendInterface for all the methods that must be implemented.

Interfaces, Classes and Traits

NotificationSupport: Adds caldav notification support to a backend.
SharingSupport: Adds support for sharing features to a CalDAV server.

$calendarData : mixed
$calendars : mixed
$notifications : mixed
$shares : mixed
__construct() : mixed
calendarQuery() : array<string|int, mixed>: Performs a calendar-query on the contents of this calendar.
createCalendar() : string|int: Creates a new calendar for a principal.
createCalendarObject() : mixed: Creates a new calendar object.
deleteCalendar() : mixed: Delete a calendar and all it's objects.
deleteCalendarObject() : mixed: Deletes an existing calendar object.
deleteNotification() : mixed: This deletes a specific notifcation.
getCalendarObject() : array<string|int, mixed>|null: Returns information from a single calendar object, based on it's object uri.
getCalendarObjectByUID() : string|null: Searches through all of a users calendars and calendar objects to find an object with a specific UID.
getCalendarObjects() : array<string|int, mixed>: Returns all calendar objects within a calendar object.
getCalendarsForUser() : array<string|int, mixed>: Returns a list of calendars for a principal.
getInvites() : array<string|int, Sharee>: Returns the list of people whom this calendar is shared with.
getMultipleCalendarObjects() : array<string|int, mixed>: Returns a list of calendar objects.
getNotificationsForPrincipal() : array<string|int, mixed>: Returns a list of notifications for a given principal url.
setPublishStatus() : mixed: Publishes a calendar.
shareReply() : string|null: This method is called when a user replied to a request to share.
updateCalendar() : mixed: Updates properties for a calendar.
updateCalendarObject() : mixed: Updates an existing calendarobject, based on it's uri.
updateInvites() : mixed: Updates the list of shares.
validateFilterForObject() : bool: This method validates if a filter (as passed to calendarQuery) matches the given object.

$calendarData


    protected
        mixed
    $calendarData

$calendars


    protected
        mixed
    $calendars

$notifications


    private
        mixed
    $notifications

$shares


    private
        mixed
    $shares
     = []

__construct()


    public
                __construct([array<string|int, mixed> $calendars = [] ][, array<string|int, mixed> $calendarData = [] ][, array<string|int, mixed> $notifications = [] ]) : mixed

Parameters

$calendars : array<string|int, mixed> = []
$calendarData : array<string|int, mixed> = []
$notifications : array<string|int, mixed> = []

Return values

mixed —

calendarQuery()

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


    public
                calendarQuery(mixed $calendarId, array<string|int, mixed> $filters) : array<string|int, mixed>

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 \Sabre\CalDAV\CalendarQueryParser.

Note that it is extremely likely that getCalendarObject for every path returned from this method will be called almost immediately after. You may want to anticipate this to speed up these requests.

This method provides a default implementation, which parses all the iCalendar objects in the specified calendar.

This default may well be good enough for personal use, and calendars that aren't very large. But if you anticipate high usage, big calendars or high loads, you are strongly adviced to optimize certain paths.

The best way to do so is override this method and to optimize specifically for 'common filters'.

Requests that are extremely common are:

requests for just VEVENTS
requests for just VTODO
requests with a time-range-filter on either VEVENT or VTODO.

..and combinations of these requests. It may not be worth it to try to handle every possible situation and just rely on the (relatively easy to use) CalendarQueryValidator to handle the rest.

Note that especially time-range-filters may be difficult to parse. A time-range filter specified on a VEVENT must for instance also handle recurrence rules correctly. A good example of how to interprete all these filters can also simply be found in \Sabre\CalDAV\CalendarQueryFilter. This class is as correct as possible, so it gives you a good idea on what type of stuff you need to think of.

Parameters

$calendarId : mixed
$filters : array<string|int, mixed>

Return values

array<string|int, mixed> —

createCalendar()

Creates a new calendar for a principal.


    public
                createCalendar(string $principalUri, string $calendarUri, array<string|int, mixed> $properties) : string|int

If the creation was a success, an id must be returned that can be used to reference this calendar in other methods, such as updateCalendar.

This function must return a server-wide unique id that can be used later to reference the calendar.

Parameters

$principalUri : string
$calendarUri : string
$properties : array<string|int, mixed>

Return values

string|int —

createCalendarObject()

Creates a new calendar object.


    public
                createCalendarObject(string $calendarId, string $objectUri, string $calendarData) : mixed

Parameters

$calendarId : string
$objectUri : string
$calendarData : string

Return values

mixed —

deleteCalendar()

Delete a calendar and all it's objects.


    public
                deleteCalendar(string $calendarId) : mixed

Parameters

$calendarId : string

Return values

mixed —

deleteCalendarObject()

Deletes an existing calendar object.


    public
                deleteCalendarObject(string $calendarId, string $objectUri) : mixed

Parameters

$calendarId : string
$objectUri : string

Return values

mixed —

deleteNotification()

This deletes a specific notifcation.


    public
                deleteNotification(string $principalUri, NotificationInterface $notification) : mixed

This may be called by a client once it deems a notification handled.

Parameters

$principalUri : string
$notification : NotificationInterface

Return values

mixed —

getCalendarObject()

Returns information from a single calendar object, based on it's object uri.


    public
                getCalendarObject(mixed $calendarId, string $objectUri) : array<string|int, mixed>|null

The object uri is only the basename, or filename and not a full path.

The returned array must have the same keys as getCalendarObjects. The 'calendardata' object is required here though, while it's not required for getCalendarObjects.

This method must return null if the object did not exist.

Parameters

$calendarId : mixed
$objectUri : string

Return values

array<string|int, mixed>|null —

getCalendarObjectByUID()

Searches through all of a users calendars and calendar objects to find an object with a specific UID.


    public
                getCalendarObjectByUID(string $principalUri, string $uid) : string|null

This method should return the path to this object, relative to the calendar home, so this path usually only contains two parts:

calendarpath/objectpath.ics

If the uid is not found, return null.

This method should only consider * objects that the principal owns, so any calendars owned by other principals that also appear in this collection should be ignored.

Parameters

$principalUri : string
$uid : string

Return values

string|null —

getCalendarObjects()

Returns all calendar objects within a calendar object.


    public
                getCalendarObjects(string $calendarId) : array<string|int, mixed>

Every item contains an array with the following keys:

id - unique identifier which will be used for subsequent updates
calendardata - The iCalendar-compatible calendar data
uri - a unique key which will be used to construct the uri. This can be any arbitrary string.
lastmodified - a timestamp of the last modification time
etag - An arbitrary string, surrounded by double-quotes. (e.g.: ' "abcdef"')
calendarid - The calendarid as it was passed to this function.

Note that the etag is optional, but it's highly encouraged to return for speed reasons.

The calendardata is also optional. If it's not returned 'getCalendarObject' will be called later, which is expected to return calendardata.

Parameters

$calendarId : string

Return values

array<string|int, mixed> —

getCalendarsForUser()

Returns a list of calendars for a principal.


    public
                getCalendarsForUser(string $principalUri) : array<string|int, mixed>

Every project is an array with the following keys:

id, a unique id that will be used by other functions to modify the calendar. This can be the same as the uri or a database key.
uri, which the basename of the uri with which the calendar is accessed.
principalUri. The owner of the calendar. Almost always the same as principalUri passed to this method.

Furthermore it can contain webdav properties in clark notation. A very common one is '{DAV:}displayname'.

Parameters

$principalUri : string

Return values

array<string|int, mixed> —

getInvites()

Returns the list of people whom this calendar is shared with.


    public
                getInvites(mixed $calendarId) : array<string|int, Sharee>

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

$calendarId : mixed

Return values

array<string|int, Sharee> —

getMultipleCalendarObjects()

Returns a list of calendar objects.


    public
                getMultipleCalendarObjects(mixed $calendarId, array<string|int, mixed> $uris) : array<string|int, mixed>

This method should work identical to getCalendarObject, but instead return all the calendar objects in the list as an array.

If the backend supports this, it may allow for some speed-ups.

Parameters

$calendarId : mixed
$uris : array<string|int, mixed>

Return values

array<string|int, mixed> —

getNotificationsForPrincipal()

Returns a list of notifications for a given principal url.


    public
                getNotificationsForPrincipal(string $principalUri) : array<string|int, mixed>

The returned array should only consist of implementations of Sabre\CalDAV\Notifications\INotificationType.

Parameters

$principalUri : string

Return values

array<string|int, mixed> —

setPublishStatus()

Publishes a calendar.


    public
                setPublishStatus(mixed $calendarId, bool $value) : mixed

Parameters

$calendarId : mixed
$value : bool

Return values

mixed —

shareReply()

This method is called when a user replied to a request to share.


    public
                shareReply(mixed $href, mixed $status, string $calendarUri, string $inReplyTo[, string $summary = null ]) : string|null

Parameters

$href : mixed: The sharee who is replying (often a mailto: address)
$status : mixed: One of the SharingPlugin::STATUS_* constants
$calendarUri : string: The url to the calendar thats being shared
$inReplyTo : string: The unique id this message is a response to
$summary : string = null: A description of the reply

Return values

string|null —

updateCalendar()

Updates properties for a calendar.


    public
                updateCalendar(mixed $calendarId, PropPatch $propPatch) : mixed

The list of mutations is stored in a Sabre\DAV\PropPatch object. To do the actual updates, you must tell this object which properties you're going to process with the handle() method.

Calling the handle method is like telling the PropPatch object "I promise I can handle updating this property".

Read the PropPatch documentation for more info and examples.

Parameters

$calendarId : mixed
$propPatch : PropPatch

Return values

mixed —

updateCalendarObject()

Updates an existing calendarobject, based on it's uri.


    public
                updateCalendarObject(string $calendarId, string $objectUri, string $calendarData) : mixed

Parameters

$calendarId : string
$objectUri : string
$calendarData : string

Return values

mixed —

updateInvites()

Updates the list of shares.


    public
                updateInvites(mixed $calendarId, array<string|int, Sharee> $sharees) : mixed

Parameters

$calendarId : mixed
$sharees : array<string|int, Sharee>

Return values

mixed —

validateFilterForObject()

This method validates if a filter (as passed to calendarQuery) matches the given object.


    protected
                validateFilterForObject(array<string|int, mixed> $object, array<string|int, mixed> $filters) : bool

Parameters

$object : array<string|int, mixed>
$filters : array<string|int, mixed>

Return values

bool —