AbstractMock
extends AbstractBackend
in package
Abstract Calendaring backend. Extend this class to create your own backends.
Checkout the BackendInterface for all the methods that must be implemented.
Table of Contents
- calendarQuery() : array<string|int, mixed>
- Performs a calendar-query on the contents of this calendar.
- createCalendar() : mixed
- createCalendarObject() : mixed
- deleteCalendar() : mixed
- deleteCalendarObject() : mixed
- getCalendarObject() : mixed
- getCalendarObjectByUID() : string|null
- Searches through all of a users calendars and calendar objects to find an object with a specific UID.
- getCalendarObjects() : mixed
- getCalendarsForUser() : mixed
- getMultipleCalendarObjects() : array<string|int, mixed>
- Returns a list of calendar objects.
- updateCalendar() : mixed
- Updates properties for a calendar.
- updateCalendarObject() : mixed
- validateFilterForObject() : bool
- This method validates if a filter (as passed to calendarQuery) matches the given object.
Methods
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()
public
createCalendar(mixed $principalUri, mixed $calendarUri, array<string|int, mixed> $properties) : mixed
Parameters
- $principalUri : mixed
- $calendarUri : mixed
- $properties : array<string|int, mixed>
Return values
mixed —createCalendarObject()
public
createCalendarObject(mixed $calendarId, mixed $objectUri, mixed $calendarData) : mixed
Parameters
- $calendarId : mixed
- $objectUri : mixed
- $calendarData : mixed
Return values
mixed —deleteCalendar()
public
deleteCalendar(mixed $calendarId) : mixed
Parameters
- $calendarId : mixed
Return values
mixed —deleteCalendarObject()
public
deleteCalendarObject(mixed $calendarId, mixed $objectUri) : mixed
Parameters
- $calendarId : mixed
- $objectUri : mixed
Return values
mixed —getCalendarObject()
public
getCalendarObject(mixed $calendarId, mixed $objectUri) : mixed
Parameters
- $calendarId : mixed
- $objectUri : mixed
Return values
mixed —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()
public
getCalendarObjects(mixed $calendarId) : mixed
Parameters
- $calendarId : mixed
Return values
mixed —getCalendarsForUser()
public
getCalendarsForUser(mixed $principalUri) : mixed
Parameters
- $principalUri : mixed
Return values
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> —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()
public
updateCalendarObject(mixed $calendarId, mixed $objectUri, mixed $calendarData) : mixed
Parameters
- $calendarId : mixed
- $objectUri : mixed
- $calendarData : mixed
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>