Class Sabre\Xml\Writer

`extends`	`XMLWriter`
`uses`	`ContextStackTrait`

The XML Writer class.

This class works exactly as PHP's built-in XMLWriter, with a few additions.

Namespaces can be registered beforehand, globally. When the first element is written, namespaces will automatically be declared.

The writeAttribute, startElement and writeElement can now take a clark-notation element name (example: {http://www.w3.org/2005/Atom}link).

If, when writing the namespace is a known one a prefix will automatically be selected, otherwise a random prefix will be generated.

Instead of standard string values, the writer can take Element classes (as defined by this library) to delegate the serialization.

The write() method can take array structures to quickly write out simple xml trees.

XMLWriter
- Sabre\Xml\Writer uses ContextStackTrait

Methods
`public`	`write(mixed $value)` Writes a value to the output stream. Writes a value to the output stream. The following values are supported: Scalar values will be written as-is, as text. Null values will be skipped (resulting in a short xml tag). If a value is an instance of an Element class, writing will be delegated to the object. If a value is an array, two formats are supported. Array format 1: [ "{namespace}name1" => "..", "{namespace}name2" => "..", ] One element will be created for each key in this array. The values of this array support any format this method supports (this method is called recursively). Array format 2: [ [ "name" => "{namespace}name1" "value" => "..", "attributes" => [ "attr" => "attribute value", ] ], [ "name" => "{namespace}name1" "value" => "..", "attributes" => [ "attr" => "attribute value", ] ] ]	#
`public`	`startElement(string $name): bool` Opens a new element. Opens a new element. You can either just use a local elementname, or you can use clark- notation to start a new element. Example: $writer->startElement('{http://www.w3.org/2005/Atom}entry'); Would result in something like: Note: this function doesn't have the string typehint, because PHP's XMLWriter::startElement doesn't either. Overrides `XMLWriter::startElement()`	#
`public`	`writeElement($name, array\|string\|object\|null $content = null): bool` Write a full element tag and it's contents. Write a full element tag and it's contents. This method automatically closes the element as well. The element name may be specified in clark-notation. Examples: $writer->writeElement('{http://www.w3.org/2005/Atom}author',null); becomes: $writer->writeElement('{http://www.w3.org/2005/Atom}author', [ '{http://www.w3.org/2005/Atom}name' => 'Evert Pot', ]); becomes: Evert Pot Note: this function doesn't have the string typehint, because PHP's XMLWriter::startElement doesn't either. Overrides `XMLWriter::writeElement()`	#
`public`	`writeAttributes(array $attributes)` Writes a list of attributes. Writes a list of attributes. Attributes are specified as a key->value array. The key is an attribute name. If the key is a 'localName', the current xml namespace is assumed. If it's a 'clark notation key', this namespace will be used instead.	#
`public`	`writeAttribute(string $name, string $value): bool` Writes a new attribute. Writes a new attribute. The name may be specified in clark-notation. Returns true when successful. Note: this function doesn't have typehints, because for some reason PHP's XMLWriter::writeAttribute doesn't either. Overrides `XMLWriter::writeAttribute()`	#

Methods inherited from XMLWriter
openUri(), openMemory(), setIndent(), setIndentString(), startComment(), endComment(), startAttribute(), endAttribute(), startAttributeNs(), writeAttributeNs(), endElement(), fullEndElement(), startElementNs(), writeElementNs(), startPi(), endPi(), writePi(), startCdata(), endCdata(), writeCdata(), text(), writeRaw(), startDocument(), endDocument(), writeComment(), startDtd(), endDtd(), writeDtd(), startDtdElement(), endDtdElement(), writeDtdElement(), startDtdAttlist(), endDtdAttlist(), writeDtdAttlist(), startDtdEntity(), endDtdEntity(), writeDtdEntity(), outputMemory(), flush()

Methods inherited from XMLWriter

openUri(), openMemory(), setIndent(), setIndentString(), startComment(), endComment(), startAttribute(), endAttribute(), startAttributeNs(), writeAttributeNs(), endElement(), fullEndElement(), startElementNs(), writeElementNs(), startPi(), endPi(), writePi(), startCdata(), endCdata(), writeCdata(), text(), writeRaw(), startDocument(), endDocument(), writeComment(), startDtd(), endDtd(), writeDtd(), startDtdElement(), endDtdElement(), writeDtdElement(), startDtdAttlist(), endDtdAttlist(), writeDtdAttlist(), startDtdEntity(), endDtdEntity(), writeDtdEntity(), outputMemory(), flush()

Methods used from Sabre\Xml\ContextStackTrait
`pushContext(), popContext()`

Properties used from Sabre\Xml\ContextStackTrait
`$elementMap, $contextUri, $namespaceMap, $classMap`

Namespaces

Classes

Interfaces

Traits

Exceptions

Class Sabre\Xml\Writer

Overrides

Overrides

Overrides