PHP Class Sabre\CardDAV\Backend\PDO

__construct() public method

Sets up the object

public __construct ( PDO $pdo, string $addressBooksTableName = 'addressbooks', string $cardsTableName = 'cards', $addressBookChangesTableName = 'addressbookchanges' )
$pdo	PDO
$addressBooksTableName	string
$cardsTableName	string

addChange() protected method

Adds a change record to the addressbookchanges table.

protected addChange ( mixed $addressBookId, string $objectUri, integer $operation ) : void
$addressBookId	mixed
$objectUri	string
$operation	integer	1 = add, 2 = modify, 3 = delete
return	void

createAddressBook() public method

Creates a new address book

public createAddressBook ( string $principalUri, string $url, array $properties ) : void
$principalUri	string
$url	string	Just the 'basename' of the url.
$properties	array
return	void

createCard() public method

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.

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

deleteAddressBook() public method

Deletes an entire addressbook and all its contents

public deleteAddressBook ( integer $addressBookId ) : void
$addressBookId	integer
return	void

deleteCard() public method

Deletes a card

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

getAddressBooksForUser() public method

Returns the list of addressbooks for a specific user.

public getAddressBooksForUser ( string $principalUri ) : array
$principalUri	string
return	array

getCard() public method

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.

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

getCards() public method

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.

public getCards ( mixed $addressbookId ) : array
$addressbookId	mixed
return	array

getChangesForAddressBook() public method

This function should return an array, such as the following: [ 'syncToken' => 'The current synctoken', 'added' => [ 'new.txt', ], 'modified' => [ 'updated.txt', ], 'deleted' => [ 'foo.php.bak', 'old.txt' ] ]; The returned syncToken property should reflect the *current* syncToken of the addressbook, as reported in the {http://sabredav.org/ns}sync-token property. This is needed here too, to ensure the operation is atomic. If the $syncToken argument is specified as null, this is an initial sync, and all members should be reported. The modified property is an array of nodenames that have changed since the last token. The deleted property is an array with nodenames, that have been deleted from collection. The $syncLevel argument is basically the 'depth' of the report. If it's 1, you only have to report changes that happened only directly in immediate descendants. If it's 2, it should also include changes from the nodes below the child collections. (grandchildren) The $limit argument allows a client to specify how many results should be returned at most. If the limit is not specified, it should be treated as infinite. If the limit (infinite or not) is higher than you're willing to return, you should throw a Sabre\DAV\Exception\TooMuchMatches() exception. If the syncToken is expired (due to data cleanup) or unknown, you must return null. The limit is 'suggestive'. You are free to ignore it.

public getChangesForAddressBook ( string $addressBookId, string $syncToken, integer $syncLevel, integer $limit = null ) : array
$addressBookId	string
$syncToken	string
$syncLevel	integer
$limit	integer
return	array

getMultipleCards() public method

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.

public getMultipleCards ( mixed $addressBookId, array $uris ) : array
$addressBookId	mixed
$uris	array
return	array

updateAddressBook() public method

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 documenation for more info and examples.

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

updateCard() public method

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.

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