Класс yii\httpclient\XmlFormatter
| Наследование | yii\httpclient\XmlFormatter » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable, yii\httpclient\FormatterInterface |
| Доступна с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2-httpclient/blob/master/XmlFormatter.php |
XmlFormatter форматирует HTTP-сообщение в XML.
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $contentType | string | Заголовок Content-Type для ответа | yii\httpclient\XmlFormatter |
| $encoding | string | Кодировка XML. | yii\httpclient\XmlFormatter |
| $itemTag | string | Имя тегов, представляющих элементы массива с числовыми ключами. | yii\httpclient\XmlFormatter |
| $rootTag | string | Имя корневого элемента. | yii\httpclient\XmlFormatter |
| $useTraversableAsArray | boolean | Интерпретировать ли объекты, реализующие интерфейс Traversable, как массивы. | yii\httpclient\XmlFormatter |
| $version | string | Версия XML | yii\httpclient\XmlFormatter |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | yii\base\Object |
| __construct() | Конструктор. | yii\base\Object |
| __get() | Возвращает значение свойства объекта. | yii\base\Object |
| __isset() | Проверяет, установлено ли свойство, т.е. определено и не равно null. | yii\base\Object |
| __set() | Устанавливает значение свойства объекта. | yii\base\Object |
| __unset() | Устанавливает свойство объекта в null. | yii\base\Object |
| canGetProperty() | Возвращает значение, указывающее, можно ли считать свойство. | yii\base\Object |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Object |
| className() | Возвращает полное имя этого класса. | yii\base\Object |
| format() | Форматирует данное HTTP-запрос сообщение. | yii\httpclient\XmlFormatter |
| hasMethod() | Возвращает значение, указывающее, определён ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует объект. | yii\base\Object |
Защищенные методы
| Метод | Описание | Определено в |
|---|---|---|
| buildXml() | yii\httpclient\XmlFormatter |
Подробности о свойствах
$contentType публичное свойство
Заголовок Content-Type для ответа
public string $contentType = 'application/xml'
$encoding публичное свойство
Кодировка XML. Если не задано, используется значение yii\base\Application::$charset.
public string $encoding = null
$itemTag публичное свойство (доступно с версии 2.0.1)
Имя тегов, представляющих элементы массива с числовыми ключами.
public string $itemTag = 'item'
$rootTag публичное свойство
Имя корневого элемента.
public string $rootTag = 'request'
$useTraversableAsArray публичное свойство (доступно с версии 2.0.1)
Интерпретировать ли объекты, реализующие интерфейс Traversable, как массивы. По умолчанию true.
public boolean $useTraversableAsArray = true
$version публичное свойство
Версия XML
public string $version = '1.0'
Подробности о методах
buildXml() защищенный метод
| защищенный void buildXml ( $element, $data ) | ||
|---|---|---|
| $element | DOMElement | |
| $data | mixed | |
format() публичный метод
Форматирует данное HTTP-запрос сообщение.
| публичный yii\httpclient\Request format ( yii\httpclient\Request $request ) | ||
|---|---|---|
| $request | yii\httpclient\Request |
Экземпляр HTTP-запроса. |
| return | yii\httpclient\Request |
Отформатированный запрос. |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-httpclient-xmlformatter.html
