Inheritance diagram for Sabre\CardDAV\Backend\PDO:

Collaboration diagram for Sabre\CardDAV\Backend\PDO:

Public Member Functions
	__construct (\PDO $pdo)
	Sets up the object. More...

	getAddressBooksForUser ($principalUri)
	Returns the list of addressbooks for a specific user. More...

	updateAddressBook ($addressBookId, \Sabre\DAV\PropPatch $propPatch)
	Updates properties for an address book. More...

	createAddressBook ($principalUri, $url, array $properties)
	Creates a new address book. More...

	deleteAddressBook ($addressBookId)
	Deletes an entire addressbook and all its contents. More...

	getCards ($addressbookId)
	Returns all cards for a specific addressbook id. More...

	getCard ($addressBookId, $cardUri)
	Returns a specific card. More...

	getMultipleCards ($addressBookId, array $uris)
	Returns a list of cards. More...

	createCard ($addressBookId, $cardUri, $cardData)
	Creates a new card. More...

	updateCard ($addressBookId, $cardUri, $cardData)
	Updates a card. More...

	deleteCard ($addressBookId, $cardUri)
	Deletes a card. More...

	getChangesForAddressBook ($addressBookId, $syncToken, $syncLevel, $limit=null)
	The getChanges method returns all the changes that have happened, since the specified syncToken in the specified address book. More...

Public Member Functions inherited from Sabre\CardDAV\Backend\AbstractBackend
	getMultipleCards ($addressBookId, array $uris)
	Returns a list of cards. More...

Data Fields
	$addressBooksTableName = 'addressbooks'
	The PDO table name used to store addressbooks. More...

	$cardsTableName = 'cards'
	The PDO table name used to store cards. More...

	$addressBookChangesTableName = 'addressbookchanges'

Protected Member Functions
	addChange ($addressBookId, $objectUri, $operation)
	Adds a change record to the addressbookchanges table. More...

Protected Attributes
	$pdo

Detailed Description

PDO CardDAV backend.

This CardDAV backend uses PDO to store addressbooks

