This object represents a CalDAV calendar that is shared by a different user. More...

Inheritance diagram for Sabre\CalDAV\SharedCalendar:

Collaboration diagram for Sabre\CalDAV\SharedCalendar:

Public Member Functions
	getShareAccess ()
	Returns the 'access level' for the instance of this shared resource. More...

	getShareResourceUri ()
	This function must return a URI that uniquely identifies the shared resource. More...

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

	getInvites ()
	Returns the list of people whom this resource is shared with. More...

	setPublishStatus ($value)
	Marks this calendar as published. More...

	getACL ()
	Returns a list of ACE's for this node. More...

	getChildACL ()
	This method returns the ACL's for calendar objects in this calendar. More...

Public Member Functions inherited from Sabre\CalDAV\Calendar
	__construct (Backend\BackendInterface $caldavBackend, $calendarInfo)
	Constructor. More...

	getName ()
	Returns the name of the calendar. More...

	propPatch (PropPatch $propPatch)
	Updates properties on this node. More...

	getProperties ($requestedProperties)
	Returns the list of properties. More...

	getChild ($name)
	Returns a calendar object. More...

	getChildren ()
	Returns the full list of calendar objects. More...

	getMultipleChildren (array $paths)
	This method receives a list of paths in it's first argument. More...

	childExists ($name)
	Checks if a child-node exists. More...

	createDirectory ($name)
	Creates a new directory. More...

	createFile ($name, $calendarData=null)
	Creates a new file. More...

	delete ()
	Deletes the calendar. More...

	setName ($newName)
	Renames the calendar. More...

	getLastModified ()
	Returns the last modification date as a unix timestamp. More...

	getOwner ()
	Returns the owner principal. More...

	getACL ()
	Returns a list of ACE's for this node. More...

	getChildACL ()
	This method returns the ACL's for calendar objects in this calendar. More...

	calendarQuery (array $filters)
	Performs a calendar-query on the contents of this calendar. More...

	getSyncToken ()
	This method returns the current sync-token for this collection. More...

	getChanges ($syncToken, $syncLevel, $limit=null)
	The getChanges method returns all the changes that have happened, since the specified syncToken and the current collection. More...

	calendarQuery (array $filters)
	Performs a calendar-query on the contents of this calendar. More...

	createFile ($name, $data=null)
	Creates a new file in the directory. More...

	createDirectory ($name)
	Creates a new subdirectory. More...

	getChild ($name)
	Returns a specific child node, referenced by its name. More...

	getChildren ()
	Returns an array with all the child nodes. More...

	childExists ($name)
	Checks if a child-node with the specified name exists. More...

	delete ()
	Deleted the current node. More...

	getName ()
	Returns the name of the node. More...

	setName ($name)
	Renames the node. More...

	getLastModified ()
	Returns the last modification time, as a unix timestamp. More...

Public Member Functions inherited from Sabre\DAVACL\IACL
	getOwner ()
	Returns the owner principal. More...

	getGroup ()
	Returns a group principal. More...

	getACL ()
	Returns a list of ACE's for this node. More...

	setACL (array $acl)
	Updates the ACL. More...

	getSupportedPrivilegeSet ()
	Returns the list of supported privileges for this node. More...

	propPatch (PropPatch $propPatch)
	Updates properties on this node. More...

	getProperties ($properties)
	Returns a list of properties for this nodes. More...

	getSyncToken ()
	This method returns the current sync-token for this collection. More...

	getChanges ($syncToken, $syncLevel, $limit=null)
	The getChanges method returns all the changes that have happened, since the specified syncToken and the current collection. More...

	getMultipleChildren (array $paths)
	This method receives a list of paths in it's first argument. More...

	setPublishStatus ($value)
	Marks this calendar as published. More...

	getShareAccess ()
	Returns the 'access level' for the instance of this shared resource. More...

	getShareResourceUri ()
	This function must return a URI that uniquely identifies the shared resource. More...

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

	getInvites ()
	Returns the list of people whom this resource is shared with. More...

