Documentation

Mock
in package
implements Element

Interfaces, Classes and Traits

Element
This is the XML element interface.

Table of Contents

xmlDeserialize()  : mixed
The deserialize method is called during xml parsing.
xmlSerialize()  : mixed
The serialize method is called during xml writing.

Methods

xmlDeserialize()

The deserialize method is called during xml parsing.

public static xmlDeserialize(Reader $reader) : mixed

This method is called statictly, 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.

Important note 2: 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->parseSubTree() 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
Return values
mixed

Search results