Documentation

SyncCollectionReport
in package

Application

implements XmlDeserializable

SyncCollection request parser.

This class parses the {DAV:}sync-collection reprot, as defined in:

http://tools.ietf.org/html/rfc6578#section-3.2

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

$limit : int|null: Maximum amount of items returned.
$properties : array<string|int, mixed>|null: The list of properties that are being requested for every change.
$syncLevel : int: The 'depth' of the sync the client is interested in.
$syncToken : string|null: The sync-token the client supplied for the report.
xmlDeserialize() : mixed: The deserialize method is called during xml parsing.

Maximum amount of items returned.


    public
        int|null
    $limit

The list of properties that are being requested for every change.


    public
        array<string|int, mixed>|null
    $properties

The 'depth' of the sync the client is interested in.


    public
        int
    $syncLevel

The sync-token the client supplied for the report.


    public
        string|null
    $syncToken

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 —