Class yii\web\XmlResponseFormatter

继承yii\web\XmlResponseFormatter » yii\base\Component » yii\base\BaseObject
实现yii\base\Configurable, yii\web\ResponseFormatterInterface
可用自版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/web/XmlResponseFormatter.php

XmlResponseFormatter 将给定的数据格式化为 XML 响应内容.

yii\web\Response 使用它来格式化响应数据.

公共属性

隐藏继承的属性

属性类型描述定义在
$behaviors yii\base\Behavior[] 附加到此组件的行为列表. 该属性是只读的. yii\base\Component
$contentType string 响应的 Content-Type 表头. yii\web\XmlResponseFormatter
$encoding string XML 编码. yii\web\XmlResponseFormatter
$itemTag string 用数字键表示数组元素的元素名称. yii\web\XmlResponseFormatter
$rootTag string 根元素的名称. yii\web\XmlResponseFormatter
$useObjectTags boolean Hi发应添加对象标签. yii\web\XmlResponseFormatter
$useTraversableAsArray boolean 是否将实现 Traversable 接口的对象解释为数组. yii\web\XmlResponseFormatter
$version string XML 版本. yii\web\XmlResponseFormatter

公共方法

隐藏继承的方法

方法描述定义在
__call() 调用不是类方法的指定的方法. yii\base\Component
__clone() 在通过克隆现有对象创建对象之后调用此方法. yii\base\Component
__construct() 构造函数. yii\base\BaseObject
__get() 返回组件属性的值. yii\base\Component
__isset() 检查属性是否已设置, 即已定义且不为null. yii\base\Component
__set() 设置组件属性的值. yii\base\Component
__unset() 将组件属性设置为null. yii\base\Component
attachBehavior() 将行为附加到此组件. yii\base\Component
attachBehaviors() 将行为列表附加到组件. yii\base\Component
behaviors() 返回此组件应该具有的行为列表. yii\base\Component
canGetProperty() 返回一个值, 指示属性是否可读取. yii\base\Component
canSetProperty() 返回一个值, 指示属性是否可设置. yii\base\Component
className() 返回此类的完全限定名称. yii\base\BaseObject
detachBehavior() 从组件中分离一个行为. yii\base\Component
detachBehaviors() 分离组件中的所有行为. yii\base\Component
ensureBehaviors() 确保在 behaviors() 中声明的行为已附加到此组件. yii\base\Component
format() 格式化指定的响应. yii\web\XmlResponseFormatter
getBehavior() 返回指定的行为对象. yii\base\Component
getBehaviors() 返回附加到此组件的所有行为. yii\base\Component
hasEventHandlers() 返回一个值, 指示是否有任何处理程序附加到指定的事件. yii\base\Component
hasMethod() 返回一个值, 指示方法是否已定义. yii\base\Component
hasProperty() 返回一个值, 指示属性是否已定义. yii\base\Component
init() 初始化对象. yii\base\BaseObject
off() 从该组件分离现有的事件处理程序. yii\base\Component
on() 将事件处理程序附加到事件. yii\base\Component
trigger() 触发事件. yii\base\Component

受保护的方法

隐藏继承的方法

方法描述定义在
buildXml() yii\web\XmlResponseFormatter
formatScalarValue() 格式化要在 XML 文本节点中使用的标量值. yii\web\XmlResponseFormatter
getValidXmlElementName() 如果 name 不为空, 不是数字(int)并且是有效的, 则返回准备在 DOMElement 中使用的元素名称. yii\web\XmlResponseFormatter
isValidXmlName() 检查名称是否有效以在 XML 中使用. yii\web\XmlResponseFormatter

属性详情

$contentType public 属性

响应的 Content-Type 表头.

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

XML 编码. 如果未设置, 它将使用 yii\web\Response::$charset 的值.

public string $encoding null
$itemTag public 属性

用数字键表示数组元素的元素名称.

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

根元素的名称. 如果设置为false, null或空, 则不应添加任何根标记.

public string $rootTag 'response'
$useObjectTags public 属性 (可用自版本: 2.0.11)

Hi发应添加对象标签.

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

是否将实现 Traversable 接口的对象解释为数组. 默认为true.

$version public 属性

XML 版本.

public string $version '1.0'

方法详情

buildXml() protected 方法

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

格式化指定的响应.

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

要格式化的响应.

formatScalarValue() protected 方法 (可用自版本: 2.0.11)

格式化要在 XML 文本节点中使用的标量值.

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

标量值.

return string

值的字符串表示.

getValidXmlElementName() protected 方法 (可用自版本: 2.0.12)

如果 name 不为空, 不是数字(int)并且是有效的, 则返回准备在 DOMElement 中使用的元素名称.

否则就会退回到 $itemTag.

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