Class yii\web\XmlResponseFormatter

Inheritanceyii\web\XmlResponseFormatter » yii\base\Component » yii\base\Object
Implementsyii\base\Configurable, yii\web\ResponseFormatterInterface
Available since version2.0
Source Code https://github.com/yiisoft/yii2/blob/master/framework/web/XmlResponseFormatter.php

XmlResponseFormatter formats the given data into an XML response content.

It is used by yii\web\Response to format response data.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$behaviors yii\base\Behavior[] List of behaviors attached to this component yii\base\Component
$contentType string The Content-Type header for the response yii\web\XmlResponseFormatter
$encoding string The XML encoding. yii\web\XmlResponseFormatter
$itemTag string The name of the elements that represent the array elements with numeric keys. yii\web\XmlResponseFormatter
$rootTag string The name of the root element. yii\web\XmlResponseFormatter
$useObjectTags boolean If object tags should be added yii\web\XmlResponseFormatter
$useTraversableAsArray boolean Whether to interpret objects implementing the Traversable interface as arrays. yii\web\XmlResponseFormatter
$version string The XML version yii\web\XmlResponseFormatter

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__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
__construct() Constructor. yii\base\Object
__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() Returns the fully qualified name of this class. yii\base\Object
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. yii\web\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\Object
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

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
buildXml() yii\web\XmlResponseFormatter
formatScalarValue() Formats scalar value to use in XML text node yii\web\XmlResponseFormatter

Property Details

$contentType public property

The Content-Type header for the response

public string $contentType 'application/xml'
$encoding public property

The XML encoding. If not set, it will use the value of yii\web\Response::$charset.

public string $encoding null
$itemTag public property

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

public string $itemTag 'item'
$rootTag public property

The name of the root element. If set to false, null or is empty then no root tag should be added.

public string $rootTag 'response'
$useObjectTags public property (available since version 2.0.11)

If object tags should be added

public boolean $useObjectTags true
$useTraversableAsArray public property (available since version 2.0.7)

Whether to interpret objects implementing the Traversable interface as arrays. Defaults to true.

$version public property

The XML version

public string $version '1.0'

Method Details

buildXml() protected method

protected void buildXml ( $element, $data )
$element DOMElement
$data mixed
format() public method

Formats the specified response.

public void format ( $response )
$response yii\web\Response

The response to be formatted.

formatScalarValue() protected method (available since version 2.0.11)

Formats scalar value to use in XML text node

protected string formatScalarValue ( $value )
$value integer|string|boolean