Inheritance diagram for Sabre\CardDAV\AddressBookHome:

Collaboration diagram for Sabre\CardDAV\AddressBookHome:

Public Member Functions
	__construct (Backend\BackendInterface $carddavBackend, $principalUri)
	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 addressbook, by name. More...

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

	createExtendedCollection ($name, MkCol $mkCol)
	Creates a new address book. More...

	getOwner ()
	Returns the owner principal. 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...

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

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

	$carddavBackend

Detailed Description

AddressBook Home class.

This collection contains a list of addressbooks associated with one 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 19 of file AddressBookHome.php.

Constructor & Destructor Documentation

◆ __construct()

Sabre\CardDAV\AddressBookHome::__construct	(	Backend\BackendInterface	$carddavBackend,
			$principalUri
	)

Constructor.

Parameters

Backend\BackendInterface	$carddavBackend
string	$principalUri

Definition at line 43 of file AddressBookHome.php.

                                                                                  {
 
        $this->carddavBackend = $carddavBackend;
        $this->principalUri = $principalUri;
 
    }

References Sabre\CardDAV\AddressBookHome\$carddavBackend, and Sabre\CardDAV\AddressBookHome\$principalUri.

Member Function Documentation

◆ createDirectory()

Sabre\CardDAV\AddressBookHome::createDirectory ( $filename )

Creates a new directory under this object.

This is currently not allowed.

Parameters

string $filename

Returns: void

Reimplemented from Sabre\DAV\Collection.

Definition at line 119 of file AddressBookHome.php.

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

◆ createExtendedCollection()

Sabre\CardDAV\AddressBookHome::createExtendedCollection	(		$name,
		MkCol	$mkCol
	)

Creates a new address book.

Parameters

string	$name
MkCol	$mkCol

Exceptions

DAV

Exception\InvalidResourceType

Returns: void

Implements Sabre\DAV\IExtendedCollection.

Definition at line 167 of file AddressBookHome.php.

                                                           {
 
        if (!$mkCol->hasResourceType('{' . Plugin::NS_CARDDAV . '}addressbook')) {
            throw new DAV\Exception\InvalidResourceType('Unknown resourceType for this collection');
        }
        $properties = $mkCol->getRemainingValues();
        $mkCol->setRemainingResultCode(201);
        $this->carddavBackend->createAddressBook($this->principalUri, $name, $properties);
 
    }

◆ createFile()

Sabre\CardDAV\AddressBookHome::createFile	(	$filename,
		$data = `null`
	)

Creates a new file under this object.

This is currently not allowed

Parameters

string	$filename
resource	$data

Returns: void

Reimplemented from Sabre\DAV\Collection.

Definition at line 105 of file AddressBookHome.php.

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

◆ delete()

Sabre\CardDAV\AddressBookHome::delete ( )

Deletes this object.

Returns: void

Implements Sabre\DAV\INode.

Definition at line 79 of file AddressBookHome.php.

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

◆ getChild()

Sabre\CardDAV\AddressBookHome::getChild ( $name )

Returns a single addressbook, by name.

Parameters

string $name

Todo:: needs optimizing

Returns: AddressBook

Reimplemented from Sabre\DAV\Collection.

Definition at line 132 of file AddressBookHome.php.

                             {
 
        foreach ($this->getChildren() as $child) {
            if ($name == $child->getName())
                return $child;
 
        }
        throw new DAV\Exception\NotFound('Addressbook with name \'' . $name . '\' could not be found');
 
    }

References $name, and Sabre\CardDAV\AddressBookHome\getChildren().

Here is the call graph for this function:

◆ getChildren()

Sabre\CardDAV\AddressBookHome::getChildren ( )

Returns a list of addressbooks.

Returns: array

Implements Sabre\DAV\ICollection.

Definition at line 148 of file AddressBookHome.php.

                           {
 
        $addressbooks = $this->carddavBackend->getAddressBooksForUser($this->principalUri);
        $objs = [];
        foreach ($addressbooks as $addressbook) {
            $objs[] = new AddressBook($this->carddavBackend, $addressbook);
        }
        return $objs;
 
    }

Referenced by Sabre\CardDAV\AddressBookHome\getChild().

Here is the caller graph for this function:

◆ getLastModified()

Sabre\CardDAV\AddressBookHome::getLastModified ( )

Returns the last modification date.

Returns: int

Implements Sabre\DAV\INode.

Definition at line 90 of file AddressBookHome.php.

                               {
 
        return null;
 
    }

◆ getName()

Sabre\CardDAV\AddressBookHome::getName ( )

Returns the name of this object.

Returns: string

Implements Sabre\DAV\INode.

Definition at line 55 of file AddressBookHome.php.

                       {
 
        list(, $name) = Uri\split($this->principalUri);
        return $name;
 
    }

References $name, and Sabre\Uri\split().

Here is the call graph for this function:

◆ getOwner()

Sabre\CardDAV\AddressBookHome::getOwner ( )

Returns the owner principal.

This must be a url to a principal, or null if there's no owner

Returns: string|null

Implements Sabre\DAVACL\IACL.

Definition at line 185 of file AddressBookHome.php.

                        {
 
        return $this->principalUri;
 
    }

◆ setName()

Sabre\CardDAV\AddressBookHome::setName ( $name )

Updates the name of this object.

Parameters

string $name

Returns: void

Implements Sabre\DAV\INode.

Definition at line 68 of file AddressBookHome.php.

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

Field Documentation

◆ $carddavBackend

Sabre\CardDAV\AddressBookHome::$carddavBackend

protected

Definition at line 35 of file AddressBookHome.php.

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

◆ $principalUri

Sabre\CardDAV\AddressBookHome::$principalUri

protected

Definition at line 28 of file AddressBookHome.php.

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

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

libs/composer/vendor/sabre/dav/lib/CardDAV/AddressBookHome.php

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ createDirectory()

◆ createExtendedCollection()

◆ createFile()

◆ delete()

◆ getChild()

◆ getChildren()

◆ getLastModified()

◆ getName()

◆ getOwner()

◆ setName()

Field Documentation

◆ $carddavBackend

◆ $principalUri