Prop
in package
implements
XmlDeserializable
This class is responsible for decoding the {DAV:}prop element as it appears in {DAV:}property-update.
This class doesn't return an instance of itself. It just returns a key->value array.
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
- xmlDeserialize() : mixed
- The deserialize method is called during xml parsing.
- parseCurrentElement() : array<string|int, mixed>
- This function behaves similar to Sabre\Xml\Reader::parseCurrentElement, but instead of creating deep xml array structures, it will turn any top-level element it doesn't recognize into either a string, or an XmlFragment class.
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 —parseCurrentElement()
This function behaves similar to Sabre\Xml\Reader::parseCurrentElement, but instead of creating deep xml array structures, it will turn any top-level element it doesn't recognize into either a string, or an XmlFragment class.
private
static parseCurrentElement(Reader $reader) : array<string|int, mixed>
This method returns arn array with 2 properties:
- name - A clark-notation XML element name.
- value - The parsed value.
Parameters
- $reader : Reader