Documentation

AddressBookMultiGetReport
in package

Application

implements XmlDeserializable

AddressBookMultiGetReport request parser.

This class parses the {urn:ietf:params:xml:ns:carddav}addressbook-multiget REPORT, as defined in:

http://tools.ietf.org/html/rfc6352#section-8.7

XmlDeserializable: Implementing the XmlDeserializable interface allows you to use a class as a deserializer for a specific element.

$contentType : string: The mimetype of the content that should be returend. Usually text/vcard.
$hrefs : array<string|int, mixed>: This is an array with the urls that are being requested.
$properties : array<string|int, mixed>: An array with requested properties.
$version : string: The version of vcard data that should be returned. Usually 3.0, referring to vCard 3.0.
xmlDeserialize() : mixed: The deserialize method is called during xml parsing.

The mimetype of the content that should be returend. Usually text/vcard.


    public
        string
    $contentType
     = null

This is an array with the urls that are being requested.


    public
        array<string|int, mixed>
    $hrefs

An array with requested properties.


    public
        array<string|int, mixed>
    $properties

The version of vcard data that should be returned. Usually 3.0, referring to vCard 3.0.


    public
        string
    $version
     = null

The deserialize method is called during xml parsing.


    public
            static    xmlDeserialize(Reader $reader) : mixed

This method is called statically, this is because in theory this method may be used as a type of constructor, or factory method.

Often you want to return an instance of the current class, but you are free to return other data as well.

You are responsible for advancing the reader to the next element. Not doing anything will result in a never-ending loop.

If you just want to skip parsing for this element altogether, you can just call $reader->next();

$reader->parseInnerTree() will parse the entire sub-tree, and advance to the next element.

mixed —