Отправить запрос любым методом HttpClient::query

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

Метод HttpClient::query отправляет запрос указанным методом HTTP. Методы get, post и head вызывают его. Метод нужен для запросов PUT, PATCH, DELETE и других.

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

public function query($method, $url, $entityBody = null)

Параметры

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

Параметр Тип Описание
method* string Задает метод HTTP заглавными буквами, например HttpClient::HTTP_PUT или 'DELETE'
url* string Задает абсолютный адрес
entityBody array, string, resource, Bitrix\Main\Web\Http\Stream или null Задает тело запроса. Метод кодирует массив как данные формы. По умолчанию — null, пустое тело

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

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

Метод возвращает true, если клиент получил ответ, даже с кодом ошибки. Если запрос не удался, метод возвращает false. Метод getResult возвращает тело ответа.

Особенности

  • Заголовок Content-Type метод добавляет сам только для POST. Для PUT и PATCH с данными формы задайте заголовок через setHeader, иначе сервер может не разобрать тело.
  • Перед каждым запросом клиент сбрасывает ошибки и адрес getEffectiveUrl, но не последний ответ. Если запрос не удался, getStatus и getResult вернут данные предыдущего ответа.
  • Клиент переходит по заголовку Location при любом коде ответа. После ответа 302 или 303 запрос повторяется методом GET, после других ответов — тем же методом с тем же телом.

Примеры

Пример. Код обновляет запись методом PUT:

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

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

$client = new HttpClient();
$client->setHeader('Content-Type', 'application/json');

if ($client->query(HttpClient::HTTP_PUT, 'https://postman-echo.com/put', Json::encode(['unit' => 'kg'])))
{
    $data = Json::decode($client->getResult());
    echo $client->getStatus() . ' ' . $data['json']['unit'];
}

Код выведет 200 kg.

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