Ограничить размер тела ответа HttpClient::setBodyLengthMax

Модуль: main — подключать отдельно не нужно

Метод HttpClient::setBodyLengthMax задает максимальный размер тела ответа в байтах. Если ответ больше, клиент прерывает чтение. Метод защищает от загрузки слишком большого файла по ссылке пользователя.

Сигнатура метода в классе Bitrix\Main\Web\HttpClient:

public function setBodyLengthMax($bodyLengthMax)

Параметры

Обязательные параметры обозначены *

Параметр Тип Описание
bodyLengthMax* int Задает размер в байтах. Значение 0 снимает ограничение. Начальное значение — 0

Тип в таблице описывает назначение аргумента. Сигнатура PHP не объявляет его.

Возвращаемое значение

Метод возвращает тот же объект HttpClient.

Особенности

Если ответ больше ограничения, запрос возвращает false, а getError возвращает ошибку с ключом NETWORK.

Примеры

Пример. Код ограничивает ответ 100 байтами:

<?php
use Bitrix\Main\Web\HttpClient;

require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';

$client = new HttpClient();
$client->setBodyLengthMax(100);
$result = $client->get('https://example.org/');

echo var_export($result, true) . ' ' . implode(',', array_keys($client->getError()));

Код выведет false NETWORK.

Смотрите также