Documentation

MockSubscriptionSupport extends Mock
in package

Application

implements SubscriptionSupport

This is a mock CalDAV backend that supports subscriptions.

All data is retained in memory temporarily. It's primary purpose is unit-tests.

Interfaces, Classes and Traits

SubscriptionSupport: Every CalDAV backend must at least implement this interface.

$calendarData : mixed
$calendars : mixed
$subs : array<string|int, mixed>: Subscription list.
__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.
createSubscription() : mixed: Creates a new subscription for a principal.
deleteCalendar() : mixed: Delete a calendar and all it's objects.
deleteCalendarObject() : mixed: Deletes an existing calendar object.
deleteSubscription() : mixed: Deletes a subscription.
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.
getMultipleCalendarObjects() : array<string|int, mixed>: Returns a list of calendar objects.
getSubscriptionsForUser() : array<string|int, mixed>: Returns a list of subscriptions for a principal.
updateCalendar() : mixed: Updates properties for a calendar.
updateCalendarObject() : mixed: Updates an existing calendarobject, based on it's uri.
updateSubscription() : mixed: Updates a subscription.
validateFilterForObject() : bool: This method validates if a filter (as passed to calendarQuery) matches the given object.

$calendarData


    protected
        mixed
    $calendarData

$calendars


    protected
        mixed
    $calendars

$subs

Subscription list.


    protected
        array<string|int, mixed>
    $subs
     = []

__construct()


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

Parameters

$calendars : array<string|int, mixed> = []
$calendarData : 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 —

createSubscription()

Creates a new subscription for a principal.


    public
                createSubscription(string $principalUri, string $uri, array<string|int, mixed> $properties) : mixed

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

Parameters

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

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 —

deleteSubscription()

Deletes a subscription.


    public
                deleteSubscription(mixed $subscriptionId) : mixed

Parameters

$subscriptionId : mixed

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> —

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> —

getSubscriptionsForUser()

Returns a list of subscriptions for a principal.


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

Every subscription is an array with the following keys:

id, a unique id that will be used by other functions to modify the subscription. This can be the same as the uri or a database key.
uri. This is just the 'base uri' or 'filename' of the subscription.
principaluri. The owner of the subscription. Almost always the same as principalUri passed to this method.
source. Url to the actual feed

Furthermore, all the subscription info must be returned too:

{DAV:}displayname
{http://apple.com/ns/ical/}refreshrate
{http://calendarserver.org/ns/}subscribed-strip-todos (omit if todos should not be stripped).
{http://calendarserver.org/ns/}subscribed-strip-alarms (omit if alarms should not be stripped).
{http://calendarserver.org/ns/}subscribed-strip-attachments (omit if attachments should not be stripped).
{http://apple.com/ns/ical/}calendar-color
{http://apple.com/ns/ical/}calendar-order

Parameters

$principalUri : string

Return values

array<string|int, mixed> —

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 —

updateSubscription()

Updates a subscription.


    public
                updateSubscription(mixed $subscriptionId, 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

$subscriptionId : mixed
$propPatch : PropPatch

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 —