Complex
extends XmlFragment
in package
This class represents a 'complex' property that didn't have a default decoder.
It's basically a container for an xml snippet.
Tags
Table of Contents
- $xml : string
- The inner XML value.
- __construct() : mixed
- Constructor.
- getXml() : string
- Returns the inner XML document.
- xmlDeserialize() : mixed
- The deserialize method is called during xml parsing.
- xmlSerialize() : mixed
- The xmlSerialize metod is called during xml writing.
Properties
$xml
The inner XML value.
protected
string
$xml
Methods
__construct()
Constructor.
public
__construct(string $xml) : mixed
Parameters
- $xml : string
Return values
mixed —getXml()
Returns the inner XML document.
public
getXml() : string
Return values
string —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 xmlSerialize metod is called during xml writing.
public
xmlSerialize(Writer $writer) : mixed
Use the $writer argument to write its own xml serialization.
An important note: do not create a parent element. Any element implementing XmlSerializble should only ever write what's considered its 'inner xml'.
The parent of the current element is responsible for writing a containing element.
This allows serializers to be re-used for different element names.
If you are opening new elements, you must also close them again.
Parameters
- $writer : Writer