Sabre\Xml\Element\Base Class Reference

The Base XML element is the standard parser & generator that's used by the XML reader and writer. More...

Inheritance diagram for Sabre\Xml\Element\Base:

Collaboration diagram for Sabre\Xml\Element\Base:

Public Member Functions
	__construct ($value=null)
	Constructor. More...
	xmlSerialize (Xml\Writer $writer)
	The xmlSerialize metod is called during xml writing. More...
Public Member Functions inherited from Sabre\Xml\XmlSerializable
	xmlSerialize (Writer $writer)
	The xmlSerialize method is called during xml writing. More...

Static Public Member Functions
static	xmlDeserialize (Xml\Reader $reader)
	The deserialize method is called during xml parsing. More...
Static Public Member Functions inherited from Sabre\Xml\XmlDeserializable
static	xmlDeserialize (Reader $reader)
	The deserialize method is called during xml parsing. More...

Protected Attributes
	$value

Detailed Description

The Base XML element is the standard parser & generator that's used by the XML reader and writer.

It spits out a simple PHP array structure during deserialization, that can also be directly injected back into Writer::write.

Copyright

Copyright (C) 2009-2015 fruux GmbH (https://fruux.com/).

Author

Evert Pot (http://evertpot.com/) http://sabre.io/license/ Modified BSD License

Definition at line 18 of file Base.php.

Constructor & Destructor Documentation

__construct()

Sabre\Xml\Element\Base::__construct

(

$value = null

)

Constructor.

Parameters

mixed

$value

Definition at line 32 of file Base.php.

References Sabre\Xml\Element\Base\$value.

                                        {

        $this->value = $value;

    }

Member Function Documentation

xmlDeserialize()

static Sabre\Xml\Element\Base::xmlDeserialize ( Xml\Reader  $reader )

static

The deserialize method is called during xml parsing.

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->parseInnerTree() will parse the entire sub-tree, and advance to the next element.

Parameters

Xml\Reader

$reader

Returns

mixed

Definition at line 84 of file Base.php.

                                                       {

        $subTree = $reader->parseInnerTree();
        return $subTree;

    }

xmlSerialize()

Sabre\Xml\Element\Base::xmlSerialize

(

Xml\Writer

$writer

)

The xmlSerialize metod is called during xml writing.

Use the $writer argument to write its own xml serialization.

An important note: do not create a parent element. Any element implementing XmlSerializable 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

Returns

void

Definition at line 57 of file Base.php.

                                              {

        $writer->write($this->value);

    }

Field Documentation

$value

Sabre\Xml\Element\Base::$value

protected

Definition at line 25 of file Base.php.

Referenced by Sabre\Xml\Element\Base\__construct().

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/sabre/xml/lib/Element/Base.php