Класс Request
Реализует методы для HTTP-запросов.
Используется классом Cake\Network\Http\Client для хранения информации о запросе при его выполнении.
- Cake\Network\Http\Message
-
Cake\Network\Http\Request
Подробное описание метода
cookiesource 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 при получении значения.
Возвращает
mixedЛибо $this, либо значение cookie.
headersource 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']);
Параметры
- строка|массив|null
$nameнеобязательно null - Имя для получения или массив значений для установки.
- строка|null
$valueнеобязательно null - Значение для установки заголовка.
Возвращает
mixedЛибо $this при установке, либо значение заголовка при получении.
methodsource public
method( string|null $method null )
Получение/установка HTTP-метода.
Параметры
- строка|null
$methodнеобязательно null - Метод для запроса.
Возвращает
mixed$this|строка Либо $this, либо текущий метод.
Исключения
Cake\Core\Exception\ExceptionПри неверном методе.
urlsource public
url( string|null $url null )
Получение/установка URL для запроса.
Параметры
- строка|null
$urlнеобязательно null - URL для запроса. Оставить null для получения
Возвращает
mixed$this|строка Либо $this, либо значение URL.
versionsource public
version( string|null $version null )
Получение/установка версии HTTP.
Параметры
- строка|null
$versionнеобязательно null - Версия HTTP.
Возвращает
mixed$this|строка Либо $this, либо версия HTTP.
Переопределяет
Cake\Network\Http\Message::version() Наследованные методы из Cake\Network\Http\Message
_normalizeHeadersource protected
_normalizeHeader( string $name )
Нормализация имён заголовков в формате ВерблюжьийРегистр.
Параметры
- строка
$name - Имя заголовка для нормализации.
Возвращает
stringНормализованное имя заголовка.
bodysource public
body( string|null $body null )
Получение/установка тела сообщения.
Параметры
- строка|null
$bodyнеобязательно null - Тело запроса. Оставить null для получения
Возвращает
mixedЛибо $this, либо значение тела.
Константы, унаследованные от Cake\Network\Http\Message
Резюме свойств
Свойства, унаследованные от Cake\Network\Http\Message
© 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.1/class-Cake.Network.Http.Request.html