Класс 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']);

Устаревший

3.5.0 Больше не используется. CookieCollections теперь добавляют Cookie заголовок в запрос перед отправкой. Используйте Cake\Http\Cookie\CookieCollection::addToRequest(), чтобы облегчить добавление cookie в запрос.

Параметры

строка $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|строка Либо этот объект, либо текущий метод.

Исключение

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() вместо этого.

Возвращает

массив