Решить, читать ли тело ответа HttpClient::shouldFetchBody

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

Доступно с версии: 23.300.0

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

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

public function shouldFetchBody(callable $callback)

Параметры

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

Параметр Тип Описание
callback* callable Задает функцию. Функция получает ответ Bitrix\Main\Web\Http\Response с заголовками и запрос Bitrix\Main\Web\Http\Request. Если функция возвращает false, клиент не читает тело

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

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

Особенности

Функция заменяет настройку waitResponse для всех следующих запросов клиента.

Примеры

Пример. Код читает тело, только если ответ в формате JSON:

<?php
use Bitrix\Main\Web\Http\Request;
use Bitrix\Main\Web\Http\Response;
use Bitrix\Main\Web\HttpClient;

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

$client = new HttpClient();
$client->shouldFetchBody(
    function (Response $response, Request $request): bool
    {
        return str_starts_with($response->getHeadersCollection()->getContentType() ?? '', 'application/json');
    }
);

$html = $client->get('https://example.org/');
$json = $client->get('https://postman-echo.com/get');

echo strlen($html) . ' ' . (strlen($json) > 0 ? 'json body' : 'empty');

Код выведет 0 json body.

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