Inheritance diagram for Sabre\CardDAV\Backend\Mock:

Collaboration diagram for Sabre\CardDAV\Backend\Mock:

Public Member Functions
	__construct ($addressBooks=null, $cards=null)

	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 specfic card. 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...

Public Member Functions inherited from Sabre\CardDAV\Backend\AbstractBackend
	getMultipleCards ($addressBookId, array $uris)
	Returns a list of cards. 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 specfic 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...

Data Fields
	$addressBooks

	$cards

Detailed Description

Definition at line 5 of file Mock.php.

Constructor & Destructor Documentation

◆ __construct()

Sabre\CardDAV\Backend\Mock::__construct	(	$addressBooks = `null`,
		$cards = `null`
	)

Definition at line 10 of file Mock.php.

                                                              {
 
        $this->addressBooks = $addressBooks;
        $this->cards = $cards;
 
        if (is_null($this->addressBooks)) {
            $this->addressBooks = [
                [
                    'id'                => 'foo',
                    'uri'               => 'book1',
                    'principaluri'      => 'principals/user1',
                    '{DAV:}displayname' => 'd-name',
                ],
                [
                    'id'                => 'bar',
                    'uri'               => 'book3',
                    'principaluri'      => 'principals/user1',
                    '{DAV:}displayname' => 'd-name',
                ],
            ];
 
            $card2 = fopen('php://memory', 'r+');
            fwrite($card2, "BEGIN:VCARD\nVERSION:3.0\nUID:45678\nEND:VCARD");
            rewind($card2);
            $this->cards = [
                'foo' => [
                    'card1' => "BEGIN:VCARD\nVERSION:3.0\nUID:12345\nEND:VCARD",
                    'card2' => $card2,
                ],
                'bar' => [
                    'card3' => "BEGIN:VCARD\nVERSION:3.0\nUID:12345\nFN:Test-Card\nEMAIL;TYPE=home:bar@example.org\nEND:VCARD",
                ],
            ];
        }
 
    }

References Sabre\CardDAV\Backend\Mock\$addressBooks, and Sabre\CardDAV\Backend\Mock\$cards.

Member Function Documentation

◆ createAddressBook()

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

Creates a new address book.

This method should return the id of the new address book. The id can be in any format, including ints, strings, arrays or objects.

Parameters

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

Returns: mixed

Implements Sabre\CardDAV\Backend\BackendInterface.

Definition at line 93 of file Mock.php.

                                                                       {
 
        $this->addressBooks[] = array_merge($properties, [
            'id'           => $url,
            'uri'          => $url,
            'principaluri' => $principalUri,
        ]);
 
    }

References $url.

◆ createCard()

Sabre\CardDAV\Backend\Mock::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 207 of file Mock.php.

                                                             {
 
        if (is_resource($cardData)) {
            $cardData = stream_get_contents($cardData);
        }
        $this->cards[$addressBookId][$cardUri] = $cardData;
        return '"' . md5($cardData) . '"';
 
    }

◆ deleteAddressBook()

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

Deletes an entire addressbook and all its contents.

Parameters

mixed $addressBookId

Returns: void

Implements Sabre\CardDAV\Backend\BackendInterface.

Definition at line 103 of file Mock.php.

                                               {
 
        foreach ($this->addressBooks as $key => $value) {
            if ($value['id'] === $addressBookId)
                unset($this->addressBooks[$key]);
        }
        unset($this->cards[$addressBookId]);
 
    }

References $key.

◆ deleteCard()

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

Deletes a card.

Parameters

mixed	$addressBookId
string	$cardUri

Returns: bool

Implements Sabre\CardDAV\Backend\BackendInterface.

Definition at line 252 of file Mock.php.

                                                  {
 
        unset($this->cards[$addressBookId][$cardUri]);
 
    }

◆ getAddressBooksForUser()

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

Returns the list of addressbooks for a specific user.

Every addressbook should have the following properties: id - an arbitrary unique id uri - the 'basename' part of the url principaluri - Same as the passed parameter

Any additional clark-notation property may be passed besides this. Some common ones are : {DAV:}displayname {urn:ietf:params:xml:ns:carddav}addressbook-description {http://calendarserver.org/ns/}getctag

Parameters

string $principalUri

Returns: array

Implements Sabre\CardDAV\Backend\BackendInterface.

Definition at line 48 of file Mock.php.

                                                   {
 
        $books = [];
        foreach ($this->addressBooks as $book) {
            if ($book['principaluri'] === $principalUri) {
                $books[] = $book;
            }
        }
        return $books;
 
    }

◆ getCard()

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

Returns a specfic 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 166 of file Mock.php.

                                               {
 
        if (!isset($this->cards[$addressBookId][$cardUri])) {
            return false;
        }
 
        $data = $this->cards[$addressBookId][$cardUri];
        return [
            'uri'      => $cardUri,
            'carddata' => $data,
            'etag'     => '"' . md5($data) . '"',
            'size'     => strlen($data)
        ];
 
    }

References $data.

◆ getCards()

Sabre\CardDAV\Backend\Mock::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 132 of file Mock.php.

                                      {
 
        $cards = [];
        foreach ($this->cards[$addressBookId] as $uri => $data) {
            if (is_resource($data)) {
                $cards[] = [
                    'uri'      => $uri,
                    'carddata' => $data,
                ];
            } else {
                $cards[] = [
                    'uri'      => $uri,
                    'carddata' => $data,
                    'etag'     => '"' . md5($data) . '"',
                    'size'     => strlen($data)
                ];
            }
        }
        return $cards;
 
    }

References Sabre\CardDAV\Backend\Mock\$cards, and $data.

◆ updateAddressBook()

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

Updates properties for an address book.

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

string	$addressBookId
\Sabre\DAV\PropPatch	$propPatch

Returns: void

Implements Sabre\CardDAV\Backend\BackendInterface.

Definition at line 76 of file Mock.php.

                                                                                {
 
        foreach ($this->addressBooks as &$book) {
            if ($book['id'] !== $addressBookId)
                continue;
 
            $propPatch->handleRemaining(function($mutations) use (&$book) {
                foreach ($mutations as $key => $value) {
                    $book[$key] = $value;
                }
                return true;
            });
 
        }
 
    }

References $key.

◆ updateCard()

Sabre\CardDAV\Backend\Mock::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 242 of file Mock.php.

                                                             {
 
        if (is_resource($cardData)) {
            $cardData = stream_get_contents($cardData);
        }
        $this->cards[$addressBookId][$cardUri] = $cardData;
        return '"' . md5($cardData) . '"';
 
    }

Field Documentation

◆ $addressBooks

Sabre\CardDAV\Backend\Mock::$addressBooks

Definition at line 7 of file Mock.php.

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

◆ $cards

Sabre\CardDAV\Backend\Mock::$cards

Definition at line 8 of file Mock.php.

Referenced by Sabre\CardDAV\Backend\Mock\__construct(), and Sabre\CardDAV\Backend\Mock\getCards().

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

libs/composer/vendor/sabre/dav/tests/Sabre/CardDAV/Backend/Mock.php

Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ createAddressBook()

◆ createCard()

◆ deleteAddressBook()

◆ deleteCard()

◆ getAddressBooksForUser()

◆ getCard()

◆ getCards()

◆ updateAddressBook()

◆ updateCard()

Field Documentation

◆ $addressBooks

◆ $cards