Copyright: Copyright (C) fruux GmbH (https://fruux.com/)

Author: Evert Pot (http://evertpot.com/) http://sabre.io/license/ Modified BSD License

Definition at line 17 of file PDO.php.

Constructor & Destructor Documentation

◆ __construct()

Sabre\CardDAV\Backend\PDO::__construct ( \PDO $pdo )

Sets up the object.

Parameters

\PDO $pdo

Definition at line 48 of file PDO.php.

References Sabre\CardDAV\Backend\PDO\$pdo.

                                     {
 
         $this->pdo = $pdo;
 
     }

Member Function Documentation

◆ addChange()

Sabre\CardDAV\Backend\PDO::addChange	(	$addressBookId,
		$objectUri,
		$operation
	)

protected

Adds a change record to the addressbookchanges table.

Parameters

mixed	$addressBookId
string	$objectUri
int	$operation	1 = add, 2 = modify, 3 = delete

Returns: void

Definition at line 535 of file PDO.php.

References $stmt.

Referenced by Sabre\CardDAV\Backend\PDO\createCard(), Sabre\CardDAV\Backend\PDO\deleteCard(), Sabre\CardDAV\Backend\PDO\updateAddressBook(), and Sabre\CardDAV\Backend\PDO\updateCard().

                                                                          {
 
         $stmt = $this->pdo->prepare('INSERT INTO ' . $this->addressBookChangesTableName . ' (uri, synctoken, addressbookid, operation) SELECT ?, synctoken, ?, ? FROM ' . $this->addressBooksTableName . ' WHERE id = ?');
         $stmt->execute([
             $objectUri,
             $addressBookId,
             $operation,
             $addressBookId
         ]);
         $stmt = $this->pdo->prepare('UPDATE ' . $this->addressBooksTableName . ' SET synctoken = synctoken + 1 WHERE id = ?');
         $stmt->execute([
             $addressBookId
         ]);
 
     }

Here is the caller graph for this function:

◆ createAddressBook()

Sabre\CardDAV\Backend\PDO::createAddressBook	(		$principalUri,
			$url,
		array	$properties
	)

Creates a new address book.

Parameters

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

Returns: int Last insert id

Implements Sabre\CardDAV\Backend\BackendInterface.

Definition at line 156 of file PDO.php.

References $query, $stmt, $url, $values, and Sabre\CardDAV\Plugin\NS_CARDDAV.

                                                                        {
 
         $values = [
             'displayname'  => null,
             'description'  => null,
             'principaluri' => $principalUri,
             'uri'          => $url,
         ];
 
         foreach ($properties as $property => $newValue) {
 
             switch ($property) {
                 case '{DAV:}displayname' :
                     $values['displayname'] = $newValue;
                     break;
                 case '{' . CardDAV\Plugin::NS_CARDDAV . '}addressbook-description' :
                     $values['description'] = $newValue;
                     break;
                 default :
                     throw new DAV\Exception\BadRequest('Unknown property: ' . $property);
             }
 
         }
 
         $query = 'INSERT INTO ' . $this->addressBooksTableName . ' (uri, displayname, description, principaluri, synctoken) VALUES (:uri, :displayname, :description, :principaluri, 1)';
         $stmt = $this->pdo->prepare($query);
         $stmt->execute($values);
         return $this->pdo->lastInsertId(
             $this->addressBooksTableName . '_id_seq'
         );
 
     }

◆ createCard()

Sabre\CardDAV\Backend\PDO::createCard	(	$addressBookId,
		$cardUri,
		$cardData
	)

Creates a new card.

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

mixed	$addressBookId
string	$cardUri
string	$cardData

Returns: string|null

Implements Sabre\CardDAV\Backend\BackendInterface.

Definition at line 325 of file PDO.php.

References $stmt, and Sabre\CardDAV\Backend\PDO\addChange().

                                                              {
 
         $stmt = $this->pdo->prepare('INSERT INTO ' . $this->cardsTableName . ' (carddata, uri, lastmodified, addressbookid, size, etag) VALUES (?, ?, ?, ?, ?, ?)');
 
         $etag = md5($cardData);
 
         $stmt->execute([
             $cardData,
             $cardUri,
             time(),
             $addressBookId,
             strlen($cardData),
             $etag,
         ]);
 
         $this->addChange($addressBookId, $cardUri, 1);
 
         return '"' . $etag . '"';
 
     }

Here is the call graph for this function:

◆ deleteAddressBook()

Sabre\CardDAV\Backend\PDO::deleteAddressBook ( $addressBookId )

Deletes an entire addressbook and all its contents.

Parameters

int $addressBookId

Returns: void

Implements Sabre\CardDAV\Backend\BackendInterface.

Definition at line 195 of file PDO.php.

References $stmt.

                                                {
 
         $stmt = $this->pdo->prepare('DELETE FROM ' . $this->cardsTableName . ' WHERE addressbookid = ?');
         $stmt->execute([$addressBookId]);
 
         $stmt = $this->pdo->prepare('DELETE FROM ' . $this->addressBooksTableName . ' WHERE id = ?');
         $stmt->execute([$addressBookId]);
 
         $stmt = $this->pdo->prepare('DELETE FROM ' . $this->addressBookChangesTableName . ' WHERE addressbookid = ?');
         $stmt->execute([$addressBookId]);
 
     }

◆ deleteCard()

Sabre\CardDAV\Backend\PDO::deleteCard	(	$addressBookId,
		$cardUri
	)

Deletes a card.

Parameters

mixed	$addressBookId
string	$cardUri

Returns: bool

Implements Sabre\CardDAV\Backend\BackendInterface.

Definition at line 398 of file PDO.php.

References $stmt, and Sabre\CardDAV\Backend\PDO\addChange().

                                                   {
 
         $stmt = $this->pdo->prepare('DELETE FROM ' . $this->cardsTableName . ' WHERE addressbookid = ? AND uri = ?');
         $stmt->execute([$addressBookId, $cardUri]);
 
         $this->addChange($addressBookId, $cardUri, 3);
 
         return $stmt->rowCount() === 1;
 
     }

Here is the call graph for this function:

◆ getAddressBooksForUser()

Sabre\CardDAV\Backend\PDO::getAddressBooksForUser ( $principalUri )

Returns the list of addressbooks for a specific user.

Parameters

string $principalUri

Returns: array

Implements Sabre\CardDAV\Backend\BackendInterface.

Definition at line 60 of file PDO.php.

References $row, $stmt, and Sabre\CardDAV\Plugin\NS_CARDDAV.

                                                    {
 
         $stmt = $this->pdo->prepare('SELECT id, uri, displayname, principaluri, description, synctoken FROM ' . $this->addressBooksTableName . ' WHERE principaluri = ?');
         $stmt->execute([$principalUri]);
 
         $addressBooks = [];
 
         foreach ($stmt->fetchAll() as $row) {
 
             $addressBooks[] = [
                 'id'                                                          => $row['id'],
                 'uri'                                                         => $row['uri'],
                 'principaluri'                                                => $row['principaluri'],
                 '{DAV:}displayname'                                           => $row['displayname'],
                 '{' . CardDAV\Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
                 '{http://calendarserver.org/ns/}getctag'                      => $row['synctoken'],
                 '{http://sabredav.org/ns}sync-token'                          => $row['synctoken'] ? $row['synctoken'] : '0',
             ];
 
         }
 
         return $addressBooks;
 
     }

◆ getCard()

Sabre\CardDAV\Backend\PDO::getCard	(	$addressBookId,
		$cardUri
	)

Returns a specific card.

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

mixed	$addressBookId
string	$cardUri

Returns: array

Implements Sabre\CardDAV\Backend\BackendInterface.

Definition at line 254 of file PDO.php.

References $result, and $stmt.

                                                {
 
         $stmt = $this->pdo->prepare('SELECT id, carddata, uri, lastmodified, etag, size FROM ' . $this->cardsTableName . ' WHERE addressbookid = ? AND uri = ? LIMIT 1');
         $stmt->execute([$addressBookId, $cardUri]);
 
         $result = $stmt->fetch(\PDO::FETCH_ASSOC);
 
         if (!$result) return false;
 
         $result['etag'] = '"' . $result['etag'] . '"';
         $result['lastmodified'] = (int)$result['lastmodified'];
         return $result;
 
     }

◆ getCards()

Sabre\CardDAV\Backend\PDO::getCards ( $addressbookId )

Returns all cards for a specific addressbook id.

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

mixed $addressbookId

Returns: array

Implements Sabre\CardDAV\Backend\BackendInterface.

Definition at line 227 of file PDO.php.

References $result, $row, and $stmt.

                                       {
 
         $stmt = $this->pdo->prepare('SELECT id, uri, lastmodified, etag, size FROM ' . $this->cardsTableName . ' WHERE addressbookid = ?');
         $stmt->execute([$addressbookId]);
 
         $result = [];
         while ($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
             $row['etag'] = '"' . $row['etag'] . '"';
             $row['lastmodified'] = (int)$row['lastmodified'];
             $result[] = $row;
         }
         return $result;
 
     }

◆ getChangesForAddressBook()

Sabre\CardDAV\Backend\PDO::getChangesForAddressBook	(	$addressBookId,
		$syncToken,
		$syncLevel,
		$limit = `null`
	)

The getChanges method returns all the changes that have happened, since the specified syncToken in the specified address book.

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

Parameters

string	$addressBookId
string	$syncToken
int	$syncLevel
int	$limit

Returns: array

Implements Sabre\CardDAV\Backend\SyncSupport.

Definition at line 465 of file PDO.php.

References $query, $result, $row, and $stmt.

                                                                                              {
 
         // Current synctoken
         $stmt = $this->pdo->prepare('SELECT synctoken FROM ' . $this->addressBooksTableName . ' WHERE id = ?');
         $stmt->execute([$addressBookId]);
         $currentToken = $stmt->fetchColumn(0);
 
         if (is_null($currentToken)) return null;
 
         $result = [
             'syncToken' => $currentToken,
             'added'     => [],
             'modified'  => [],
             'deleted'   => [],
         ];
 
         if ($syncToken) {
 
             $query = "SELECT uri, operation FROM " . $this->addressBookChangesTableName . " WHERE synctoken >= ? AND synctoken < ? AND addressbookid = ? ORDER BY synctoken";
             if ($limit > 0) $query .= " LIMIT " . (int)$limit;
 
             // Fetching all changes
             $stmt = $this->pdo->prepare($query);
             $stmt->execute([$syncToken, $currentToken, $addressBookId]);
 
             $changes = [];
 
             // This loop ensures that any duplicates are overwritten, only the
             // last change on a node is relevant.
             while ($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
 
                 $changes[$row['uri']] = $row['operation'];
 
             }
 
             foreach ($changes as $uri => $operation) {
 
                 switch ($operation) {
                     case 1:
                         $result['added'][] = $uri;
                         break;
                     case 2:
                         $result['modified'][] = $uri;
                         break;
                     case 3:
                         $result['deleted'][] = $uri;
                         break;
                 }
 
             }
         } else {
             // No synctoken supplied, this is the initial sync.
             $query = "SELECT uri FROM " . $this->cardsTableName . " WHERE addressbookid = ?";
             $stmt = $this->pdo->prepare($query);
             $stmt->execute([$addressBookId]);
 
             $result['added'] = $stmt->fetchAll(\PDO::FETCH_COLUMN);
         }
         return $result;
 
     }

◆ getMultipleCards()

Sabre\CardDAV\Backend\PDO::getMultipleCards	(		$addressBookId,
		array	$uris
	)

Returns a list of cards.

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

mixed	$addressBookId
array	$uris

Returns: array

Implements Sabre\CardDAV\Backend\BackendInterface.

Definition at line 281 of file PDO.php.

References $query, $result, $row, and $stmt.

                                                            {
 
         $query = 'SELECT id, uri, lastmodified, etag, size, carddata FROM ' . $this->cardsTableName . ' WHERE addressbookid = ? AND uri IN (';
         // Inserting a whole bunch of question marks
         $query .= implode(',', array_fill(0, count($uris), '?'));
         $query .= ')';
 
         $stmt = $this->pdo->prepare($query);
         $stmt->execute(array_merge([$addressBookId], $uris));
         $result = [];
         while ($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
             $row['etag'] = '"' . $row['etag'] . '"';
             $row['lastmodified'] = (int)$row['lastmodified'];
             $result[] = $row;
         }
         return $result;
 
     }

◆ updateAddressBook()

Sabre\CardDAV\Backend\PDO::updateAddressBook	(		$addressBookId,
		\Sabre\DAV\PropPatch	$propPatch
	)

Updates properties for an address book.

The list of mutations is stored in a Sabre 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

string	$addressBookId
\Sabre\DAV\PropPatch	$propPatch

Returns: void

Implements Sabre\CardDAV\Backend\BackendInterface.

Definition at line 102 of file PDO.php.

References $key, $query, $stmt, Sabre\CardDAV\Backend\PDO\addChange(), and Sabre\CardDAV\Plugin\NS_CARDDAV.

                                                                                 {
 
         $supportedProperties = [
             '{DAV:}displayname',
             '{' . CardDAV\Plugin::NS_CARDDAV . '}addressbook-description',
         ];
 
         $propPatch->handle($supportedProperties, function($mutations) use ($addressBookId) {
 
             $updates = [];
             foreach ($mutations as $property => $newValue) {
 
                 switch ($property) {
                     case '{DAV:}displayname' :
                         $updates['displayname'] = $newValue;
                         break;
                     case '{' . CardDAV\Plugin::NS_CARDDAV . '}addressbook-description' :
                         $updates['description'] = $newValue;
                         break;
                 }
             }
             $query = 'UPDATE ' . $this->addressBooksTableName . ' SET ';
             $first = true;
             foreach ($updates as $key => $value) {
                 if ($first) {
                     $first = false;
                 } else {
                     $query .= ', ';
                 }
                 $query .= ' ' . $key . ' = :' . $key . ' ';
             }
             $query .= ' WHERE id = :addressbookid';
 
             $stmt = $this->pdo->prepare($query);
             $updates['addressbookid'] = $addressBookId;
 
             $stmt->execute($updates);
 
             $this->addChange($addressBookId, "", 2);
 
             return true;
 
         });
 
     }

Here is the call graph for this function:

◆ updateCard()

Sabre\CardDAV\Backend\PDO::updateCard	(	$addressBookId,
		$cardUri,
		$cardData
	)

Updates a card.

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

mixed	$addressBookId
string	$cardUri
string	$cardData

Returns: string|null

Implements Sabre\CardDAV\Backend\BackendInterface.

Definition at line 371 of file PDO.php.

References $stmt, and Sabre\CardDAV\Backend\PDO\addChange().

                                                              {
 
         $stmt = $this->pdo->prepare('UPDATE ' . $this->cardsTableName . ' SET carddata = ?, lastmodified = ?, size = ?, etag = ? WHERE uri = ? AND addressbookid =?');
 
         $etag = md5($cardData);
         $stmt->execute([
             $cardData,
             time(),
             strlen($cardData),
             $etag,
             $cardUri,
             $addressBookId
         ]);
 
         $this->addChange($addressBookId, $cardUri, 2);
 
         return '"' . $etag . '"';
 
     }

Here is the call graph for this function:

Field Documentation

◆ $addressBookChangesTableName

Sabre\CardDAV\Backend\PDO::$addressBookChangesTableName = 'addressbookchanges'

Definition at line 41 of file PDO.php.

◆ $addressBooksTableName

Sabre\CardDAV\Backend\PDO::$addressBooksTableName = 'addressbooks'

The PDO table name used to store addressbooks.

Definition at line 29 of file PDO.php.

◆ $cardsTableName

Sabre\CardDAV\Backend\PDO::$cardsTableName = 'cards'

The PDO table name used to store cards.

Definition at line 34 of file PDO.php.

◆ $pdo

Sabre\CardDAV\Backend\PDO::$pdo

protected

Definition at line 24 of file PDO.php.

Referenced by Sabre\CardDAV\Backend\PDO\__construct().

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

libs/composer/vendor/sabre/dav/lib/CardDAV/Backend/PDO.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addChange()

◆ createAddressBook()

◆ createCard()

◆ deleteAddressBook()

◆ deleteCard()

◆ getAddressBooksForUser()

◆ getCard()

◆ getCards()

◆ getChangesForAddressBook()

◆ getMultipleCards()

◆ updateAddressBook()

◆ updateCard()

Field Documentation

◆ $addressBookChangesTableName

◆ $addressBooksTableName

◆ $cardsTableName

◆ $pdo