Класс yii\web\XmlResponseFormatter

Все классы | Свойства | Методы

Наследование	yii\web\XmlResponseFormatter » yii\base\Component » yii\base\Object
Реализует	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	строка	Заголовок Content-Type для ответа	yii\web\XmlResponseFormatter
$encoding	строка	Кодировка XML.	yii\web\XmlResponseFormatter
$itemTag	строка	Имя элементов, представляющих элементы массива с числовыми ключами.	yii\web\XmlResponseFormatter
$rootTag	строка	Имя корневого элемента.	yii\web\XmlResponseFormatter
$useObjectTags	логическое значение	Добавлять теги объектов	yii\web\XmlResponseFormatter
$useTraversableAsArray	логическое значение	Интерпретировать объекты, реализующие интерфейс Traversable, как массивы.	yii\web\XmlResponseFormatter
$version	строка	Версия XML	yii\web\XmlResponseFormatter

Публичные методы

Метод	Описание	Определено в
__call()	Вызывает именованный метод, который не является методом класса.	yii\base\Component
__clone()	Этот метод вызывается после создания объекта путем клонирования существующего.	yii\base\Component
__construct()	Конструктор.	yii\base\Object
__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\Object
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\Object
off()	Отсоединяет существующий обработчик событий от этого компонента.	yii\base\Component
on()	Присоединяет обработчик событий к событию.	yii\base\Component
trigger()	Вызывает событие.	yii\base\Component

Защищённые методы

Метод	Описание	Определено в
buildXml()		yii\web\XmlResponseFormatter
formatScalarValue()	Форматирует скалярное значение для использования в текстовом узле XML	yii\web\XmlResponseFormatter
getValidXmlElementName()	Возвращает имя элемента, готовое для использования в DOMElement, если имя не пустое, не является целым числом и является допустимым.	yii\web\XmlResponseFormatter
isValidXmlName()	Проверяет, является ли имя допустимым для использования в XML	yii\web\XmlResponseFormatter

Подробное описание свойств

$contentType публичное свойство

Заголовок Content-Type для ответа

public string $contentType = 'application/xml'

$encoding публичное свойство

Кодировка XML. Если не задано, будет использовано значение yii\web\Response::$charset.

public string $encoding = null

$itemTag публичное свойство

Имя элементов, представляющих элементы массива с числовыми ключами.

public string $itemTag = 'item'

$rootTag общедоступное свойство

Имя корневого элемента. Если значение равно false, null или пустое, то корневой тег не будет добавлен.

public string $rootTag = 'response'

$useObjectTags общедоступное свойство (доступно начиная с версии 2.0.11)

Добавлять ли теги объектов

public boolean $useObjectTags = true

$useTraversableAsArray общедоступное свойство (доступно начиная с версии 2.0.7)

Интерпретировать ли объекты, реализующие интерфейс Traversable, как массивы. По умолчанию true.

public boolean $useTraversableAsArray = true

$version общедоступное свойство

Версия XML

public string $version = '1.0'

Подробное описание методов

buildXml() защищённый метод

защищённый void buildXml ( $element, $data )
$element	DOMElement
$data	mixed

format() общедоступный метод

Форматирует указанный ответ.

общедоступный void format ( $response )
$response	yii\web\Response	Ответ, подлежащий форматированию.

formatScalarValue() защищённый метод (доступно начиная с версии 2.0.11)

Форматирует скалярное значение для использования в узле текста XML

защищённый string formatScalarValue ( $value )
$value	integer\|string\|boolean

getValidXmlElementName() защищённый метод (доступно начиная с версии 2.0.12)

Возвращает имя элемента, готовое для использования в DOMElement, если имя не пустое, не является целым числом и является допустимым.

В противном случае возвращается значение $itemTag.

защищённый string getValidXmlElementName ( $name )
$name	mixed

isValidXmlName() защищённый метод (доступно начиная с версии 2.0.12)

Проверяет, является ли имя допустимым для использования в XML

См. также http://stackoverflow.com/questions/2519845/how-to-check-if-string-is-a-valid-xml-element-name/2519943#2519943.

защищённый boolean isValidXmlName ( $name )
$name	mixed

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-web-xmlresponseformatter.html