API Documentation
\

\Horde_Dav_Contacts_Backend

The address book backend wrapper.

Summary

Methods
Properties
Constants
__construct()
getAddressBooksForUser()
updateAddressBook()
createAddressBook()
deleteAddressBook()
getCards()
getCard()
createCard()
updateCard()
deleteCard()
No public properties found
No constants found
_contacts()
$_registry
N/A
No private methods found
No private properties found
N/A

Properties

$_registry

$_registry : \Horde_Registry

A registry object.

Type

\Horde_Registry

Methods

__construct()

__construct(\Horde_Registry  $registry)

Constructor.

Parameters

\Horde_Registry $registry

A registry object.

getAddressBooksForUser()

getAddressBooksForUser(string  $principalUri) : array

Returns the list of addressbooks for a specific user.

Parameters

string $principalUri

Returns

array

updateAddressBook()

updateAddressBook(string  $addressBookId, \Sabre\DAV\PropPatch  $propPatch) : void

Updates properties for an address book.

Parameters

string $addressBookId
\Sabre\DAV\PropPatch $propPatch

createAddressBook()

createAddressBook(string  $principalUri, string  $url, array  $properties) : void

Creates a new address book

Parameters

string $principalUri
string $url

Just the 'basename' of the url.
array $properties

deleteAddressBook()

deleteAddressBook(mixed  $addressBookId) : void

Deletes an entire addressbook and all its contents

Parameters

mixed $addressBookId

getCards()

getCards(mixed  $addressbookId) : array

Returns all cards for a specific addressbook id.

Parameters

mixed $addressbookId

Returns

array

getCard()

getCard(mixed  $addressBookId, string  $cardUri) : array

Returns a specfic card.

Parameters

mixed $addressBookId
string $cardUri

Returns

array

createCard()

createCard(mixed  $addressBookId, string  $cardUri, string  $cardData) : string|null

Creates a new card.

If you don't return an ETag, you can just return null.

Parameters

mixed $addressBookId
string $cardUri
string $cardData

Returns

string|null

updateCard()

updateCard(mixed  $addressBookId, string  $cardUri, string  $cardData) : string|null

Updates a card.

Parameters

mixed $addressBookId
string $cardUri
string $cardData

Returns

string|null

deleteCard()

deleteCard(mixed  $addressBookId, string  $cardUri) : boolean

Deletes a card

Parameters

mixed $addressBookId
string $cardUri

Returns

boolean

_contacts()

_contacts() : string

Returns the name of the application providing the 'contacts' interface.

Throws

\Sabre\DAV\Exception

if no contacts application is installed.

Returns

string —

An application name.