The CalendarHome represents a node that is usually in a users' calendar-homeset. More...

Inheritance diagram for Sabre\CalDAV\CalendarHome:

Collaboration diagram for Sabre\CalDAV\CalendarHome:

Public Member Functions
	__construct (Backend\BackendInterface $caldavBackend, $principalInfo)
	Constructor. More...

	getName ()
	Returns the name of this object. More...

	setName ($name)
	Updates the name of this object. More...

	delete ()
	Deletes this object. More...

	getLastModified ()
	Returns the last modification date. More...

	createFile ($filename, $data=null)
	Creates a new file under this object. More...

	createDirectory ($filename)
	Creates a new directory under this object. More...

	getChild ($name)
	Returns a single calendar, by name. More...

	childExists ($name)
	Checks if a calendar exists. More...

	getChildren ()
	Returns a list of calendars. More...

	createExtendedCollection ($name, MkCol $mkCol)
	Creates a new calendar or subscription. More...

	getOwner ()
	Returns the owner of the calendar home. More...

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

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

	getCalendarObjectByUID ($uid)
	Searches through all of a users calendars and calendar objects to find an object with a specific UID. More...

	createExtendedCollection ($name, MkCol $mkCol)
	Creates a new collection. 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...

Protected Attributes
	$caldavBackend

	$principalInfo

Detailed Description

The CalendarHome represents a node that is usually in a users' calendar-homeset.

It contains all the users' calendars, and can optionally contain a notifications collection, calendar subscriptions, a users' inbox, and a users' outbox.

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 23 of file CalendarHome.php.

Constructor & Destructor Documentation

◆ __construct()

Sabre\CalDAV\CalendarHome::__construct	(	Backend\BackendInterface	$caldavBackend,
			$principalInfo
	)

Constructor.

Parameters

Backend\BackendInterface	$caldavBackend
array	$principalInfo

Definition at line 47 of file CalendarHome.php.

                                                                                  {
 
        $this->caldavBackend = $caldavBackend;
        $this->principalInfo = $principalInfo;
 
    }

References Sabre\CalDAV\CalendarHome\$caldavBackend, and Sabre\CalDAV\CalendarHome\$principalInfo.

Member Function Documentation

◆ childExists()

Sabre\CalDAV\CalendarHome::childExists ( $name )

Checks if a calendar exists.

Parameters

string $name

Returns: bool

Implements Sabre\DAV\ICollection.

Definition at line 178 of file CalendarHome.php.

                                {
 
        try {
            return !!$this->getChild($name);
        } catch (NotFound $e) {
            return false;
        }
 
    }

◆ createDirectory()

Sabre\CalDAV\CalendarHome::createDirectory ( $filename )

Creates a new directory under this object.

This is currently not allowed.

Parameters

string $filename

Returns: void

Implements Sabre\DAV\ICollection.

Definition at line 123 of file CalendarHome.php.

                                        {
 
        throw new DAV\Exception\MethodNotAllowed('Creating new collections in this collection is not supported');
 
    }

◆ createExtendedCollection()

Sabre\CalDAV\CalendarHome::createExtendedCollection	(		$name,
		MkCol	$mkCol
	)

Creates a new calendar or subscription.

Parameters

string	$name
MkCol	$mkCol

Exceptions

DAV

Exception\InvalidResourceType

Returns: void

Implements Sabre\DAV\IExtendedCollection.

Definition at line 234 of file CalendarHome.php.

                                                           {
 
        $isCalendar = false;
        $isSubscription = false;
        foreach ($mkCol->getResourceType() as $rt) {
            switch ($rt) {
                case '{DAV:}collection' :
                case '{http://calendarserver.org/ns/}shared-owner' :
                    // ignore
                    break;
                case '{urn:ietf:params:xml:ns:caldav}calendar' :
                    $isCalendar = true;
                    break;
                case '{http://calendarserver.org/ns/}subscribed' :
                    $isSubscription = true;
                    break;
                default :
                    throw new DAV\Exception\InvalidResourceType('Unknown resourceType: ' . $rt);
            }
        }
 
        $properties = $mkCol->getRemainingValues();
        $mkCol->setRemainingResultCode(201);
 
        if ($isSubscription) {
            if (!$this->caldavBackend instanceof Backend\SubscriptionSupport) {
                throw new DAV\Exception\InvalidResourceType('This backend does not support subscriptions');
            }
            $this->caldavBackend->createSubscription($this->principalInfo['uri'], $name, $properties);
 
        } elseif ($isCalendar) {
            $this->caldavBackend->createCalendar($this->principalInfo['uri'], $name, $properties);
 
        } else {
            throw new DAV\Exception\InvalidResourceType('You can only create calendars and subscriptions in this collection');
 
        }
 
    }

