Class yii\httpclient\XmlFormatter
Inheritance | yii\httpclient\XmlFormatter » yii\base\BaseObject |
---|---|
Implements | yii\httpclient\FormatterInterface |
Available since version | 2.0 |
XmlFormatter formats HTTP message as XML.
Public Properties
Property | Type | Description | Defined By |
---|---|---|---|
$contentType | string | The Content-Type header for the response | yii\httpclient\XmlFormatter |
$encoding | string | The XML encoding. | yii\httpclient\XmlFormatter |
$itemTag | string | The name of the elements that represent the array elements with numeric keys. | yii\httpclient\XmlFormatter |
$rootTag | string | The name of the root element. | yii\httpclient\XmlFormatter |
$useTraversableAsArray | boolean | Whether to interpret objects implementing the Traversable interface as arrays. | yii\httpclient\XmlFormatter |
$version | string | The XML version | yii\httpclient\XmlFormatter |
Public Methods
Method | Description | Defined By |
---|---|---|
format() | Formats given HTTP request message. | yii\httpclient\XmlFormatter |
Protected Methods
Method | Description | Defined By |
---|---|---|
buildXml() | yii\httpclient\XmlFormatter |
Property Details
The Content-Type header for the response
The XML encoding. If not set, it will use the value of \yii\base\Application::charset.
The name of the elements that represent the array elements with numeric keys.
The name of the root element.
Whether to interpret objects implementing the Traversable interface as arrays.
Defaults to true
.
The XML version
Method Details
protected void buildXml ( $element, $data ) | ||
$element | DOMElement | |
$data | mixed |
Formats given HTTP request message.
public yii\httpclient\Request format ( yii\httpclient\Request $request ) | ||
$request | yii\httpclient\Request | HTTP request instance. |
return | yii\httpclient\Request | Formatted request. |
---|