Класс Request
Реализует методы для HTTP-запросов.
Используется классом Cake\Network\Http\Client для хранения информации о запросе для выполнения запросов.
- Cake\Network\Http\Message
-
Cake\Network\Http\Request
Унаследованные константы
-
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
Краткое описание свойств
-
$_bodyprotectedТело запроса для отправки.mixed -
$_headersprotectedЗаголовки для отправки.array -
$_methodprotectedМетод HTTP для использования.string -
$_urlprotectedURL для запроса.string
Унаследованные свойства
Краткое описание методов
- cookie() publicПолучить/установить значения cookie.
- header() publicПолучить/установить заголовки в запросе.
- method() publicПолучить/установить метод HTTP.
- url() publicПолучить/установить URL для запроса.
- version() publicПолучить/установить версию HTTP.
Подробное описание методов
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']);
Параметры
- 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']);
Параметры
- string|array|null
$nameнеобязательно null - Имя для получения или массив значений для установки.
- string|null
$valueнеобязательно null - Значение для установки заголовка.
Возвращает
mixed$this при установке или значение заголовка при получении.
method()source public
method( string|null $method null )
Получить/установить метод HTTP.
Параметры
- string|null
$methodнеобязательно null - Метод для запроса.
Возвращает
$this|string $this или текущий метод.
Выбрасывает
Cake\Core\Exception\ExceptionПри неверном методе.
url()source public
url( string|null $url null )
Получить/установить URL для запроса.
Параметры
- string|null
$urlнеобязательно null - URL для запроса. Оставить null для получения.
Возвращает
$this|string $this или значение URL.
version()source public
version( string|null $version null )
Получить/установить версию HTTP.
Параметры
- string|null
$versionнеобязательно null - Версия HTTP.
Возвращает
$this|string $this или версия HTTP.
Переопределяет
Cake\Network\Http\Message::version() Методы, унаследованные от Cake\Network\Http\Message
_normalizeHeader()source protected
_normalizeHeader( string $name )
Нормализация имён заголовков в формате CamelCase.
Параметры
- string
$name - Имя заголовка для нормализации.
Возвращает
stringНормализованное имя заголовка.
body()source public
body( string|null $body null )
Получить/установить тело сообщения.
Параметры
- string|null
$bodyнеобязательно null - Тело запроса. Оставить null для получения.
Возвращает
mixed$this или значение тела.
Подробное описание свойств
$_headerssource
protected array
Заголовки для отправки.
[
'Connection' => 'close',
'User-Agent' => 'CakePHP'
]
© 2005–2016 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.
http://api.cakephp.org/3.2/class-Cake.Network.Http.Request.html