References $name, Sabre\DAV\PropPatch\getRemainingValues(), Sabre\DAV\MkCol\getResourceType(), and Sabre\DAV\PropPatch\setRemainingResultCode().

Here is the call graph for this function:

◆ createFile()

Sabre\CalDAV\CalendarHome::createFile	(	$filename,
		$data = `null`
	)

Creates a new file under this object.

This is currently not allowed

Parameters

string	$filename
resource	$data

Returns: void

Implements Sabre\DAV\ICollection.

Definition at line 109 of file CalendarHome.php.

                                                 {
 
        throw new DAV\Exception\MethodNotAllowed('Creating new files in this collection is not supported');
 
    }

◆ delete()

Sabre\CalDAV\CalendarHome::delete ( )

Deletes this object.

Returns: void

Implements Sabre\DAV\INode.

Definition at line 83 of file CalendarHome.php.

                      {
 
        throw new DAV\Exception\Forbidden();
 
    }

◆ getACL()

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

Implements Sabre\DAVACL\IACL.

Definition at line 297 of file CalendarHome.php.

                      {
 
        return [
            [
                'privilege' => '{DAV:}read',
                'principal' => $this->principalInfo['uri'],
                'protected' => true,
            ],
            [
                'privilege' => '{DAV:}write',
                'principal' => $this->principalInfo['uri'],
                'protected' => true,
            ],
            [
                'privilege' => '{DAV:}read',
                'principal' => $this->principalInfo['uri'] . '/calendar-proxy-write',
                'protected' => true,
            ],
            [
                'privilege' => '{DAV:}write',
                'principal' => $this->principalInfo['uri'] . '/calendar-proxy-write',
                'protected' => true,
            ],
            [
                'privilege' => '{DAV:}read',
                'principal' => $this->principalInfo['uri'] . '/calendar-proxy-read',
                'protected' => true,
            ],
 
        ];
 
    }

◆ getCalendarObjectByUID()

Sabre\CalDAV\CalendarHome::getCalendarObjectByUID ( $uid )

Searches through all of a users calendars and calendar objects to find an object with a specific UID.

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

string $uid

Returns: string|null

Definition at line 372 of file CalendarHome.php.

                                          {
 
        return $this->caldavBackend->getCalendarObjectByUID($this->principalInfo['uri'], $uid);
 
    }

◆ getChild()

Sabre\CalDAV\CalendarHome::getChild ( $name )

Returns a single calendar, by name.

Parameters

string $name

Returns: Calendar

Implements Sabre\DAV\ICollection.

Definition at line 135 of file CalendarHome.php.

                             {
 
        // Special nodes
        if ($name === 'inbox' && $this->caldavBackend instanceof Backend\SchedulingSupport) {
            return new Schedule\Inbox($this->caldavBackend, $this->principalInfo['uri']);
        }
        if ($name === 'outbox' && $this->caldavBackend instanceof Backend\SchedulingSupport) {
            return new Schedule\Outbox($this->principalInfo['uri']);
        }
        if ($name === 'notifications' && $this->caldavBackend instanceof Backend\NotificationSupport) {
            return new Notifications\Collection($this->caldavBackend, $this->principalInfo['uri']);
        }
 
        // Calendars
        foreach ($this->caldavBackend->getCalendarsForUser($this->principalInfo['uri']) as $calendar) {
            if ($calendar['uri'] === $name) {
                if ($this->caldavBackend instanceof Backend\SharingSupport) {
                    return new SharedCalendar($this->caldavBackend, $calendar);
                } else {
                    return new Calendar($this->caldavBackend, $calendar);
                }
            }
        }
 
        if ($this->caldavBackend instanceof Backend\SubscriptionSupport) {
            foreach ($this->caldavBackend->getSubscriptionsForUser($this->principalInfo['uri']) as $subscription) {
                if ($subscription['uri'] === $name) {
                    return new Subscriptions\Subscription($this->caldavBackend, $subscription);
                }
            }
 
        }
 
        throw new NotFound('Node with name \'' . $name . '\' could not be found');
 
    }

