Horde_Dav_Contacts_Backend
extends AbstractBackend
in package
The address book backend wrapper.
Tags
Table of Contents
- $_registry : Horde_Registry
- A registry object.
- __construct() : mixed
- Constructor.
- createAddressBook() : void
- Creates a new address book
- createCard() : string|null
- Creates a new card.
- deleteAddressBook() : void
- Deletes an entire addressbook and all its contents
- deleteCard() : bool
- Deletes a card
- getAddressBooksForUser() : array<string|int, mixed>
- Returns the list of addressbooks for a specific user.
- getCard() : array<string|int, mixed>
- Returns a specfic card.
- getCards() : array<string|int, mixed>
- Returns all cards for a specific addressbook id.
- updateAddressBook() : void
- Updates properties for an address book.
- updateCard() : string|null
- Updates a card.
- _contacts() : string
- Returns the name of the application providing the 'contacts' interface.
Properties
$_registry
A registry object.
protected
Horde_Registry
$_registry
Methods
__construct()
Constructor.
public
__construct(Horde_Registry $registry) : mixed
Parameters
- $registry : Horde_Registry
-
A registry object.
Return values
mixed —createAddressBook()
Creates a new address book
public
createAddressBook(string $principalUri, string $url, array<string|int, mixed> $properties) : void
Parameters
- $principalUri : string
- $url : string
-
Just the 'basename' of the url.
- $properties : array<string|int, mixed>
Return values
void —createCard()
Creates a new card.
public
createCard(mixed $addressBookId, string $cardUri, string $cardData) : string|null
If you don't return an ETag, you can just return null.
Parameters
- $addressBookId : mixed
- $cardUri : string
- $cardData : string
Return values
string|null —deleteAddressBook()
Deletes an entire addressbook and all its contents
public
deleteAddressBook(mixed $addressBookId) : void
Parameters
- $addressBookId : mixed
Return values
void —deleteCard()
Deletes a card
public
deleteCard(mixed $addressBookId, string $cardUri) : bool
Parameters
- $addressBookId : mixed
- $cardUri : string
Return values
bool —getAddressBooksForUser()
Returns the list of addressbooks for a specific user.
public
getAddressBooksForUser(string $principalUri) : array<string|int, mixed>
Parameters
- $principalUri : string
Return values
array<string|int, mixed> —getCard()
Returns a specfic card.
public
getCard(mixed $addressBookId, string $cardUri) : array<string|int, mixed>
Parameters
- $addressBookId : mixed
- $cardUri : string
Return values
array<string|int, mixed> —getCards()
Returns all cards for a specific addressbook id.
public
getCards(mixed $addressbookId) : array<string|int, mixed>
Parameters
- $addressbookId : mixed
Return values
array<string|int, mixed> —updateAddressBook()
Updates properties for an address book.
public
updateAddressBook(string $addressBookId, PropPatch $propPatch) : void
Parameters
- $addressBookId : string
- $propPatch : PropPatch
Return values
void —updateCard()
Updates a card.
public
updateCard(mixed $addressBookId, string $cardUri, string $cardData) : string|null
Parameters
- $addressBookId : mixed
- $cardUri : string
- $cardData : string
Return values
string|null —_contacts()
Returns the name of the application providing the 'contacts' interface.
protected
_contacts() : string
Tags
Return values
string —An application name.