Skip to content

XmlFragment

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.

  5. Full name: \Sabre\Xml\Element\XmlFragment

  6. This class implements: \Sabre\Xml\Element

Properties

xml

The inner XML value.

protected string $xml

Methods

__construct

Constructor.

public __construct(string $xml): mixed

Parameters:

Parameter Type Description
$xml string

getXml

Returns the inner XML document.

public getXml(): string

xmlSerialize

The xmlSerialize method is called during xml writing.

public xmlSerialize(\Sabre\Xml\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 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:

Parameter Type Description
$writer \Sabre\Xml\Writer

xmlDeserialize

The deserialize method is called during xml parsing.

public static xmlDeserialize(\Sabre\Xml\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.

  • This method is static.

Parameters:

Parameter Type Description
$reader \Sabre\Xml\Reader

Automatically generated on 2025-03-18