Класс yii\httpclient\UrlEncodedFormatter
| Наследование | yii\httpclient\UrlEncodedFormatter » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable, yii\httpclient\FormatterInterface |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2-httpclient/blob/master/UrlEncodedFormatter.php |
UrlEncodedFormatter форматирует HTTP-сообщение как 'application/x-www-form-urlencoded'.
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $charset | строка | Кодировка содержимого. | yii\httpclient\UrlEncodedFormatter |
| $encodingType | целое число | Тип кодирования URL. | yii\httpclient\UrlEncodedFormatter |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __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\UrlEncodedFormatter |
| hasMethod() | Возвращает значение, указывающее, определен ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует объект. | yii\base\Object |
Подробное описание свойств
$charset публичное свойство (доступно с версии 2.0.1)
Кодировка содержимого. Если не задано, используется значение yii\base\Application::$charset.
public string $charset = null
$encodingType публичное свойство
Тип кодирования URL. Возможные значения:
- PHP_QUERY_RFC1738 - кодирование выполняется в соответствии с 'RFC 1738' и медиа типом 'application/x-www-form-urlencoded', что подразумевает, что пробелы кодируются как знаки плюс (+). Это наиболее распространённый тип кодирования, используемый большинством веб-приложений.
- PHP_QUERY_RFC3986 - тогда кодирование выполняется в соответствии с 'RFC 3986', и пробелы будут закодированы как проценты (%20). Этот тип кодирования необходим для протоколов OpenID и OAuth.
public integer $encodingType = PHP_QUERY_RFC1738
Подробное описание методов
format() публичный метод
Форматирует данное HTTP-запрос сообщение.
| public 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-urlencodedformatter.html
