Inheritance diagram for Sabre\Xml\Writer:

Collaboration diagram for Sabre\Xml\Writer:

Public Member Functions
	write ($value)
	Writes a value to the output stream. More...

	startElement ($name)
	Opens a new element. More...

	writeElement ($name, $content=null)
	Write a full element tag and it's contents. More...

	writeAttributes (array $attributes)
	Writes a list of attributes. More...

	writeAttribute ($name, $value)
	Writes a new attribute. More...

Protected Attributes
	$adhocNamespaces = []

	$namespacesWritten = false

Detailed Description

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.

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

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

Definition at line 31 of file Writer.php.

Member Function Documentation

◆ startElement()

Sabre\Xml\Writer::startElement ( $name )

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:

<entry xmlns="http://w3.org/2005/Atom">

Parameters

string $name

Returns: bool

Definition at line 121 of file Writer.php.

                                 {
 
        if ($name[0] === '{') {
 
            list($namespace, $localName) =
                Service::parseClarkNotation($name);
 
            if (array_key_exists($namespace, $this->namespaceMap)) {
                $result = $this->startElementNS(
                    $this->namespaceMap[$namespace] === '' ? null : $this->namespaceMap[$namespace],
                    $localName,
                    null
                );
            } else {
 
                // An empty namespace means it's the global namespace. This is
                // allowed, but it mustn't get a prefix.
                if ($namespace === "" || $namespace === null) {
                    $result = $this->startElement($localName);
                    $this->writeAttribute('xmlns', '');
                } else {
                    if (!isset($this->adhocNamespaces[$namespace])) {
                        $this->adhocNamespaces[$namespace] = 'x' . (count($this->adhocNamespaces) + 1);
                    }
                    $result = $this->startElementNS($this->adhocNamespaces[$namespace], $localName, $namespace);
                }
            }
 
        } else {
            $result = parent::startElement($name);
        }
 
        if (!$this->namespacesWritten) {
 
            foreach ($this->namespaceMap as $namespace => $prefix) {
                $this->writeAttribute(($prefix ? 'xmlns:' . $prefix : 'xmlns'), $namespace);
            }
            $this->namespacesWritten = true;
 
        }
 
        return $result;
 
    }

References $name, $namespace, $result, Sabre\Xml\Service\parseClarkNotation(), Sabre\Xml\Writer\startElement(), and Sabre\Xml\Writer\writeAttribute().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write()

Sabre\Xml\Writer::write ( $value )

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", ] ] ]

Parameters

mixed $value

Returns: void

Definition at line 98 of file Writer.php.

                           {
 
        Serializer\standardSerializer($this, $value);
 
    }

References Sabre\Xml\Serializer\standardSerializer().

Referenced by Sabre\Xml\Serializer\standardSerializer(), Sabre\Xml\Writer\writeElement(), Sabre\DAV\Xml\Element\Sharee\xmlSerialize(), Sabre\DAV\Xml\Property\GetLastModified\xmlSerialize(), and Sabre\DAV\Xml\Request\PropPatch\xmlSerialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeAttribute()

Sabre\Xml\Writer::writeAttribute	(	$name,
		$value
	)

Writes a new attribute.

The name may be specified in clark-notation.

Returns true when successful.

Parameters

string	$name
string	$value

Returns: bool

Definition at line 230 of file Writer.php.

                                           {
 
        if ($name[0] === '{') {
 
            list(
                $namespace,
                $localName
            ) = Service::parseClarkNotation($name);
 
            if (array_key_exists($namespace, $this->namespaceMap)) {
                // It's an attribute with a namespace we know
                $this->writeAttribute(
                    $this->namespaceMap[$namespace] . ':' . $localName,
                    $value
                );
            } else {
 
                // We don't know the namespace, we must add it in-line
                if (!isset($this->adhocNamespaces[$namespace])) {
                    $this->adhocNamespaces[$namespace] = 'x' . (count($this->adhocNamespaces) + 1);
                }
                $this->writeAttributeNS(
                    $this->adhocNamespaces[$namespace],
                    $localName,
                    $namespace,
                    $value
                );
 
            }
 
        } else {
            return parent::writeAttribute($name, $value);
        }
 
    }

References $name, $namespace, Sabre\Xml\Service\parseClarkNotation(), and Sabre\Xml\Writer\writeAttribute().

Referenced by Sabre\Xml\Writer\startElement(), Sabre\Xml\Writer\writeAttribute(), Sabre\Xml\Writer\writeAttributes(), Sabre\CalDAV\Xml\Notification\SystemStatus\xmlSerialize(), Sabre\DAV\Xml\Property\SupportedMethodSet\xmlSerialize(), Sabre\Xml\Element\XmlFragment\xmlSerialize(), and Sabre\CalDAV\Xml\Notification\SystemStatus\xmlSerializeFull().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeAttributes()

Sabre\Xml\Writer::writeAttributes ( array $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.

Parameters

array $attributes

Returns: void

Definition at line 211 of file Writer.php.

                                                {
 
        foreach ($attributes as $name => $value) {
            $this->writeAttribute($name, $value);
        }
 
    }

References $attributes, $name, and Sabre\Xml\Writer\writeAttribute().

Referenced by Sabre\Xml\Serializer\standardSerializer(), Sabre\CalDAV\Xml\Property\SupportedCalendarComponentSet\xmlSerialize(), Sabre\CalDAV\Xml\Property\SupportedCalendarData\xmlSerialize(), and Sabre\CardDAV\Xml\Property\SupportedAddressData\xmlSerialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeElement()

Sabre\Xml\Writer::writeElement	(	$name,
		$content = `null`
	)

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: <author xmlns="http://www.w3.org/2005" >

$writer->writeElement('{http://www.w3.org/2005/Atom}author', [ '{http://www.w3.org/2005/Atom}name' => 'Evert Pot', ]); becomes: <author xmlns="http://www.w3.org/2005" ><name>Evert Pot</name></author>

Parameters

string	$name
string	$content

Returns: bool

Definition at line 189 of file Writer.php.

                                                  {
 
        $this->startElement($name);
        if (!is_null($content)) {
            $this->write($content);
        }
        $this->endElement();
 
    }

References $name, Sabre\Xml\Writer\startElement(), and Sabre\Xml\Writer\write().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $adhocNamespaces

Sabre\Xml\Writer::$adhocNamespaces = []

protected

Definition at line 44 of file Writer.php.

◆ $namespacesWritten

Sabre\Xml\Writer::$namespacesWritten = false

protected

Definition at line 54 of file Writer.php.

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

libs/composer/vendor/sabre/xml/lib/Writer.php

Public Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ startElement()

◆ write()

◆ writeAttribute()

◆ writeAttributes()

◆ writeElement()

Field Documentation

◆ $adhocNamespaces

◆ $namespacesWritten