Additional Inherited Members
Protected Attributes inherited from Sabre\CalDAV\Calendar
	$calendarInfo

	$caldavBackend

Detailed Description

This object represents a CalDAV calendar that is shared by a different user.

Copyright: Copyright (C) fruux GmbH (https://fruux.com/)

Author: Evert Pot (http://evertpot.com/) @license http://sabre.io/license/ Modified BSD License

Definition at line 14 of file SharedCalendar.php.

Member Function Documentation

◆ getACL()

Sabre\CalDAV\SharedCalendar::getACL ( )

Returns a list of ACE's for this node.

Each ACE has the following properties:

'privilege', a string such as {DAV:}read or {DAV:}write. These are currently the only supported privileges
'principal', a url to the principal who owns the node
'protected' (optional), indicating that this ACE is not allowed to be updated.

Returns: array

Reimplemented from Sabre\CalDAV\Calendar.

Definition at line 110 of file SharedCalendar.php.

                      {
 
        $acl = [];
 
        switch ($this->getShareAccess()) {
            case SPlugin::ACCESS_NOTSHARED :
            case SPlugin::ACCESS_SHAREDOWNER :
                $acl[] = [
                    'privilege' => '{DAV:}share',
                    'principal' => $this->calendarInfo['principaluri'],
                    'protected' => true,
                ];
                $acl[] = [
                    'privilege' => '{DAV:}share',
                    'principal' => $this->calendarInfo['principaluri'] . '/calendar-proxy-write',
                    'protected' => true,
                ];
                // No break intentional!
            case SPlugin::ACCESS_READWRITE :
                $acl[] = [
                    'privilege' => '{DAV:}write',
                    'principal' => $this->calendarInfo['principaluri'],
                    'protected' => true,
                ];
                $acl[] = [
                    'privilege' => '{DAV:}write',
                    'principal' => $this->calendarInfo['principaluri'] . '/calendar-proxy-write',
                    'protected' => true,
                ];
                // No break intentional!
            case SPlugin::ACCESS_READ :
                $acl[] = [
                    'privilege' => '{DAV:}write-properties',
                    'principal' => $this->calendarInfo['principaluri'],
                    'protected' => true,
                ];
                $acl[] = [
                    'privilege' => '{DAV:}write-properties',
                    'principal' => $this->calendarInfo['principaluri'] . '/calendar-proxy-write',
                    'protected' => true,
                ];
                $acl[] = [
                    'privilege' => '{DAV:}read',
                    'principal' => $this->calendarInfo['principaluri'],
                    'protected' => true,
                ];
                $acl[] = [
                    'privilege' => '{DAV:}read',
                    'principal' => $this->calendarInfo['principaluri'] . '/calendar-proxy-read',
                    'protected' => true,
                ];
                $acl[] = [
                    'privilege' => '{DAV:}read',
                    'principal' => $this->calendarInfo['principaluri'] . '/calendar-proxy-write',
                    'protected' => true,
                ];
                $acl[] = [
                    'privilege' => '{' . Plugin::NS_CALDAV . '}read-free-busy',
                    'principal' => '{DAV:}authenticated',
                    'protected' => true,
                ];
                break;
        }
        return $acl;
 
    }

References Sabre\CalDAV\SharedCalendar\getShareAccess(), and Sabre\CalDAV\Plugin\NS_CALDAV.

Here is the call graph for this function:

◆ getChildACL()

Sabre\CalDAV\SharedCalendar::getChildACL ( )

This method returns the ACL's for calendar objects in this calendar.

The result of this method automatically gets passed to the calendar-object nodes in the calendar.

Returns: array

Reimplemented from Sabre\CalDAV\Calendar.

Definition at line 185 of file SharedCalendar.php.

                           {
 
        $acl = [];
 
        switch ($this->getShareAccess()) {
            case SPlugin::ACCESS_NOTSHARED :
                // No break intentional
            case SPlugin::ACCESS_SHAREDOWNER :
                // No break intentional
            case SPlugin::ACCESS_READWRITE:
                $acl[] = [
                    'privilege' => '{DAV:}write',
                    'principal' => $this->calendarInfo['principaluri'],
                    'protected' => true,
                ];
                $acl[] = [
                    'privilege' => '{DAV:}write',
                    'principal' => $this->calendarInfo['principaluri'] . '/calendar-proxy-write',
                    'protected' => true,
                ];
                // No break intentional
            case SPlugin::ACCESS_READ:
                $acl[] = [
                    'privilege' => '{DAV:}read',
                    'principal' => $this->calendarInfo['principaluri'],
                    'protected' => true,
                ];
                $acl[] = [
                    'privilege' => '{DAV:}read',
                    'principal' => $this->calendarInfo['principaluri'] . '/calendar-proxy-write',
                    'protected' => true,
                ];
                $acl[] = [
                    'privilege' => '{DAV:}read',
                    'principal' => $this->calendarInfo['principaluri'] . '/calendar-proxy-read',
                    'protected' => true,
                ];
                break;
        }
 
        return $acl;
 
    }

References Sabre\CalDAV\SharedCalendar\getShareAccess().

Here is the call graph for this function:

◆ getInvites()

Sabre\CalDAV\SharedCalendar::getInvites ( )

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

Every item in the returned array must be a Sharee object with at least the following properties set:

$href
$shareAccess
$inviteStatus

and optionally:

$properties

Returns: \Sabre\DAV\Xml\Element\Sharee[]

Implements Sabre\DAV\Sharing\ISharedNode.

Definition at line 77 of file SharedCalendar.php.

                          {
 
        return $this->caldavBackend->getInvites($this->calendarInfo['id']);
 
    }

◆ getShareAccess()

Sabre\CalDAV\SharedCalendar::getShareAccess ( )

Returns the 'access level' for the instance of this shared resource.

The value should be one of the Sabre\DAV\Sharing\Plugin::ACCESS_ constants.

Returns: int

Implements Sabre\DAV\Sharing\ISharedNode.

Definition at line 24 of file SharedCalendar.php.

                              {
 
        return isset($this->calendarInfo['share-access']) ? $this->calendarInfo['share-access'] : SPlugin::ACCESS_NOTSHARED;
 
    }

Referenced by Sabre\CalDAV\SharedCalendar\getACL(), and Sabre\CalDAV\SharedCalendar\getChildACL().

Here is the caller graph for this function:

◆ getShareResourceUri()

Sabre\CalDAV\SharedCalendar::getShareResourceUri ( )

This function must return a URI that uniquely identifies the shared resource.

This URI should be identical across instances, and is also used in several other XML bodies to connect invites to resources.

This may simply be a relative reference to the original shared instance, but it could also be a urn. As long as it's a valid URI and unique.

Returns: string

Implements Sabre\DAV\Sharing\ISharedNode.

Definition at line 41 of file SharedCalendar.php.

                                   {
 
        return $this->calendarInfo['share-resource-uri'];
 
    }

◆ setPublishStatus()

Sabre\CalDAV\SharedCalendar::setPublishStatus ( $value )

Marks this calendar as published.

Publishing a calendar should automatically create a read-only, public, subscribable calendar.

Parameters

bool $value

Returns: void

Implements Sabre\CalDAV\ISharedCalendar.

Definition at line 92 of file SharedCalendar.php.

                                      {
 
        $this->caldavBackend->setPublishStatus($this->calendarInfo['id'], $value);
 
    }

◆ updateInvites()

Sabre\CalDAV\SharedCalendar::updateInvites ( array $sharees )

Updates the list of sharees.

Every item must be a Sharee object.

Parameters

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

Returns: void

Implements Sabre\DAV\Sharing\ISharedNode.

Definition at line 55 of file SharedCalendar.php.

                                           {
 
        $this->caldavBackend->updateInvites($this->calendarInfo['id'], $sharees);
 
    }

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

libs/composer/vendor/sabre/dav/lib/CalDAV/SharedCalendar.php

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getACL()

◆ getChildACL()

◆ getInvites()

◆ getShareAccess()

◆ getShareResourceUri()

◆ setPublishStatus()

◆ updateInvites()