Класс yii\httpclient\Request
| Наследование | yii\httpclient\Request » yii\httpclient\Message » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2-httpclient/blob/master/Request.php |
Request представляет 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 | Коллекция куки или список куки. | yii\httpclient\Message |
| $data | mixed | Данные поля содержимого. | yii\httpclient\Request |
| $format | string | Имя формата тела. | yii\httpclient\Message |
| $fullUrl | string | Полный целевой URL. | yii\httpclient\Request |
| $headers | array|yii\web\HeaderCollection | Коллекция заголовков или список заголовков в формате: [имяЗаголовка => значениеЗаголовка] | yii\httpclient\Message |
| $method | string | Метод запроса | yii\httpclient\Request |
| $options | array | Параметры запроса. | yii\httpclient\Request |
| $url | string|array | Используйте строку для представления URL (например, `http://some-domain`). | yii\httpclient\Request |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __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 |
| addContent() | Добавляет часть содержимого для запроса с многочастным содержимым. | yii\httpclient\Request |
| addCookies() | Добавляет дополнительные куки к уже определённым. | yii\httpclient\Message |
| addData() | Добавляет поля данных к существующим. | yii\httpclient\Request |
| addFile() | Добавляет файл для загрузки как многочастного содержимого. | yii\httpclient\Request |
| addFileContent() | Добавляет строку как загрузку файла. | yii\httpclient\Request |
| addHeaders() | Добавляет дополнительные заголовки к уже определённым. | yii\httpclient\Message |
| addOptions() | Добавляет дополнительные параметры к уже определённым. | yii\httpclient\Request |
| afterSend() | Этот метод вызывается сразу после отправки этого запроса. | yii\httpclient\Request |
| attachBehavior() | Присоединяет поведение к этому компоненту. | yii\base\Component |
| attachBehaviors() | Присоединяет список поведений к компоненту. | yii\base\Component |
| beforeSend() | Этот метод вызывается сразу перед отправкой этого запроса. | yii\httpclient\Request |
| behaviors() | Возвращает список поведений, которые должен иметь этот компонент. | yii\base\Component |
| canGetProperty() | Возвращает значение, указывающее, может ли свойство быть прочитано. | yii\base\Component |
| canSetProperty() | Возвращает значение, указывающее, может ли свойство быть установлено. | yii\base\Component |
| className() | Возвращает полное квалифицированное имя этого класса. | yii\base\Object |
| composeHeaderLines() | Создаёт сырые строки заголовков из $headers. | yii\httpclient\Request |
| 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\Message |
| getData() | Возвращает поля данных, распарсенные из сырого содержимого. | yii\httpclient\Message |
| getFormat() | Возвращает формат тела. | yii\httpclient\Message |
| getFullUrl() | Возвращает полный целевой URL, включая yii\httpclient\Client::$baseUrl как строку. | yii\httpclient\Request |
| getHeaders() | Возвращает коллекцию заголовков. | yii\httpclient\Message |
| getMethod() | yii\httpclient\Request | |
| getOptions() | yii\httpclient\Request | |
| getUrl() | Возвращает целевой URL. | yii\httpclient\Request |
| 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 |
| prepare() | Подготавливает этот экземпляр запроса к отправке. | yii\httpclient\Request |
| send() | Отправляет этот запрос. | yii\httpclient\Request |
| setContent() | Устанавливает сырое содержимое HTTP сообщения. | yii\httpclient\Message |
| setCookies() | Устанавливает куки, связанные с HTTP сообщением. | yii\httpclient\Message |
| setData() | Устанавливает поля данных, которые составляют содержимое сообщения. | yii\httpclient\Request |
| setFormat() | Устанавливает формат тела. | yii\httpclient\Message |
| setFullUrl() | Устанавливает полный целевой URL. | yii\httpclient\Request |
| setHeaders() | Устанавливает HTTP-заголовки, связанные с HTTP-сообщением. | yii\httpclient\Message |
| setMethod() | yii\httpclient\Request | |
| setOptions() | Поддерживаются следующие параметры: - timeout: int, максимальное время в секундах для выполнения запроса. | yii\httpclient\Request |
| setUrl() | Устанавливает целевой URL. | yii\httpclient\Request |
| toString() | Возвращает строковое представление этого HTTP-сообщения. | yii\httpclient\Request |
| trigger() | Вызывает событие. | yii\base\Component |
Защищенные методы
| Метод | Описание | Определено в |
|---|---|---|
| defaultFormat() | Возвращает имя формата по умолчанию. | yii\httpclient\Message |
События
| Событие | Тип | Описание | Определено в |
|---|---|---|---|
| EVENT_AFTER_SEND | yii\httpclient\RequestEvent | Событие, которое срабатывает сразу после отправки запроса. | yii\httpclient\Request |
| EVENT_BEFORE_SEND | yii\httpclient\RequestEvent | Событие, которое срабатывает непосредственно перед отправкой запроса. | yii\httpclient\Request |
Подробное описание свойств
$data общедоступное свойство
Данные поля контента.
public mixed getData ( )
public $this setData ( $data )
$fullUrl общедоступное свойство
Полный целевой URL.
public string getFullUrl ( )
public void setFullUrl ( $fullUrl )
$method общедоступное свойство
Метод запроса
public string getMethod ( )
public $this setMethod ( $method )
$options общедоступное свойство
Параметры запроса.
public array getOptions ( )
public $this setOptions ( array $options )
$url общедоступное свойство
Используйте строку для представления URL (например, http://some-domain.com, item/list), или массив для представления URL с параметрами запроса (например, ['item/list', 'param1' => 'value1']).
public string|array getUrl ( )
public $this setUrl ( $url )
Подробное описание методов
addContent() public method
Добавляет часть содержимого для запроса с несколькими частями.
| public $this addContent ( $name, $content, $options = [] ) | ||
|---|---|---|
| $name | string |
Имя части (ввода формы). |
| $content | string |
Содержимое. |
| $options | array |
Опции части содержимого, допустимые опции:
|
| return | $this |
Ссылка на себя. |
addData() public method
Добавляет поля данных к существующим.
| public $this addData ( $data ) | ||
|---|---|---|
| $data | array |
Дополнительные поля данных содержимого. |
| return | $this |
Ссылка на себя. |
addFile() public method
Добавляет файл для загрузки как содержимое с несколькими частями.
См. также addContent().
| public $this addFile ( $name, $fileName, $options = [] ) | ||
|---|---|---|
| $name | string |
Имя части (ввода формы) |
| $fileName | string |
Полное имя исходного файла. |
| $options | array |
Опции части содержимого, допустимые опции:
|
addFileContent() public method
Добавляет строку как загрузку файла.
См. также addContent().
| public $this addFileContent ( $name, $content, $options = [] ) | ||
|---|---|---|
| $name | string |
Имя части (ввода формы) |
| $content | string |
Содержимое файла. |
| $options | array |
Опции части содержимого, допустимые опции:
|
addOptions() public method
Добавляет дополнительные опции к уже определенным.
Обратитесь к setOptions() для указания опций.
| public $this addOptions ( array $options ) | ||
|---|---|---|
| $options | array |
Дополнительные опции |
| return | $this |
Ссылка на себя. |
afterSend() public method (доступно с версии 2.0.1)
Этот метод вызывается сразу после отправки этого запроса.
Метод вызовет yii\httpclient\Client::afterSend() и сгенерирует событие EVENT_AFTER_SEND.
| public void afterSend ( $response ) | ||
|---|---|---|
| $response | yii\httpclient\Response |
Полученный экземпляр ответа. |
beforeSend() public method (доступно с версии 2.0.1)
Этот метод вызывается непосредственно перед отправкой этого запроса.
Метод вызовет yii\httpclient\Client::beforeSend() и сгенерирует событие EVENT_BEFORE_SEND.
| public void beforeSend ( ) |
|---|
composeHeaderLines() public method
Формирует строки заголовков из $headers.
Каждая строка будет строкой в формате: 'имя-заголовка: значение'.
| public array composeHeaderLines ( ) | ||
|---|---|---|
| return | array |
Строки заголовков. |
getFullUrl() public method
Возвращает полный URL-адрес назначения, включая yii\httpclient\Client::$baseUrl в виде строки.
| public string getFullUrl ( ) | ||
|---|---|---|
| return | string |
Полный URL-адрес назначения. |
getMethod() public method
| public string getMethod ( ) | ||
|---|---|---|
| return | string |
Метод запроса |
getOptions() public method
| public array getOptions ( ) | ||
|---|---|---|
| return | array |
Опции запроса. |
getUrl() public method
Возвращает целевой URL-адрес.
| public string|array getUrl ( ) | ||
|---|---|---|
| return | string|array |
Целевой URL-адрес или параметры URL |
prepare() public method
Подготавливает этот экземпляр запроса к отправке.
Этот метод должен вызываться транспортом перед отправкой запроса. Не вызывайте этот метод, если вы не знаете, что делаете.
| public $this prepare ( ) | ||
|---|---|---|
| return | $this |
Ссылка на себя. |
send() public method
Отправляет этот запрос.
| public yii\httpclient\Response send ( ) | ||
|---|---|---|
| return | yii\httpclient\Response |
Экземпляр ответа. |
setData() public method
Устанавливает поля данных, которые составляют содержимое сообщения.
| public $this setData ( $data ) | ||
|---|---|---|
| $data | mixed |
Поля данных содержимого. |
| return | $this |
Ссылка на себя. |
setFullUrl() public method (доступно с версии 2.0.3)
Устанавливает полный URL-адрес назначения.
Этот метод можно использовать во время форматирования и подготовки запроса. Не используйте его для указания целевого URL-адреса, используйте setUrl() вместо этого.
| public void setFullUrl ( $fullUrl ) | ||
|---|---|---|
| $fullUrl | string |
Полный URL-адрес назначения. |
setMethod() public method
| public $this setMethod ( $method ) | ||
|---|---|---|
| $method | string |
Метод запроса |
| return | $this |
Ссылка на себя. |
setOptions() public method
Поддерживаются следующие параметры: - timeout: int, максимальное время в секундах для выполнения запроса.
- proxy: string, URI, задающий адрес прокси-сервера. (например, tcp://proxy.example.com:5100).
- userAgent: string, содержимое заголовка "User-Agent: " для использования в HTTP-запросе.
- followLocation: bool, следует ли перенаправлению по заголовку "Location: " в HTTP-заголовке.
- maxRedirects: int, максимальное число перенаправлений.
- protocolVersion: float|string, версия HTTP-протокола.
- sslVerifyPeer: bool, должна ли выполняться проверка сертификата удалённого узла.
- sslCafile: string, расположение файла сертификата Удостоверяющего центра на локальном файловом хранилище, который следует использовать с параметром 'sslVerifyPeer' для проверки подлинности удалённого узла.
- sslCapath: string, каталог, содержащий несколько сертификатов Удостоверяющего центра.
Вы можете задать параметры, используя ключи, специфичные для конкретного транспорта, например, [CURLOPT_VERBOSE => true], если это необходимо.
| public $this setOptions ( array $options ) | ||
|---|---|---|
| $options | array |
Параметры запроса. |
| return | $this |
Ссылка на себя. |
setUrl() public method
Устанавливает целевой URL.
| public $this setUrl ( $url ) | ||
|---|---|---|
| $url | string|array |
Используйте строку для представления URL (например, |
| return | $this |
Ссылка на себя. |
toString() public method
Возвращает строковое представление этого HTTP-сообщения.
| public string toString ( ) | ||
|---|---|---|
| return | string |
Строковое представление этого HTTP-сообщения. |
Подробное описание событий
EVENT_AFTER_SEND событие типа yii\httpclient\RequestEvent
Событие, генерируемое сразу после отправки запроса.
EVENT_BEFORE_SEND событие типа yii\httpclient\RequestEvent
Событие, генерируемое непосредственно перед отправкой запроса.
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-httpclient-request.html