Inheritance diagram for Sabre\CalDAV\Backend\MockSharing:

Collaboration diagram for Sabre\CalDAV\Backend\MockSharing:

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

	getCalendarsForUser ($principalUri)
	Returns a list of calendars for a principal. More...

	getNotificationsForPrincipal ($principalUri)
	Returns a list of notifications for a given principal url. More...

	deleteNotification ($principalUri, NotificationInterface $notification)
	This deletes a specific notifcation. More...

	updateInvites ($calendarId, array $sharees)
	Updates the list of shares. More...

	getInvites ($calendarId)
	Returns the list of people whom this calendar is shared with. More...

	shareReply ($href, $status, $calendarUri, $inReplyTo, $summary=null)
	This method is called when a user replied to a request to share. More...

	setPublishStatus ($calendarId, $value)
	Publishes a calendar. More...

Public Member Functions inherited from Sabre\CalDAV\Backend\Mock
	__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...

	getNotificationsForPrincipal ($principalUri)
	Returns a list of notifications for a given principal url. More...

	deleteNotification ($principalUri, NotificationInterface $notification)
	This deletes a specific notifcation. More...

	shareReply ($href, $status, $calendarUri, $inReplyTo, $summary=null)
	This method is called when a user replied to a request to share. More...

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

Private Attributes
	$shares = []

	$notifications

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

Protected Attributes inherited from Sabre\CalDAV\Backend\Mock
	$calendarData

	$calendars

Detailed Description

Definition at line 8 of file MockSharing.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 13 of file MockSharing.php.

                                                                                                     {
 
        parent::__construct($calendars, $calendarData);
        $this->notifications = $notifications;
 
    }

References Sabre\CalDAV\Backend\Mock\$calendarData, Sabre\CalDAV\Backend\Mock\$calendars, and Sabre\CalDAV\Backend\MockSharing\$notifications.

Member Function Documentation

◆ deleteNotification()

Sabre\CalDAV\Backend\MockSharing::deleteNotification	(		$principalUri,
		NotificationInterface	$notification
	)

This deletes a specific notifcation.

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

Parameters

string	$principalUri
NotificationInterface	$notification

Returns: void

Implements Sabre\CalDAV\Backend\NotificationSupport.

Definition at line 84 of file MockSharing.php.

                                                                                    {
 
        foreach ($this->notifications[$principalUri] as $key => $value) {
            if ($notification === $value) {
                unset($this->notifications[$principalUri][$key]);
            }
        }
 
    }

References $key.

◆ getCalendarsForUser()

Sabre\CalDAV\Backend\MockSharing::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

Reimplemented from Sabre\CalDAV\Backend\Mock.

Definition at line 37 of file MockSharing.php.

                                                {
 
        $calendars = parent::getCalendarsForUser($principalUri);
        foreach ($calendars as $k => $calendar) {
 
            if (isset($calendar['share-access'])) {
                continue;
            }
            if (!empty($this->shares[$calendar['id']])) {
                $calendar['share-access'] = DAV\Sharing\Plugin::ACCESS_SHAREDOWNER;
            } else {
                $calendar['share-access'] = DAV\Sharing\Plugin::ACCESS_NOTSHARED;
            }
            $calendars[$k] = $calendar;
 
        }
        return $calendars;
 
    }

References $calendar, Sabre\CalDAV\Backend\Mock\$calendars, Sabre\DAV\Sharing\Plugin\ACCESS_NOTSHARED, and Sabre\DAV\Sharing\Plugin\ACCESS_SHAREDOWNER.

◆ getInvites()

Sabre\CalDAV\Backend\MockSharing::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[]

Implements Sabre\CalDAV\Backend\SharingSupport.

Definition at line 151 of file MockSharing.php.

                                     {
 
        if (!isset($this->shares[$calendarId])) {
            return [];
        }
 
        return $this->shares[$calendarId];
 
    }

◆ getNotificationsForPrincipal()

Sabre\CalDAV\Backend\MockSharing::getNotificationsForPrincipal ( $principalUri )

Returns a list of notifications for a given principal url.

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

Parameters

string $principalUri

Returns: array

