Mock
extends AbstractBackend
in package
CardDAV abstract Backend.
This class serves as a base-class for addressbook backends
This class doesn't do much, but it was added for consistency.
Table of Contents
- $addressBooks : mixed
- $cards : mixed
- __construct() : mixed
- createAddressBook() : mixed
- createCard() : string|null
- Creates a new card.
- deleteAddressBook() : mixed
- deleteCard() : mixed
- getAddressBooksForUser() : mixed
- getCard() : array<string|int, mixed>
- Returns a specfic card.
- getCards() : array<string|int, mixed>
- Returns all cards for a specific addressbook id.
- getMultipleCards() : array<string|int, mixed>
- Returns a list of cards.
- updateAddressBook() : mixed
- Updates properties for an address book.
- updateCard() : string|null
- Updates a card.
Properties
$addressBooks
public
mixed
$addressBooks
$cards
public
mixed
$cards
Methods
__construct()
public
__construct([mixed $addressBooks = null ][, mixed $cards = null ]) : mixed
Parameters
- $addressBooks : mixed = null
- $cards : mixed = null
Return values
mixed —createAddressBook()
public
createAddressBook(mixed $principalUri, mixed $url, array<string|int, mixed> $properties) : mixed
Parameters
- $principalUri : mixed
- $url : mixed
- $properties : array<string|int, mixed>
Return values
mixed —createCard()
Creates a new card.
public
createCard(mixed $addressBookId, string $cardUri, string $cardData) : string|null
The addressbook id will be passed as the first argument. This is the same id as it is returned from the getAddressBooksForUser method.
The cardUri is a base uri, and doesn't include the full path. The cardData argument is the vcard body, and is passed as a string.
It is possible to return an ETag from this method. This ETag is for the newly created resource, and must be enclosed with double quotes (that is, the string itself must contain the double quotes).
You should only return the ETag if you store the carddata as-is. If a subsequent GET request on the same card does not have the same body, byte-by-byte and you did return an ETag here, clients tend to get confused.
If you don't return an ETag, you can just return null.
Parameters
- $addressBookId : mixed
- $cardUri : string
- $cardData : string
Return values
string|null —deleteAddressBook()
public
deleteAddressBook(mixed $addressBookId) : mixed
Parameters
- $addressBookId : mixed
Return values
mixed —deleteCard()
public
deleteCard(mixed $addressBookId, mixed $cardUri) : mixed
Parameters
- $addressBookId : mixed
- $cardUri : mixed
Return values
mixed —getAddressBooksForUser()
public
getAddressBooksForUser(mixed $principalUri) : mixed
Parameters
- $principalUri : mixed
Return values
mixed —getCard()
Returns a specfic card.
public
getCard(mixed $addressBookId, string $cardUri) : array<string|int, mixed>
The same set of properties must be returned as with getCards. The only exception is that 'carddata' is absolutely required.
If the card does not exist, you must return false.
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>
This method should return the following properties for each card:
- carddata - raw vcard data
- uri - Some unique url
- lastmodified - A unix timestamp
It's recommended to also return the following properties:
- etag - A unique etag. This must change every time the card changes.
- size - The size of the card in bytes.
If these last two properties are provided, less time will be spent calculating them. If they are specified, you can also ommit carddata. This may speed up certain requests, especially with large cards.
Parameters
- $addressBookId : mixed
Return values
array<string|int, mixed> —getMultipleCards()
Returns a list of cards.
public
getMultipleCards(mixed $addressBookId, array<string|int, mixed> $uris) : array<string|int, mixed>
This method should work identical to getCard, but instead return all the cards in the list as an array.
If the backend supports this, it may allow for some speed-ups.
Parameters
- $addressBookId : mixed
- $uris : array<string|int, mixed>
Return values
array<string|int, mixed> —updateAddressBook()
Updates properties for an address book.
public
updateAddressBook(string $addressBookId, PropPatch $propPatch) : mixed
The list of mutations is stored in a Sabre\DAV\PropPatch object. To do the actual updates, you must tell this object which properties you're going to process with the handle() method.
Calling the handle method is like telling the PropPatch object "I promise I can handle updating this property".
Read the PropPatch documentation for more info and examples.
Parameters
- $addressBookId : string
- $propPatch : PropPatch
Return values
mixed —updateCard()
Updates a card.
public
updateCard(mixed $addressBookId, string $cardUri, string $cardData) : string|null
The addressbook id will be passed as the first argument. This is the same id as it is returned from the getAddressBooksForUser method.
The cardUri is a base uri, and doesn't include the full path. The cardData argument is the vcard body, and is passed as a string.
It is possible to return an ETag from this method. This ETag should match that of the updated resource, and must be enclosed with double quotes (that is: the string itself must contain the actual quotes).
You should only return the ETag if you store the carddata as-is. If a subsequent GET request on the same card does not have the same body, byte-by-byte and you did return an ETag here, clients tend to get confused.
If you don't return an ETag, you can just return null.
Parameters
- $addressBookId : mixed
- $cardUri : string
- $cardData : string