Класс yii\httpclient\Response
| Наследование | yii\httpclient\Response » yii\httpclient\Message » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2-httpclient/blob/master/Response.php |
Response представляет ответ HTTP-запроса.
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $behaviors | yii\base\Behavior[] | Список прикрепленных к этому компоненту поведений. | yii\base\Component |
| $client | yii\httpclient\Client | Экземпляр клиента-владельца. | yii\httpclient\Message |
| $content | string | Необработанное содержимое. | yii\httpclient\Message |
| $cookies | yii\web\CookieCollection|yii\web\Cookie[]|array | Коллекция файлов cookie или список файлов cookie. | yii\httpclient\Message |
| $data | mixed | Поля данных содержимого. | yii\httpclient\Message |
| $format | string | Имя формата тела. | yii\httpclient\Message |
| $headers | array|yii\web\HeaderCollection | Коллекция заголовков или список заголовков в формате: [имя_заголовка => значение_заголовка] | yii\httpclient\Message |
| $isOk | boolean | Является ли ответ успешным. | yii\httpclient\Response |
| $statusCode | string | Код состояния. | yii\httpclient\Response |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __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 |
| __toString() | Магический метод PHP, который возвращает строковое представление этого объекта. | yii\httpclient\Message |
| __unset() | Устанавливает свойство компонента в значение null. | yii\base\Component |
| addCookies() | Добавляет дополнительные куки в уже определённые. | yii\httpclient\Message |
| addData() | Добавляет поля данных к существующим. | yii\httpclient\Message |
| addHeaders() | Добавляет дополнительные заголовки к уже определённым. | yii\httpclient\Message |
| attachBehavior() | Присоединяет поведение к этому компоненту. | yii\base\Component |
| attachBehaviors() | Присоединяет список поведений к компоненту. | yii\base\Component |
| behaviors() | Возвращает список поведений, по которым этот компонент должен вести себя. | yii\base\Component |
| canGetProperty() | Возвращает значение, указывающее, можно ли считать свойство. | yii\base\Component |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Component |
| className() | Возвращает полное квалифицированное имя этого класса. | yii\base\Object |
| composeHeaderLines() | Собирает исходные строки заголовков из $headers. | yii\httpclient\Message |
| detachBehavior() | Отсоединяет поведение от компонента. | yii\base\Component |
| detachBehaviors() | Отсоединяет все поведения от компонента. | yii\base\Component |
| ensureBehaviors() | Убеждается, что поведения, объявленные в behaviors(), присоединены к этому компоненту. | yii\base\Component |
| getBehavior() | Возвращает объект поведения по имени. | yii\base\Component |
| getBehaviors() | Возвращает все поведения, присоединённые к этому компоненту. | yii\base\Component |
| getContent() | Возвращает исходное содержимое HTTP сообщения. | yii\httpclient\Message |
| getCookies() | Возвращает коллекцию куков. | yii\httpclient\Response |
| getData() | Возвращает поля данных, разобранные из исходного содержимого. | yii\httpclient\Response |
| getFormat() | Возвращает формат тела. | yii\httpclient\Message |
| getHeaders() | Возвращает коллекцию заголовков. | yii\httpclient\Message |
| getIsOk() | Проверяет, является ли код состояния ответа OK (код состояния = 20x) | yii\httpclient\Response |
| getStatusCode() | Возвращает код состояния. | yii\httpclient\Response |
| hasCookies() | Проверяет, содержит ли HTTP сообщение куки. | yii\httpclient\Message |
| hasEventHandlers() | Возвращает значение, указывающее, есть ли обработчик, прикреплённый к указанному событию. | yii\base\Component |
| hasHeaders() | Проверяет, содержит ли HTTP сообщение заголовки. | yii\httpclient\Message |
| hasMethod() | Возвращает значение, указывающее, определён ли метод. | yii\base\Component |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство для этого компонента. | yii\base\Component |
| init() | Инициализирует объект. | yii\base\Object |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Присоединяет обработчик событий к событию. | yii\base\Component |
| setContent() | Устанавливает исходное содержимое HTTP сообщения. | yii\httpclient\Message |
| setCookies() | Устанавливает куки, связанные с HTTP сообщением. | yii\httpclient\Message |
| setData() | Устанавливает поля данных, которые формируют содержимое сообщения. | yii\httpclient\Message |
| setFormat() | Устанавливает формат тела. | yii\httpclient\Message |
| setHeaders() | Устанавливает заголовки HTTP, связанные с HTTP сообщением. | yii\httpclient\Message |
| toString() | Возвращает строковое представление этого HTTP сообщения. | yii\httpclient\Message |
| trigger() | Вызывает событие. | yii\base\Component |
Защищённые методы
| Метод | Описание | Определено в |
|---|---|---|
| defaultFormat() | Возвращает формат по умолчанию, автоматически определённый по заголовкам и содержимому. | yii\httpclient\Response |
| detectFormatByContent() | Определяет формат ответа по исходному содержимому. | yii\httpclient\Response |
| detectFormatByHeaders() | Определяет формат по заголовкам. | yii\httpclient\Response |
Подробное описание свойств
$isOk общедоступное только для чтения свойство
Является ли ответ OK.
public boolean getIsOk ( )
$statusCode общедоступное только для чтения свойство
Код состояния.
public string getStatusCode ( )
Подробное описание методов
defaultFormat() защищенный метод
Возвращает формат по умолчанию, автоматически определенный по заголовкам и содержимому.
| защищенный строка|null defaultFormat ( ) | ||
|---|---|---|
| возврат | строка|null |
Имя формата, 'null' - если определение не удалось. |
detectFormatByContent() защищенный метод
Определяет формат ответа по исходному содержимому.
| защищенный null|строка detectFormatByContent ( $content ) | ||
|---|---|---|
| $content | строка |
Исходное содержимое ответа. |
| возврат | null|строка |
Имя формата, 'null' - если определение не удалось. |
detectFormatByHeaders() защищенный метод
Определяет формат по заголовкам.
| защищенный null|строка detectFormatByHeaders ( yii\web\HeaderCollection $headers ) | ||
|---|---|---|
| $headers | yii\web\HeaderCollection |
Исходные заголовки. |
| возврат | null|строка |
Имя формата, 'null' - если определение не удалось. |
getCookies() публичный метод
Возвращает коллекцию куки-файлов.
Коллекция куки-файлов содержит куки-файлы, связанные с HTTP-сообщением.
| публичный yii\web\CookieCollection|yii\web\Cookie[] getCookies ( ) | ||
|---|---|---|
| возврат | yii\web\CookieCollection|yii\web\Cookie[] |
Коллекция куки-файлов. |
getData() публичный метод
Возвращает поля данных, распарсенные из исходного содержимого.
| публичный mixed getData ( ) | ||
|---|---|---|
| возврат | mixed |
Поля данных содержимого. |
getIsOk() публичный метод
Проверяет, является ли код состояния ответа OK (код состояния = 20x)
| публичный boolean getIsOk ( ) | ||
|---|---|---|
| возврат | boolean |
Является ли ответ OK. |
getStatusCode() публичный метод
Возвращает код состояния.
| публичный строка getStatusCode ( ) | ||
|---|---|---|
| возврат | строка |
Код состояния. |
| бросает | yii\httpclient\Exception |
при ошибке. |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-httpclient-response.html
