Задать HTTP-прокси HttpClient::setProxy
Модуль: main — подключать отдельно не нужно
Метод HttpClient::setProxy задает HTTP-прокси для запросов. Прокси нужен, когда сервер выходит в интернет только через него.
Сигнатура метода в классе Bitrix\Main\Web\HttpClient:
public function setProxy($proxyHost, $proxyPort = null, $proxyUser = null, $proxyPassword = null)
Параметры
Обязательные параметры обозначены *
| Параметр | Тип | Описание |
|---|---|---|
| proxyHost* | string |
Задает имя или адрес прокси без http:// |
| proxyPort | int или null |
Задает порт. Если порт не больше 0, метод оставляет прежний. Начальное значение — 80 |
| proxyUser | string или null |
Задает имя пользователя прокси. По умолчанию — null |
| proxyPassword | string или null |
Задает пароль прокси. По умолчанию — null |
Типы в таблице описывают назначение аргументов. Сигнатура PHP не объявляет их.
Возвращаемое значение
Метод возвращает тот же объект HttpClient.
Особенности
- Если задано имя пользователя, клиент отправляет заголовок
Proxy-Authorizationсо схемой Basic. - Ключи
proxyHost,proxyPort,proxyUserиproxyPasswordсекцииhttp_client_optionsфайла.settings.phpзадают прокси для всех клиентов.
Примеры
Пример. Код отправляет запрос через недоступный прокси и обрабатывает ошибку:
<?php
use Bitrix\Main\Web\HttpClient;
require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';
$client = new HttpClient(['socketTimeout' => 5]);
$client->setProxy('proxy.invalid', 3128, 'units', 'secret');
$result = $client->get('https://example.org/');
echo var_export($result, true) . ' ' . implode(',', array_keys($client->getError()));
Код выведет false NETWORK.