Класс Request

__construct()source public

__construct( string $url '' , string $method self::METHOD_GET , array $headers [] , array|string|null $data null )

Конструктор

Обеспечивает обратную совместимость по умолчанию для некоторых свойств.

Параметры

строка $url необязательно ''

URL запроса

строка $method необязательно self::METHOD_GET

HTTP-метод, который нужно использовать.

массив $headers необязательно []

HTTP-заголовки для установки.

массив|строка|null $data необязательно null

Тело запроса для использования.

addHeaders()source protected

addHeaders( array $headers )

Добавляет массив заголовков к запросу.

Параметры

массив $headers

Заголовки для добавления.

body()source public

body( string|array|null $body null )

Получение/установка тела/загрузки сообщения.

Данные массива будут сериализованы с помощью Cake\Http\FormData, и тип содержимого будет установлен.

Параметры

строка|массив|null $body необязательно null

Тело запроса. Оставить null для получения

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

смешанный
Либо $this, либо значение тела.

Переопределяет

Cake\Http\Client\Message::body()

cookie()source public

cookie( string $name , string|null $value null )

Получение/Установка значений cookie.

Получение cookie

$request->cookie('session');

Установка одной cookie

$request->cookie('session', '123456');

Установка нескольких заголовков

$request->cookie(['test' => 'value', 'split' => 'banana']);

Параметры

строка $name

Имя cookie для получения/установки

строка|null $value необязательно null

Либо значение, либо null при получении значений.

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

смешанный
Либо $this, либо значение cookie.

header()source public

header( string|array|null $name null , string|null $value null )

Получение/Установка заголовков в запрос.

Можно получить значение заголовка или установить один/несколько заголовков. Заголовки устанавливаются/получаются без учёта регистра.

Получение заголовков

$request->header('Content-Type');

Установка одного заголовка

$request->header('Content-Type', 'application/json');

Установка нескольких заголовков

$request->header(['Connection' => 'close', 'User-Agent' => 'CakePHP']);

Предупреждение Этот метод изменяет запрос на месте для обеспечения обратной совместимости и не является частью интерфейса PSR7.

Устарело

3.3.0 Используйте withHeader() и getHeaderLine() вместо этого.

Параметры

строка|массив|null $name необязательно null

Имя для получения или массив для установки.

строка|null $value необязательно null

Значение для установки заголовка.

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

смешанный
$this при установке или значение заголовка при получении.

method()source public

method( string|null $method null )

Получение/Установка HTTP-метода.

Предупреждение Этот метод изменяет запрос на месте для обеспечения обратной совместимости и не является частью интерфейса PSR7.

Устарело

3.3.0 Используйте getMethod() и withMethod() вместо этого.

Параметры

строка|null $method необязательно null

Метод для запроса.

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

$this|строка Либо this, либо текущий метод.

Исключения

Cake\Core\Exception\Exception
При недопустимых методах.

url()source public

url( string|null $url null )

Получение/Установка URL-адреса для запроса.

Предупреждение Этот метод изменяет запрос на месте для обеспечения обратной совместимости и не является частью интерфейса PSR7.

Устарело

3.3.0 Используйте getUri() и withUri() вместо этого.

Параметры

строка|null $url необязательно null

URL-адрес для запроса. Оставить null для получения

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

$this|строка Либо $this, либо значение URL.

version()source public

version( string|null $version null )

Получение/Установка версии HTTP.

Предупреждение Этот метод изменяет запрос на месте для обеспечения обратной совместимости и не является частью интерфейса PSR7.

Устарело

3.3.0 Используйте getProtocolVersion() и withProtocolVersion() вместо этого.

Параметры

строка|null $version необязательно null

Версия HTTP.

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

$this|строка Либо $this, либо версия HTTP.

cookies()source public

cookies( )

Получение всех cookie

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

массив

headers()source public

headers( )

Получение всех заголовков

Устарело

3.3.0 Используйте getHeaders() вместо этого.

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

массив