ExpandPropertyReport
in package
implements
XmlDeserializable
ExpandProperty request parser.
This class parses the {DAV:}expand-property REPORT, as defined in:
http://tools.ietf.org/html/rfc3253#section-3.8
Tags
Interfaces, Classes and Traits
- XmlDeserializable
- Implementing the XmlDeserializable interface allows you to use a class as a deserializer for a specific element.
Table of Contents
- $properties : array<string|int, mixed>
- An array with requested properties.
- xmlDeserialize() : mixed
- The deserialize method is called during xml parsing.
- traverse() : array<string|int, mixed>
- This method is used by deserializeXml, to recursively parse the {DAV:}property elements.
Properties
$properties
An array with requested properties.
public
array<string|int, mixed>
$properties
The requested properties will be used as keys in this array. The value is normally null.
If the value is an array though, it means the property must be expanded. Within the array, the sub-properties, which themselves may be null or arrays.
Methods
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 —traverse()
This method is used by deserializeXml, to recursively parse the {DAV:}property elements.
private
static traverse(array<string|int, mixed> $elems) : array<string|int, mixed>
Parameters
- $elems : array<string|int, mixed>