Класс 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_OK,STATUS_SEE_OTHER,STATUS_TEMPORARY_REDIRECT
Наследованные магические свойства
Наследованные свойства
Краткое описание методов
- __construct() publicКонструктор
- addHeaders() protectedДобавление массива заголовков к запросу.
- body() publicПолучение/установка тела/данных сообщения.
- cookie() publicПолучение/установка значений cookie.
- header() publicПолучение/установка заголовков в запросе.
- method() publicПолучение/установка HTTP-метода.
- url() publicПолучение/установка URL для запроса.
- version() publicПолучение/установка версии HTTP.
Подробное описание методов
__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|строка Либо 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.
Наследованные методы от Cake\Http\Client\Message
headers()source public
headers( )
Получить все заголовки
Устаревшее
3.3.0 Используйте getHeaders() вместо этого.Возвращает
массив
© 2005–2017 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.4/class-Cake.Http.Client.Request.html