References $calendar, and $name.

◆ getChildren()

Sabre\CalDAV\CalendarHome::getChildren ( )

Returns a list of calendars.

Returns: array

Implements Sabre\DAV\ICollection.

Definition at line 193 of file CalendarHome.php.

                           {
 
        $calendars = $this->caldavBackend->getCalendarsForUser($this->principalInfo['uri']);
        $objs = [];
        foreach ($calendars as $calendar) {
            if ($this->caldavBackend instanceof Backend\SharingSupport) {
                $objs[] = new SharedCalendar($this->caldavBackend, $calendar);
            } else {
                $objs[] = new Calendar($this->caldavBackend, $calendar);
            }
        }
 
        if ($this->caldavBackend instanceof Backend\SchedulingSupport) {
            $objs[] = new Schedule\Inbox($this->caldavBackend, $this->principalInfo['uri']);
            $objs[] = new Schedule\Outbox($this->principalInfo['uri']);
        }
 
        // We're adding a notifications node, if it's supported by the backend.
        if ($this->caldavBackend instanceof Backend\NotificationSupport) {
            $objs[] = new Notifications\Collection($this->caldavBackend, $this->principalInfo['uri']);
        }
 
        // If the backend supports subscriptions, we'll add those as well,
        if ($this->caldavBackend instanceof Backend\SubscriptionSupport) {
            foreach ($this->caldavBackend->getSubscriptionsForUser($this->principalInfo['uri']) as $subscription) {
                $objs[] = new Subscriptions\Subscription($this->caldavBackend, $subscription);
            }
        }
 
        return $objs;
 
    }

◆ getLastModified()

Sabre\CalDAV\CalendarHome::getLastModified ( )

Returns the last modification date.

Returns: int

Implements Sabre\DAV\INode.

Definition at line 94 of file CalendarHome.php.

                               {
 
        return null;
 
    }

◆ getName()

Sabre\CalDAV\CalendarHome::getName ( )

Returns the name of this object.

Returns: string

Implements Sabre\DAV\INode.

Definition at line 59 of file CalendarHome.php.

                       {
 
        list(, $name) = URLUtil::splitPath($this->principalInfo['uri']);
        return $name;
 
    }

References $name, and Sabre\HTTP\URLUtil\splitPath().

Here is the call graph for this function:

◆ getOwner()

Sabre\CalDAV\CalendarHome::getOwner ( )

Returns the owner of the calendar home.

Returns: string

Implements Sabre\DAVACL\IACL.

Definition at line 279 of file CalendarHome.php.

                        {
 
        return $this->principalInfo['uri'];
 
    }

◆ setName()

Sabre\CalDAV\CalendarHome::setName ( $name )

Updates the name of this object.

Parameters

string $name

Returns: void

Implements Sabre\DAV\INode.

Definition at line 72 of file CalendarHome.php.

                            {
 
        throw new DAV\Exception\Forbidden();
 
    }

◆ shareReply()

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

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

This method should return the url of the newly created calendar if the share was accepted.

Parameters

string	$href	The sharee who is replying (often a mailto: address)
int	$status	One of the SharingPlugin::STATUS_* 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: null|string

Definition at line 344 of file CalendarHome.php.

                                                                                   {
 
        if (!$this->caldavBackend instanceof Backend\SharingSupport) {
            throw new DAV\Exception\NotImplemented('Sharing support is not implemented by this backend.');
        }
 
        return $this->caldavBackend->shareReply($href, $status, $calendarUri, $inReplyTo, $summary);
 
    }

References $summary.

Field Documentation

◆ $caldavBackend

Sabre\CalDAV\CalendarHome::$caldavBackend

protected

Definition at line 32 of file CalendarHome.php.

Referenced by Sabre\CalDAV\CalendarHome\__construct().

◆ $principalInfo

Sabre\CalDAV\CalendarHome::$principalInfo

protected

Definition at line 39 of file CalendarHome.php.

Referenced by Sabre\CalDAV\CalendarHome\__construct().

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

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ childExists()

◆ createDirectory()

◆ createExtendedCollection()

◆ createFile()

◆ delete()

◆ getACL()

◆ getCalendarObjectByUID()

◆ getChild()

◆ getChildren()

◆ getLastModified()

◆ getName()

◆ getOwner()

◆ setName()

◆ shareReply()

Field Documentation

◆ $caldavBackend

◆ $principalInfo