Calendars collection. More...

Inheritance diagram for Sabre\CalDAV\CalendarRoot:

Collaboration diagram for Sabre\CalDAV\CalendarRoot:

Public Member Functions
	__construct (PrincipalBackend\BackendInterface $principalBackend, Backend\BackendInterface $caldavBackend, $principalPrefix='principals')
	Constructor. More...

	getName ()
	Returns the nodename. More...

	getChildForPrincipal (array $principal)
	This method returns a node for a principal. More...

Public Member Functions inherited from Sabre\DAVACL\AbstractPrincipalCollection
	__construct (PrincipalBackend\BackendInterface $principalBackend, $principalPrefix='principals')
	Creates the object. More...

	getChildForPrincipal (array $principalInfo)
	This method returns a node for a principal. More...

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

	getChildren ()
	Return the list of users. More...

	getChild ($name)
	Returns a child object, by its name. More...

	searchPrincipals (array $searchProperties, $test='allof')
	This method is used to search for principals matching a set of properties. More...

	findByUri ($uri)
	Finds a principal by its URI. More...

Public Member Functions inherited from Sabre\DAV\Collection
	getChild ($name)
	Returns a child object, by its name. More...

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

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

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

Public Member Functions inherited from Sabre\DAV\Node
	getLastModified ()
	Returns the last modification time as a unix timestamp. More...

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

	setName ($name)
	Renames the node. 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...

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

	searchPrincipals (array $searchProperties, $test='allof')
	This method is used to search for principals matching a set of properties. More...

	findByUri ($uri)
	Finds a principal by its URI. More...

Protected Attributes
	$caldavBackend

Protected Attributes inherited from Sabre\DAVACL\AbstractPrincipalCollection
	$principalBackend

	$principalPrefix

Additional Inherited Members
Data Fields inherited from Sabre\DAVACL\AbstractPrincipalCollection
	$disableListing = false

Detailed Description

Calendars collection.

This object is responsible for generating a list of calendar-homes for each user.

This is the top-most node for the calendars tree. In most servers this class represents the "/calendars" path.

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 20 of file CalendarRoot.php.

Constructor & Destructor Documentation

◆ __construct()

Sabre\CalDAV\CalendarRoot::__construct	(	PrincipalBackend\BackendInterface	$principalBackend,
		Backend\BackendInterface	$caldavBackend,
			$principalPrefix = `'principals'`
	)

Constructor.

This constructor needs both an authentication and a caldav backend.

By default this class will show a list of calendar collections for principals in the 'principals' collection. If your main principals are actually located in a different path, use the $principalPrefix argument to override this.

Parameters

PrincipalBackend\BackendInterface	$principalBackend
Backend\BackendInterface	$caldavBackend
string	$principalPrefix

Definition at line 43 of file CalendarRoot.php.

                                                                                                                                                        {
 
        parent::__construct($principalBackend, $principalPrefix);
        $this->caldavBackend = $caldavBackend;
 
    }

References Sabre\CalDAV\CalendarRoot\$caldavBackend, Sabre\DAVACL\AbstractPrincipalCollection\$principalBackend, and Sabre\DAVACL\AbstractPrincipalCollection\$principalPrefix.

Member Function Documentation

◆ getChildForPrincipal()

Sabre\CalDAV\CalendarRoot::getChildForPrincipal ( array $principal )

This method returns a node for a principal.

The passed array contains principal information, and is guaranteed to at least contain a uri item. Other properties may or may not be supplied by the authentication backend.

Parameters

array $principal

Returns: \Sabre\DAV\INode

Reimplemented from Sabre\DAVACL\AbstractPrincipalCollection.

Definition at line 74 of file CalendarRoot.php.

                                                    {
 
        return new CalendarHome($this->caldavBackend, $principal);
 
    }

◆ getName()

Sabre\CalDAV\CalendarRoot::getName ( )

Returns the nodename.

We're overriding this, because the default will be the 'principalPrefix', and we want it to be Sabre\CalDAV\Plugin::CALENDAR_ROOT

Returns: string

Reimplemented from Sabre\DAVACL\AbstractPrincipalCollection.

Definition at line 58 of file CalendarRoot.php.

                       {
 
        return Plugin::CALENDAR_ROOT;
 
    }

References Sabre\CalDAV\Plugin\CALENDAR_ROOT.

Field Documentation

◆ $caldavBackend

Sabre\CalDAV\CalendarRoot::$caldavBackend

protected

Definition at line 27 of file CalendarRoot.php.

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

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

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

Public Member Functions

Protected Attributes

Additional Inherited Members