Sabre\Xml\Element\XmlFragment Class Reference

The XmlFragment element allows you to extract a portion of your xml tree, and get a well-formed xml string. More...

Inheritance diagram for Sabre\Xml\Element\XmlFragment:

Collaboration diagram for Sabre\Xml\Element\XmlFragment:

Public Member Functions
	__construct ($xml)
	getXml ()
	xmlSerialize (Writer $writer)
	The xmlSerialize metod is called during xml writing. More...

Static Public Member Functions
static	xmlDeserialize (Reader $reader)
	The deserialize method is called during xml parsing. More...

Protected Attributes
	$xml

Detailed Description

The XmlFragment element allows you to extract a portion of your xml tree, and get a well-formed xml string.

This goes a bit beyond innerXml and friends, as we'll also match all the correct namespaces.

Please note that the XML fragment:

1. Will not have an <?xml declaration.
2. Or a DTD
3. It will have all the relevant xmlns attributes.
4. It may not have a root element.

Definition at line 23 of file XmlFragment.php.

Constructor & Destructor Documentation

__construct()

Sabre\Xml\Element\XmlFragment::__construct

(

$xml

)

Definition at line 27 of file XmlFragment.php.

References Sabre\Xml\Element\XmlFragment\$xml.

                               {

        $this->xml = $xml;

    }

Member Function Documentation

getXml()

Sabre\Xml\Element\XmlFragment::getXml

(

)

Definition at line 33 of file XmlFragment.php.

References Sabre\Xml\Element\XmlFragment\$xml.

Referenced by Sabre\Xml\Element\XmlFragment\xmlSerialize().

                      {

        return $this->xml;

    }

Here is the caller graph for this function:

xmlDeserialize()

static Sabre\Xml\Element\XmlFragment::xmlDeserialize ( 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.

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

Returns

mixed

Implements Sabre\Xml\XmlDeserializable.

Definition at line 139 of file XmlFragment.php.

References $result.

                                                   {

        $result = new self($reader->readInnerXml());
        $reader->next();
        return $result;

    }

xmlSerialize()

Sabre\Xml\Element\XmlFragment::xmlSerialize

(

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 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

Returns

void

Implements Sabre\Xml\XmlSerializable.

Definition at line 58 of file XmlFragment.php.

References $reader, Sabre\Xml\Element\XmlFragment\$xml, Sabre\Xml\Element\XmlFragment\getXml(), Sabre\Xml\Writer\startElement(), and Sabre\Xml\Writer\writeAttribute().

                                          {

        $reader = new Reader();

        // Wrapping the xml in a container, so root-less values can still be
        // parsed.
        $xml = <<<XML
<?xml version="1.0"?>
<xml-fragment xmlns="http://sabre.io/ns">{$this->getXml()}</xml-fragment>
XML;

        $reader->xml($xml);

        while ($reader->read()) {

            if ($reader->depth < 1) {
                // Skipping the root node.
                continue;
            }

            switch ($reader->nodeType) {

                case Reader::ELEMENT :
                    $writer->startElement(
                        $reader->getClark()
                    );
                    $empty = $reader->isEmptyElement;
                    while ($reader->moveToNextAttribute()) {
                        switch ($reader->namespaceURI) {
                            case '' :
                                $writer->writeAttribute($reader->localName, $reader->value);
                                break;
                            case 'http://www.w3.org/2000/xmlns/' :
                                // Skip namespace declarations
                                break;
                            default :
                                $writer->writeAttribute($reader->getClark(), $reader->value);
                                break;
                        }
                    }
                    if ($empty) {
                        $writer->endElement();
                    }
                    break;
                case Reader::CDATA :
                case Reader::TEXT :
                    $writer->text(
                        $reader->value
                    );
                    break;
                case Reader::END_ELEMENT :
                    $writer->endElement();
                    break;

            }

        }

    }

Here is the call graph for this function:

Field Documentation

$xml

Sabre\Xml\Element\XmlFragment::$xml

protected

Definition at line 25 of file XmlFragment.php.

Referenced by Sabre\Xml\Element\XmlFragment\__construct(), Sabre\Xml\Element\XmlFragment\getXml(), Sabre\DAV\Xml\Property\Complex\xmlDeserialize(), and Sabre\Xml\Element\XmlFragment\xmlSerialize().

---

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

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