Класс yii\httpclient\Client

public string $baseUrl = null

public integer $contentLoggingMaxSize = 2000

public array $formatters = []

public array $parsers = []

public array $requestConfig = []

public array $responseConfig = []

public yii\httpclient\Transport getTransport ( )
public void setTransport ( $transport )

afterSend() public method (available since version 2.0.1)

Этот метод вызывается сразу после отправки запроса.

Метод вызовет событие EVENT_AFTER_SEND.

public void afterSend ( $request, $response )
$request	yii\httpclient\Request	Экземпляр запроса.
$response	yii\httpclient\Response	Экземпляр полученного ответа.

batchSend() public method

Выполняет несколько HTTP-запросов параллельно.

Этот метод принимает массив объектов yii\httpclient\Request и возвращает массив объектов yii\httpclient\Response. Ключи массива ответов соответствуют ключам массива запросов.

$client = new Client();
$requests = [
    'news' => $client->get('http://domain.com/news'),
    'friends' => $client->get('http://domain.com/user/friends', ['userId' => 12]),
];
$responses = $client->batchSend($requests);
var_dump($responses['news']->isOk);
var_dump($responses['friends']->isOk);

public yii\httpclient\Response[] batchSend ( array $requests )
$requests	yii\httpclient\Request[]	Запросы для выполнения.
return	yii\httpclient\Response[]	Список ответов.

beforeSend() public method (available since version 2.0.1)

Этот метод вызывается непосредственно перед отправкой запроса.

Метод вызовет событие EVENT_BEFORE_SEND.

public void beforeSend ( $request )
$request	yii\httpclient\Request	Экземпляр запроса.

createRequest() public method

public yii\httpclient\Request createRequest ( )
return	yii\httpclient\Request	Экземпляр запроса.

createRequestLogToken() public method

Компонует маркер сообщения журнала/профилирования для заданных параметров HTTP-запроса.

Этот метод должен использоваться транспортными средствами при ведении журнала отправки запросов.

public string createRequestLogToken ( $method, $url, $headers, $content )
$method	string	Имя метода запроса.
$url	string	URL запроса.
$headers	array	Заголовки запроса.
$content	string	Содержание запроса.
return	string	Маркер журнала.

createResponse() public method

Создаёт экземпляр ответа.

public yii\httpclient\Response createResponse ( $content = null, array $headers = [] )
$content	string	Исходное содержимое
$headers	array	Список заголовков.
return	yii\httpclient\Response	Экземпляр запроса.

delete() public method

Создаёт запрос 'DELETE'.

public yii\httpclient\Request delete ( $url, $data = null, $headers = [], $options = [] )
$url	string	Целевой URL.
$data	array|string	Если массив - данные запроса, иначе - содержимое запроса.
$headers	array	Заголовки запроса.
$options	array	Параметры запроса.
return	yii\httpclient\Request	Экземпляр запроса.

get() public method

Создаёт запрос 'GET'.

public yii\httpclient\Request get ( $url, $data = null, $headers = [], $options = [] )
$url	string	Целевой URL.
$data	array|string	Если массив - данные запроса, иначе - содержимое запроса.
$headers	array	Заголовки запроса.
$options	array	Параметры запроса.
return	yii\httpclient\Request	Экземпляр запроса.

getFormatter() public method

Возвращает экземпляр форматировщика HTTP-сообщений для указанного формата.

public yii\httpclient\FormatterInterface getFormatter ( $format )
$format	string	Имя формата.
return	yii\httpclient\FormatterInterface	Экземпляр форматировщика.
throws	yii\base\InvalidParamException	при неверном имени формата.

getParser() public method

Возвращает экземпляр парсера HTTP-сообщений для указанного формата.

public yii\httpclient\ParserInterface getParser ( $format )
$format	string	Имя формата
return	yii\httpclient\ParserInterface	Экземпляр парсера.
throws	yii\base\InvalidParamException	при неверном имени формата.

getTransport() public method

public yii\httpclient\Transport getTransport ( )
return	yii\httpclient\Transport	Экземпляр транспортного средства HTTP-сообщений.

head() public method

Создаёт запрос 'HEAD'.

public yii\httpclient\Request head ( $url, $headers = [], $options = [] )
$url	string	Целевой URL.
$headers	array	Заголовки запроса.
$options	array	Параметры запроса.
return	yii\httpclient\Request	Экземпляр запроса.

options() public method

Создаёт запрос 'OPTIONS'.

public yii\httpclient\Request options ( $url, $options = [] )
$url	string	Целевой URL.
$options	array	Параметры запроса.
return	yii\httpclient\Request	Экземпляр запроса.

patch() public method

Создаёт запрос 'PATCH'.

public yii\httpclient\Request patch ( $url, $data = null, $headers = [], $options = [] )
$url	string	Целевой URL.
$data	array|string	Если массив — данные запроса, в противном случае — содержимое запроса.
$headers	array	Заголовки запроса.
$options	array	Параметры запроса.
return	yii\httpclient\Request	Экземпляр запроса.

post() public method

Создаёт запрос 'POST'.

public yii\httpclient\Request post ( $url, $data = null, $headers = [], $options = [] )
$url	string	Целевой URL.
$data	array|string	Если массив — данные запроса, в противном случае — содержимое запроса.
$headers	array	Заголовки запроса.
$options	array	Параметры запроса.
return	yii\httpclient\Request	Экземпляр запроса.

put() public method

Создаёт запрос 'PUT'.

public yii\httpclient\Request put ( $url, $data = null, $headers = [], $options = [] )
$url	string	Целевой URL.
$data	array|string	Если массив — данные запроса, в противном случае — содержимое запроса.
$headers	array	Заголовки запроса.
$options	array	Параметры запроса.
return	yii\httpclient\Request	Экземпляр запроса.

send() public method

Выполняет заданный запрос.

public yii\httpclient\Response send ( $request )
$request	yii\httpclient\Request	Отправляемый запрос.
return	yii\httpclient\Response	Экземпляр ответа.
throws	yii\httpclient\Exception	при ошибке.

setTransport() public method

Устанавливает транспорт HTTP-сообщений. Он может быть задан в одной из следующих форм:

• экземпляр Transport: фактический объект транспорта, который будет использоваться
• строка: представляющая имя класса объекта, который будет создан
• массив конфигурации: массив должен содержать элемент class, который обрабатывается как класс объекта, а остальные пары имя-значение будут использованы для инициализации соответствующих свойств объекта
• вызов PHP: либо анонимная функция, либо массив, представляющий метод класса ([$class or $object, $method]). Вызываемый объект должен возвращать новый экземпляр создаваемого объекта.

public void setTransport ( $transport )
$transport	yii\httpclient\Transport|array|string	Транспорт HTTP-сообщений