MultiStatus
in package
implements
Element
WebDAV MultiStatus parser.
This class parses the {DAV:}multistatus response, as defined in: https://tools.ietf.org/html/rfc4918#section-14.16
And it also adds the {DAV:}synctoken change from: http://tools.ietf.org/html/rfc6578#section-6.4
Tags
Interfaces, Classes and Traits
- Element
- This is the XML element interface.
Table of Contents
- $responses : array<string|int, Response>
- The responses.
- $syncToken : string
- A sync token (from RFC6578).
- __construct() : mixed
- Constructor.
- getResponses() : array<string|int, Response>
- Returns the response list.
- getSyncToken() : string|null
- Returns the sync-token, if available.
- xmlDeserialize() : mixed
- The deserialize method is called during xml parsing.
- xmlSerialize() : mixed
- The serialize method is called during xml writing.
Properties
$responses
The responses.
protected
array<string|int, Response>
$responses
$syncToken
A sync token (from RFC6578).
protected
string
$syncToken
Methods
__construct()
Constructor.
public
__construct(array<string|int, Response> $responses[, string $syncToken = null ]) : mixed
Parameters
- $responses : array<string|int, Response>
- $syncToken : string = null
Return values
mixed —getResponses()
Returns the response list.
public
getResponses() : array<string|int, Response>
Return values
array<string|int, Response> —getSyncToken()
Returns the sync-token, if available.
public
getSyncToken() : string|null
Return values
string|null —xmlDeserialize()
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.
Parameters
- $reader : Reader
Return values
mixed —xmlSerialize()
The serialize method is called during xml writing.
public
xmlSerialize(Writer $writer) : mixed
It should use the $writer argument to encode this object into XML.
Important note: it is not needed to create the parent element. The parent element is already created, and we only have to worry about attributes, child elements and text (if any).
Important note 2: If you are writing any new elements, you are also responsible for closing them.
Parameters
- $writer : Writer