Multistatus
in package
implements
XmlDeserializable
Represents XML DAV:multistatus elements as PHP objects (RFC 4918).
The response child elements can be of two types, response elements containing a propstat (ResponsePropstat) or reponse elements containing a status (@{see ResponseStatus}). Depending on the request, either on response type is expected or a mixture of both is possible. This class has a template parameter that allows to define the specific expected response type.
From RFC 4918: The ’multistatus’ root element holds zero or more ’response’ elements in any order, each with information about an individual resource.
RFC 6578 adds the sync-token child element:
<!ELEMENT multistatus (response*, responsedescription?, sync-token?) >
Tags
Interfaces, Classes and Traits
- XmlDeserializable
Table of Contents
- $responses : array<int, Response>
- The reponse children of this multistatus element.
- $synctoken : string|null
- The optional sync-token child element of this multistatus.
- __construct() : mixed
- xmlDeserialize() : Multistatus
- Deserializes the child elements of a DAV:multistatus element and creates a new instance of Multistatus.
Properties
$responses
The reponse children of this multistatus element.
public
array<int, Response>
$responses
= []
Tags
$synctoken
The optional sync-token child element of this multistatus.
public
string|null
$synctoken
Methods
__construct()
public
__construct(array<int, Response> $responses, string|null $synctoken) : mixed
Parameters
- $responses : array<int, Response>
- $synctoken : string|null
Tags
Return values
mixed —xmlDeserialize()
Deserializes the child elements of a DAV:multistatus element and creates a new instance of Multistatus.
public
static xmlDeserialize(Reader $reader) : Multistatus
Parameters
- $reader : Reader