PHP Class yii\web\XmlResponseFormatter

It is used by Response to format response data.

Since: 2.0

Author: Qiang Xue ([email protected])

Inheritance: extends yii\base\Component, implements yii\web\ResponseFormatterInterface

Public Properties

Property	Type	Description
$contentType		the Content-Type header for the response
$encoding		the XML encoding. If not set, it will use the value of [[Response::charset]].
$itemTag		the name of the elements that represent the array elements with numeric keys.
$rootTag		the name of the root element.
$useTraversableAsArray		whether to interpret objects implementing the [[\Traversable]] interface as arrays. Defaults to true.
$version		the XML version

Method	Description
format ( Response $response )	Formats the specified response.

Method	Description
buildXml ( DOMElement $element, mixed $data )
formatScalarValue ( integer \| string \| boolean $value ) : string	Formats scalar value to use in XML text node

protected buildXml ( DOMElement $element, mixed $data )
$element	DOMElement
$data	mixed

Formats the specified response.

public format ( Response $response )
$response	Response	the response to be formatted.

Formats scalar value to use in XML text node

Since: 2.0.11

protected formatScalarValue ( integer \| string \| boolean $value ) : string
$value	integer \| string \| boolean
return	string

the Content-Type header for the response

public $contentType

the XML encoding. If not set, it will use the value of [[Response::charset]].

public $encoding

the name of the elements that represent the array elements with numeric keys.

public $itemTag

the name of the root element.

public $rootTag

whether to interpret objects implementing the [[\Traversable]] interface as arrays. Defaults to true.

Since: 2.0.7

public $useTraversableAsArray

the XML version

public $version