HttpClient — HTTP-клиент
Пространство имен: Bitrix\Main\Web
Модуль: main — подключать отдельно не нужно
Доступно с версии: 14.0.15
Когда использовать
Класс HttpClient отправляет HTTP-запросы к внешним сервисам, например к API платежной системы или службы доставки. Клиент работает через PHP-сокеты или через cURL.
Класс поддерживает два способа работы.
- Методы get, post, head, query и download отправляют запрос по строке адреса. Они переходят по редиректам и не выбрасывают исключений при ошибке сети. Метод возвращает
false, а getError возвращает описание ошибки. - Методы sendRequest и sendAsyncRequest реализуют стандарт PSR-18. Они принимают объект запроса
Bitrix\Main\Web\Http\Request, не переходят по редиректам и выбрасывают исключения при ошибке.
Конструктор и методы set* задают настройки клиента. Секция http_client_options файла .settings.php задает значения по умолчанию для всех клиентов.
Объект хранит последний полученный ответ. Методы getStatus, getHeaders, getResult и getCookies читают его после запроса. Если запрос не удался, эти методы возвращают данные предыдущего ответа. Сначала проверяйте результат запроса.
Класс реализует интерфейсы Psr\Http\Client\ClientInterface и Psr\Log\LoggerAwareInterface. Методы setLogger и setDebugLevel включают журнал запросов.
Подробнее — в статье HTTP-клиент.
Методы класса
| Метод | Описание | С версии |
|---|---|---|
| __construct | Создает клиент с настройками | |
| get | Отправляет GET-запрос и возвращает тело ответа | |
| post | Отправляет POST-запрос и возвращает тело ответа | |
| head | Отправляет HEAD-запрос и возвращает заголовки ответа | |
| query | Отправляет запрос любым методом | |
| download | Скачивает ответ в файл | |
| saveFile | Сохраняет тело последнего ответа в файл | |
| setHeader | Задает заголовок запроса | |
| setHeaders | Задает несколько заголовков запроса | |
| getRequestHeaders | Возвращает заголовки запроса | |
| clearHeaders | Удаляет все заголовки запроса | |
| setCookies | Задает cookie запроса | |
| setAuthorization | Задает заголовок Basic-авторизации | |
| setRedirect | Включает или выключает переход по редиректам | |
| waitResponse | Включает или выключает чтение тела ответа | |
| shouldFetchBody | Задает функцию, которая решает, читать ли тело ответа | 23.300.0 |
| setTimeout | Задает время ожидания подключения | |
| setStreamTimeout | Задает время ожидания чтения ответа | |
| setVersion | Задает версию HTTP | |
| setCompress | Включает сжатие ответа gzip | |
| setCharset | Задает кодировку тела POST-запроса | |
| disableSslVerification | Отключает проверку SSL-сертификата | 15.5.9 |
| setPrivateIp | Разрешает или запрещает запросы к частным IP-адресам | |
| setProxy | Задает HTTP-прокси | |
| setContextOptions | Задает параметры контекста потока PHP | |
| setOutputStream | Направляет тело ответа в поток | |
| setBodyLengthMax | Ограничивает размер тела ответа | |
| setResponseBuilder | Задает объект, который создает ответ | |
| getStatus | Возвращает код статуса ответа | |
| getHeaders | Возвращает заголовки ответа | |
| getResult | Возвращает тело ответа | |
| getResponse | Возвращает объект ответа PSR-7 | |
| getCookies | Возвращает cookie из ответа | |
| getContentType | Возвращает тип содержимого ответа | |
| getCharset | Возвращает кодировку ответа | |
| getEffectiveUrl | Возвращает адрес после редиректов | |
| getPeerAddress | Возвращает IP-адрес сервера | |
| getError | Возвращает ошибки последнего запроса | |
| sendRequest | Отправляет запрос PSR-18 | |
| sendAsyncRequest | Ставит запрос в очередь асинхронных запросов | |
| wait | Ждет ответы на асинхронные запросы |
Константы
| Константа | Значение | Описание |
|---|---|---|
HTTP_1_0, HTTP_1_1 |
'1.0', '1.1' |
Версии HTTP для setVersion |
HTTP_GET, HTTP_POST, HTTP_PUT, HTTP_HEAD, HTTP_PATCH, HTTP_DELETE, HTTP_OPTIONS |
'GET', 'POST' и так далее |
Методы HTTP для query |
DEFAULT_SOCKET_TIMEOUT |
30 |
Время ожидания подключения по умолчанию, в секундах |
DEFAULT_STREAM_TIMEOUT |
60 |
Время ожидания чтения ответа по умолчанию, в секундах |
DEFAULT_STREAM_TIMEOUT_NO_WAIT |
1 |
Время ожидания чтения после waitResponse(false), в секундах |