Inheritance diagram for Sabre\CardDAV\AddressBookRoot:

Collaboration diagram for Sabre\CardDAV\AddressBookRoot:

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

	getName ()
	Returns the name of the node. 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
	$principalBackend

	$carddavBackend

Protected Attributes inherited from Sabre\DAVACL\AbstractPrincipalCollection
	$principalBackend

	$principalPrefix

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

Detailed Description

AddressBook rootnode.

This object lists a collection of users, which can contain addressbooks.

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 16 of file AddressBookRoot.php.

Constructor & Destructor Documentation

◆ __construct()

Sabre\CardDAV\AddressBookRoot::__construct	(	DAVACL\PrincipalBackend\BackendInterface	$principalBackend,
		Backend\BackendInterface	$carddavBackend,
			$principalPrefix = `'principals'`
	)

Constructor.

This constructor needs both a principal and a carddav backend.

By default this class will show a list of addressbook 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

DAVACL\PrincipalBackend\BackendInterface	$principalBackend
Backend\BackendInterface	$carddavBackend
string	$principalPrefix

Definition at line 46 of file AddressBookRoot.php.

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

References Sabre\CardDAV\AddressBookRoot\$carddavBackend, Sabre\CardDAV\AddressBookRoot\$principalBackend, and Sabre\DAVACL\AbstractPrincipalCollection\$principalPrefix.

Member Function Documentation

◆ getChildForPrincipal()

Sabre\CardDAV\AddressBookRoot::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 AddressBookRoot.php.

                                                    {
 
        return new AddressBookHome($this->carddavBackend, $principal['uri']);
 
    }

◆ getName()

Sabre\CardDAV\AddressBookRoot::getName ( )

Returns the name of the node.

Returns: string

Reimplemented from Sabre\DAVACL\AbstractPrincipalCollection.

Definition at line 58 of file AddressBookRoot.php.

                       {
 
        return Plugin::ADDRESSBOOK_ROOT;
 
    }

References Sabre\CardDAV\Plugin\ADDRESSBOOK_ROOT.

Field Documentation

◆ $carddavBackend

Sabre\CardDAV\AddressBookRoot::$carddavBackend

protected

Definition at line 30 of file AddressBookRoot.php.

Referenced by Sabre\CardDAV\AddressBookRoot\__construct().

◆ $principalBackend

Sabre\CardDAV\AddressBookRoot::$principalBackend

protected

Definition at line 23 of file AddressBookRoot.php.