Implements Sabre\CalDAV\Backend\NotificationSupport.

Definition at line 66 of file MockSharing.php.

                                                         {
 
        if (isset($this->notifications[$principalUri])) {
            return $this->notifications[$principalUri];
        }
        return [];
 
    }

◆ setPublishStatus()

Sabre\CalDAV\Backend\MockSharing::setPublishStatus	(	$calendarId,
		$value
	)

Publishes a calendar.

Parameters

mixed	$calendarId
bool	$value

Returns: void

Implements Sabre\CalDAV\Backend\SharingSupport.

Definition at line 187 of file MockSharing.php.

                                                   {
 
        foreach ($this->calendars as $k => $cal) {
            if ($cal['id'] === $calendarId) {
                if (!$value) {
                    unset($cal['{http://calendarserver.org/ns/}publish-url']);
                } else {
                    $cal['{http://calendarserver.org/ns/}publish-url'] = 'http://example.org/public/ ' . $calendarId . '.ics';
                }
                return;
            }
        }
 
        throw new DAV\Exception('Calendar with id "' . $calendarId . '" not found');
 
    }

◆ shareReply()

Sabre\CalDAV\Backend\MockSharing::shareReply	(	$href,
		$status,
		$calendarUri,
		$inReplyTo,
		$summary = `null`
	)

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

Parameters

	string	href The sharee who is replying (often a mailto: address)
	int	status One of the \Sabre\DAV\Sharing\Plugin::INVITE_* constants
string	$calendarUri	The url to the calendar thats being shared
string	$inReplyTo	The unique id this message is a response to
string	$summary	A description of the reply

Returns: void

Implements Sabre\CalDAV\Backend\NotificationSupport.

Definition at line 171 of file MockSharing.php.

                                                                                   {
 
        // This operation basically doesn't do anything yet
        if ($status === DAV\Sharing\Plugin::INVITE_ACCEPTED) {
            return 'calendars/blabla/calendar';
        }
 
    }

◆ updateInvites()

Sabre\CalDAV\Backend\MockSharing::updateInvites	(		$calendarId,
		array	$sharees
	)

Updates the list of shares.

Parameters

mixed	$calendarId
\Sabre\DAV\Xml\Element\Sharee[]	$sharees

Returns: void

Implements Sabre\CalDAV\Backend\SharingSupport.

Definition at line 101 of file MockSharing.php.

                                                        {
 
        if (!isset($this->shares[$calendarId])) {
            $this->shares[$calendarId] = [];
        }
 
        foreach ($sharees as $sharee) {
 
            $existingKey = null;
            foreach ($this->shares[$calendarId] as $k => $existingSharee) {
                if ($sharee->href === $existingSharee->href) {
                    $existingKey = $k;
                }
            }
            // Just making sure we're not affecting an existing copy.
            $sharee = clone $sharee;
            $sharee->inviteStatus = DAV\Sharing\Plugin::INVITE_NORESPONSE;
 
            if ($sharee->access === DAV\Sharing\Plugin::ACCESS_NOACCESS) {
                // It's a removal
                unset($this->shares[$calendarId][$existingKey]);
            } elseif ($existingKey) {
                // It's an update
                $this->shares[$calendarId][$existingKey] = $sharee;
            } else {
                // It's an addition
                $this->shares[$calendarId][] = $sharee;
            }
        }
 
        // Re-numbering keys
        $this->shares[$calendarId] = array_values($this->shares[$calendarId]);
 
    }

References Sabre\DAV\Sharing\Plugin\INVITE_NORESPONSE.

Field Documentation

◆ $notifications

Sabre\CalDAV\Backend\MockSharing::$notifications

private

Definition at line 11 of file MockSharing.php.

Referenced by Sabre\CalDAV\Backend\MockSharing\__construct().

◆ $shares

Sabre\CalDAV\Backend\MockSharing::$shares = []

private

Definition at line 10 of file MockSharing.php.

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

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

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ deleteNotification()

◆ getCalendarsForUser()

◆ getInvites()

◆ getNotificationsForPrincipal()

◆ setPublishStatus()

◆ shareReply()

◆ updateInvites()

Field Documentation

◆ $notifications

◆ $shares