Inheritance diagram for Sabre\CalDAV\Backend\Mock:

Collaboration diagram for Sabre\CalDAV\Backend\Mock:

Public Member Functions
	__construct (array $calendars=[], array $calendarData=[])

	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 it's objects. More...

	getCalendarObjects ($calendarId)
	Returns all calendar objects within a calendar object. More...

	getCalendarObject ($calendarId, $objectUri)
	Returns information from a single calendar object, based on it's object uri. 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...

Public Member Functions inherited from Sabre\CalDAV\Backend\AbstractBackend
	updateCalendar ($calendarId, \Sabre\DAV\PropPatch $propPatch)
	Updates properties for a calendar. More...

	getMultipleCalendarObjects ($calendarId, array $uris)
	Returns a list of calendar objects. 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...

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

Protected Attributes
	$calendarData

	$calendars

Additional Inherited Members
Protected Member Functions inherited from Sabre\CalDAV\Backend\AbstractBackend
	validateFilterForObject (array $object, array $filters)
	This method validates if a filter (as passed to calendarQuery) matches the given object. More...

Detailed Description

Definition at line 8 of file Mock.php.

Constructor & Destructor Documentation

◆ __construct()

Sabre\CalDAV\Backend\Mock::__construct	(	array	$calendars = `[]`,
		array	$calendarData = `[]`
	)

Definition at line 13 of file Mock.php.

                                                                          {
 
        foreach ($calendars as &$calendar) {
            if (!isset($calendar['id'])) {
                $calendar['id'] = DAV\UUIDUtil::getUUID();
            }
        }
 
        $this->calendars = $calendars;
        $this->calendarData = $calendarData;
 
    }

References $calendar, Sabre\CalDAV\Backend\Mock\$calendarData, Sabre\CalDAV\Backend\Mock\$calendars, and Sabre\DAV\UUIDUtil\getUUID().

Here is the call graph for this function:

Member Function Documentation

◆ createCalendar()

Sabre\CalDAV\Backend\Mock::createCalendar	(		$principalUri,
			$calendarUri,
		array	$properties
	)

Creates a new calendar for a principal.

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

string	$principalUri
string	$calendarUri
array	$properties

Returns: string|int

Implements Sabre\CalDAV\Backend\BackendInterface.

Definition at line 70 of file Mock.php.

                                                                            {
 
        $id = DAV\UUIDUtil::getUUID();
        $this->calendars[] = array_merge([
            'id'                                                                 => $id,
            'principaluri'                                                       => $principalUri,
            'uri'                                                                => $calendarUri,
            '{' . CalDAV\Plugin::NS_CALDAV . '}supported-calendar-component-set' => new CalDAV\Xml\Property\SupportedCalendarComponentSet(['VEVENT', 'VTODO']),
        ], $properties);
 
        return $id;
 
    }

References $id, Sabre\DAV\UUIDUtil\getUUID(), and Sabre\CalDAV\Plugin\NS_CALDAV.

Here is the call graph for this function:

◆ createCalendarObject()

Sabre\CalDAV\Backend\Mock::createCalendarObject	(	$calendarId,
		$objectUri,
		$calendarData
	)

Creates a new calendar object.

Parameters

string	$calendarId
string	$objectUri
string	$calendarData

Returns: void

Implements Sabre\CalDAV\Backend\BackendInterface.

Definition at line 215 of file Mock.php.

                                                                          {
 
        $this->calendarData[$calendarId][$objectUri] = [
            'calendardata' => $calendarData,
            'calendarid'   => $calendarId,
            'uri'          => $objectUri,
        ];
        return '"' . md5($calendarData) . '"';
 
    }

References Sabre\CalDAV\Backend\Mock\$calendarData.

◆ deleteCalendar()

Sabre\CalDAV\Backend\Mock::deleteCalendar ( $calendarId )

Delete a calendar and all it's objects.

Parameters

string $calendarId

Returns: void

Implements Sabre\CalDAV\Backend\BackendInterface.

Definition at line 130 of file Mock.php.

                                         {
 
        foreach ($this->calendars as $k => $calendar) {
            if ($calendar['id'] === $calendarId) {
                unset($this->calendars[$k]);
            }
        }
 
    }

References $calendar.

◆ deleteCalendarObject()

Sabre\CalDAV\Backend\Mock::deleteCalendarObject	(	$calendarId,
		$objectUri
	)

Deletes an existing calendar object.

Parameters

string	$calendarId
string	$objectUri

Returns: void

Implements Sabre\CalDAV\Backend\BackendInterface.

Definition at line 252 of file Mock.php.

                                                           {
 
        unset($this->calendarData[$calendarId][$objectUri]);
 
    }

◆ getCalendarObject()

