Класс Request
Реализует методы для HTTP-запросов.
Используется Cake\Http\Client для хранения информации о запросе для выполнения запросов.
- Cake\Http\Client\Message
-
Cake\Http\Client\Request реализует Psr\Http\Message\RequestInterface использует Zend\Diactoros\RequestTrait
Наследуемые константы
-
METHOD_DELETE,METHOD_GET,METHOD_HEAD,METHOD_OPTIONS,METHOD_PATCH,METHOD_POST,METHOD_PUT,METHOD_TRACE,STATUS_ACCEPTED,STATUS_CREATED,STATUS_FOUND,STATUS_MOVED_PERMANENTLY,STATUS_NON_AUTHORITATIVE_INFORMATION,STATUS_NO_CONTENT,STATUS_OK,STATUS_SEE_OTHER,STATUS_TEMPORARY_REDIRECT
Наследуемые магические свойства
Наследуемые свойства
Краткое описание методов
- __construct() publicКонструктор
- addHeaders() protectedДобавить массив заголовков к запросу.
- body() publicПолучить/установить тело/данные сообщения.
- Получить/установить значения cookie.
- Получить/установить заголовки в запросе.
- Получить/установить HTTP-метод.
- Получить/установить URL для запроса.
- Получить/установить версию HTTP.
Подробное описание методов
__construct()source public
__construct( string $url = '' , string $method = self::METHOD_GET , array $headers = [] , array|string|null $data = null )
Конструктор
Обеспечивает обратную совместимость по умолчанию для некоторых свойств.
Параметры
- string
$urlнеобязательно '' - URL запроса
- string
$methodнеобязательно self::METHOD_GET - HTTP-метод, который нужно использовать.
- array
$headersнеобязательно [] - HTTP-заголовки для установки.
- array|string|null
$dataнеобязательно null - Тело запроса для использования.
addHeaders()source protected
addHeaders( array $headers )
Добавить массив заголовков к запросу.
Параметры
- array
$headers - Заголовки для добавления.
body()source public
body( string|array|null $body = null )
Получить/установить тело/данные сообщения.
Массив данных будет сериализован с помощью Cake\Http\FormData, и тип контента будет установлен.
Параметры
- string|array|null
$bodyнеобязательно null - Тело запроса. Оставьте null для получения.
Возвращает
mixedЛибо $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 в запрос.
Параметры
- string
$name - Имя cookie для получения/установки
- string|null
$valueнеобязательно null - Значение или null при получении значений.
Возвращает
mixedЛибо $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() вместо этого.Параметры
- string|array|null
$nameнеобязательно null - Имя для получения или массив для установки нескольких значений.
- string|null
$valueнеобязательно null - Значение для установки заголовка.
Возвращает
mixed$this при установке или значение заголовка при получении.
method()source public устарело
method( string|null $method = null )
Получить/установить HTTP-метод.
Предупреждение Этот метод изменяет запрос на месте для обеспечения обратной совместимости и не входит в интерфейс PSR7.
Устарело
3.3.0 Используйте getMethod() и withMethod() вместо этого.Параметры
- string|null
$methodнеобязательно null - Метод для запроса.
Возвращает
$this|string Либо this, либо текущий метод.
Исключения
Cake\Core\Exception\ExceptionПри недопустимых методах.
url()source public устарело
url( string|null $url = null )
Получить/установить URL для запроса.
Предупреждение Этот метод изменяет запрос на месте для обеспечения обратной совместимости и не входит в интерфейс PSR7.
Устарело
3.3.0 Используйте getUri() и withUri() вместо этого.Параметры
- string|null
$urlнеобязательно null - URL для запроса. Оставьте null для получения.
Возвращает
$this|string Либо $this, либо значение URL.
version()source public устарело
version( string|null $version = null )
Получить/установить версию HTTP.
Предупреждение Этот метод изменяет запрос на месте для обеспечения обратной совместимости и не входит в интерфейс PSR7.
Устарело
3.3.0 Используйте getProtocolVersion() и withProtocolVersion() вместо этого.Параметры
- string|null
$versionнеобязательно null - Версия HTTP.
Возвращает
$this|string Либо $this, либо версия HTTP.
Наследуемые методы из Cake\Http\Client\Message
headers()source public устарело
headers( )
Получить все заголовки
Устарело
3.3.0 Используйте getHeaders() вместо этого.Возвращает
массив
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.6/class-Cake.Http.Client.Request.html