XmlResponseFormatter

API reference › yii › web › XmlResponseFormatter

class	`yii\web\XmlResponseFormatter`
Extends	`yii\base\Component` » `yii\base\BaseObject`
Implements	`ResponseFormatterInterface`, `yii\base\Configurable`
Since	2.0
Source	`framework/web/XmlResponseFormatter.php`

XmlResponseFormatter formats the given data into an XML response content.

It is used by Response to format response data.

Properties

Property	Type	Description	Defined by
`$behaviors` read-only	`array<yii\base\Behavior<static>>`	List of behaviors attached to this component.	`yii\base\Component`
`$contentType`	`string`	The Content-Type header for the response Default: `'application/xml'`.	`XmlResponseFormatter`
`$encoding`	`string\|null`	The XML encoding. Default: `null`.	`XmlResponseFormatter`
`$itemTag`	`string`	The name of the elements that represent the array elements with numeric keys. Default: `'item'`.	`XmlResponseFormatter`
`$objectTagToLowercase`	`bool`	If true, converts object tags to lowercase, `$useObjectTags` must be enabled Default: `false`. Available since 2.0.43.	`XmlResponseFormatter`
`$rootTag`	`string\|string[]\|null\|false`	The name of the root element. Default: `'response'`.	`XmlResponseFormatter`
`$useObjectTags`	`bool`	If object class names should be used as tag names Default: `true`. Available since 2.0.11.	`XmlResponseFormatter`
`$useTraversableAsArray`	`bool`	Whether to interpret objects implementing the `Traversable` interface as arrays. Default: `true`. Available since 2.0.7.	`XmlResponseFormatter`
`$version`	`string`	The XML version Default: `'1.0'`.	`XmlResponseFormatter`
`$dom` protected	`DOMDocument`	The XML document, serves as the root of the document tree Default: `null`. Available since 2.0.43.	`XmlResponseFormatter`

Methods

Method	Description	Defined by
`__construct()`	Constructor.	`yii\base\BaseObject`
`__call()`	Calls the named method which is not a class method.	`yii\base\Component`
`__clone()`	This method is called after the object is created by cloning an existing one.	`yii\base\Component`
`__get()`	Returns the value of a component property.	`yii\base\Component`
`__isset()`	Checks if a property is set, i.e. defined and not null.	`yii\base\Component`
`__set()`	Sets the value of a component property.	`yii\base\Component`
`__unset()`	Sets a component property to be null.	`yii\base\Component`
`attachBehavior()`	Attaches a behavior to this component.	`yii\base\Component`
`attachBehaviors()`	Attaches a list of behaviors to the component.	`yii\base\Component`
`behaviors()`	Returns a list of behaviors that this component should behave as.	`yii\base\Component`
`canGetProperty()`	Returns a value indicating whether a property can be read.	`yii\base\Component`
`canSetProperty()`	Returns a value indicating whether a property can be set.	`yii\base\Component`
`className()` static	Returns the fully qualified name of this class.	`yii\base\BaseObject`
`detachBehavior()`	Detaches a behavior from the component.	`yii\base\Component`
`detachBehaviors()`	Detaches all behaviors from the component.	`yii\base\Component`
`ensureBehaviors()`	Makes sure that the behaviors declared in `behaviors()` are attached to this component.	`yii\base\Component`
`format()`	Formats the specified response.	`XmlResponseFormatter`
`getBehavior()`	Returns the named behavior object.	`yii\base\Component`
`getBehaviors()`	Returns all behaviors attached to this component.	`yii\base\Component`
`hasEventHandlers()`	Returns a value indicating whether there is any handler attached to the named event.	`yii\base\Component`
`hasMethod()`	Returns a value indicating whether a method is defined.	`yii\base\Component`
`hasProperty()`	Returns a value indicating whether a property is defined for this component.	`yii\base\Component`
`init()`	Initializes the object.	`yii\base\BaseObject`
`off()`	Detaches an existing event handler from this component.	`yii\base\Component`
`on()`	Attaches an event handler to an event.	`yii\base\Component`
`trigger()`	Triggers an event.	`yii\base\Component`
`buildXml()` protected	Recursively adds data to XML document.	`XmlResponseFormatter`
`formatScalarValue()` protected	Formats scalar value to use in XML text node.	`XmlResponseFormatter`
`getValidXmlElementName()` protected	Returns element name ready to be used in DOMElement if name is not empty, is not int and is valid.	`XmlResponseFormatter`
`isValidXmlName()` protected	Checks if name is valid to be used in XML.	`XmlResponseFormatter`

Property details

$encoding

public string|null $encoding = null

The XML encoding.

If not set, it will use the value of Response::$charset.

$rootTag

public string|string[]|null|false $rootTag = 'response'

The name of the root element.

If set to false, null or is empty then no root tag should be added.

Since 2.0.44 URI namespace could be specified by passing [namespace, tag name] array.

$useTraversableAsArray

public bool $useTraversableAsArray = true

Whether to interpret objects implementing the Traversable interface as arrays.

Defaults to true.

Since

2.0.7

Method details

format()

public function format(yii\web\Response $response): mixed

Formats the specified response.

Parameters

Parameter	Type	Description
`$response`	`Response`	The response to be formatted.

Returns

mixed

buildXml()

protected function buildXml(DOMElement|DOMDocument $element, mixed $data): mixed

Recursively adds data to XML document.

Parameters

Parameter	Type	Description
`$element`	`DOMElement\|DOMDocument`	Current element
`$data`	`mixed`	Content of the current element

Returns

mixed

formatScalarValue()

protected function formatScalarValue(int|string|bool|float $value): string

Formats scalar value to use in XML text node.

Parameters

Parameter	Type	Description
`$value`	`int\|string\|bool\|float`	A scalar value.

Returns

string: String representation of the value.

Since

2.0.11

getValidXmlElementName()

protected function getValidXmlElementName(mixed $name): string

Returns element name ready to be used in DOMElement if name is not empty, is not int and is valid.

Falls back to $itemTag otherwise.

Parameters

Parameter	Type	Description
`$name`	`mixed`	The original name

Returns

string

Since

2.0.12

isValidXmlName()

protected function isValidXmlName(mixed $name): bool

Checks if name is valid to be used in XML.

Parameters

Parameter	Type	Description
`$name`	`mixed`	The name to test

Returns

bool

Since

2.0.12

See also

https://stackoverflow.com/questions/2519845/how-to-check-if-string-is-a-valid-xml-element-name/2519943#2519943