Sabre\CalDAV\Backend\Mock::getCalendarObject	(	$calendarId,
		$objectUri
	)

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

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

mixed	$calendarId
string	$objectUri

Returns: array|null

Implements Sabre\CalDAV\Backend\BackendInterface.

Definition at line 194 of file Mock.php.

                                                        {
 
        if (!isset($this->calendarData[$calendarId][$objectUri])) {
            return null;
        }
        $object = $this->calendarData[$calendarId][$objectUri];
        $object['calendarid'] = $calendarId;
        $object['uri'] = $objectUri;
        $object['lastmodified'] = null;
        return $object;
 
    }

◆ getCalendarObjects()

Sabre\CalDAV\Backend\Mock::getCalendarObjects ( $calendarId )

Returns all calendar objects within a calendar object.

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

string $calendarId

Returns: array

Implements Sabre\CalDAV\Backend\BackendInterface.

Definition at line 162 of file Mock.php.

                                             {
 
        if (!isset($this->calendarData[$calendarId]))
            return [];
 
        $objects = $this->calendarData[$calendarId];
 
        foreach ($objects as $uri => &$object) {
            $object['calendarid'] = $calendarId;
            $object['uri'] = $uri;
            $object['lastmodified'] = null;
        }
        return $objects;
 
    }

◆ getCalendarsForUser()

Sabre\CalDAV\Backend\Mock::getCalendarsForUser ( $principalUri )

Returns a list of calendars for a principal.

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

string $principalUri

Returns: array

Implements Sabre\CalDAV\Backend\BackendInterface.

Reimplemented in Sabre\CalDAV\Backend\MockSharing.

Definition at line 43 of file Mock.php.

                                                {
 
        $r = [];
        foreach ($this->calendars as $row) {
            if ($row['principaluri'] == $principalUri) {
                $r[] = $row;
            }
        }
 
        return $r;
 
    }

References $r, and $row.

◆ updateCalendar()

Sabre\CalDAV\Backend\Mock::updateCalendar	(		$calendarId,
		\Sabre\DAV\PropPatch	$propPatch
	)

Updates properties for a calendar.

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

mixed	$calendarId
\Sabre\DAV\PropPatch	$propPatch

Returns: void

Reimplemented from Sabre\CalDAV\Backend\AbstractBackend.

Definition at line 100 of file Mock.php.

                                                                          {
 
        $propPatch->handleRemaining(function($props) use ($calendarId) {
 
            foreach ($this->calendars as $k => $calendar) {
 
                if ($calendar['id'] === $calendarId) {
                    foreach ($props as $propName => $propValue) {
                        if (is_null($propValue)) {
                            unset($this->calendars[$k][$propName]);
                        } else {
                            $this->calendars[$k][$propName] = $propValue;
                        }
                    }
                    return true;
 
                }
 
            }
 
        });
 
    }

References $calendar.

◆ updateCalendarObject()

Sabre\CalDAV\Backend\Mock::updateCalendarObject	(	$calendarId,
		$objectUri,
		$calendarData
	)

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

Parameters

string	$calendarId
string	$objectUri
string	$calendarData

Returns: void

Implements Sabre\CalDAV\Backend\BackendInterface.

Definition at line 234 of file Mock.php.

                                                                          {
 
        $this->calendarData[$calendarId][$objectUri] = [
            'calendardata' => $calendarData,
            'calendarid'   => $calendarId,
            'uri'          => $objectUri,
        ];
        return '"' . md5($calendarData) . '"';
 
    }

References Sabre\CalDAV\Backend\Mock\$calendarData.

Field Documentation

◆ $calendarData

Sabre\CalDAV\Backend\Mock::$calendarData

protected

Definition at line 10 of file Mock.php.

Referenced by Sabre\CalDAV\Backend\Mock\__construct(), Sabre\CalDAV\Backend\MockSharing\__construct(), Sabre\CalDAV\Backend\Mock\createCalendarObject(), and Sabre\CalDAV\Backend\Mock\updateCalendarObject().

◆ $calendars

Sabre\CalDAV\Backend\Mock::$calendars

protected

Definition at line 11 of file Mock.php.

Referenced by Sabre\CalDAV\Backend\Mock\__construct(), Sabre\CalDAV\Backend\MockSharing\__construct(), and Sabre\CalDAV\Backend\MockSharing\getCalendarsForUser().

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

libs/composer/vendor/sabre/dav/tests/Sabre/CalDAV/Backend/Mock.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ createCalendar()

◆ createCalendarObject()

◆ deleteCalendar()

◆ deleteCalendarObject()

◆ getCalendarObject()

◆ getCalendarObjects()

◆ getCalendarsForUser()

◆ updateCalendar()

◆ updateCalendarObject()

Field Documentation

◆ $calendarData

◆ $calendars