Documentation

CalendarMultiGetReport
in package

Application

implements XmlDeserializable

CalendarMultiGetReport request parser.

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

https://tools.ietf.org/html/rfc4791#section-7.9

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/calendar.
$expand : array<string|int, mixed>|null: If the calendar data must be expanded, this will contain an array with 2 elements: start and end.
$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 calendar-data that should be returned. Usually '2.0', referring to iCalendar 2.0.
xmlDeserialize() : mixed: The deserialize method is called during xml parsing.

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


    public
        string
    $contentType
     = null

If the calendar data must be expanded, this will contain an array with 2 elements: start and end.


    public
        array<string|int, mixed>|null
    $expand
     = null

Each may be a DateTime or 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 calendar-data that should be returned. Usually '2.0', referring to iCalendar 2.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 —