没有命名空间的类 yii yii\base yii\behaviors yii\caching yii\captcha yii\console yii\console\controllers yii\console\widgets yii\data yii\db yii\db\conditions yii\db\cubrid yii\db\cubrid\conditions yii\db\mssql yii\db\mssql\conditions yii\db\mysql yii\db\oci yii\db\oci\conditions yii\db\pgsql yii\db\sqlite yii\db\sqlite\conditions yii\di yii\filters yii\filters\auth yii\grid yii\helpers yii\i18n yii\log yii\mail yii\mutex yii\rbac yii\rest yii\test yii\validators yii\web yii\widgets

Class yii\web\XmlResponseFormatter

继承yii\web\XmlResponseFormatter » yii\base\Component » yii\base\BaseObject
实现yii\base\Configurable, yii\web\ResponseFormatterInterface
可用版本自2.0
源码 https://github.com/yiichina/yii2/blob/api/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.

公共属性

隐藏继承的属性

属性类型描述被定义在
$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

公共方法

隐藏继承的方法

方法描述被定义在
__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\BaseObject
__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\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. 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\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() yii\web\XmlResponseFormatter
formatScalarValue() Formats scalar value to use in XML text node. yii\web\XmlResponseFormatter
getValidXmlElementName() Returns element name ready to be used in DOMElement if name is not empty, is not int and is valid. yii\web\XmlResponseFormatter
isValidXmlName() Checks if name is valid to be used in XML. yii\web\XmlResponseFormatter

属性详情

$contentType 公共 属性

The Content-Type header for the response

public string $contentType 'application/xml'
$encoding 公共 属性

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

public string $encoding null
$itemTag 公共 属性

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

public string $itemTag 'item'
$rootTag 公共 属性

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 公共 属性 (自版本 2.0.11 可用)

If object tags should be added

public boolean $useObjectTags true
$useTraversableAsArray 公共 属性 (自版本 2.0.7 可用)

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

$version 公共 属性

The XML version

public string $version '1.0'

方法详情

buildXml() 受保护 方法

protected void buildXml($element, $data)
$element DOMElement
$data mixed
format() 公共 方法

Formats the specified response.

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

The response to be formatted.

formatScalarValue() 受保护 方法 (自版本 2.0.11 可用)

Formats scalar value to use in XML text node.

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

A scalar value.

return string

String representation of the value.

getValidXmlElementName() 受保护 方法 (自版本 2.0.12 可用)

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.

protected string getValidXmlElementName($name)
$name mixed
isValidXmlName() 受保护 方法 (自版本 2.0.12 可用)
protected boolean isValidXmlName($name)
$name mixed