Spec-Zone.ru › CakePHP 3.2

Класс Request

Реализует методы для HTTP-запросов.

Используется классом Cake\Network\Http\Client для хранения информации о запросе для выполнения запросов.

Cake\Network\Http\Message
Расширяется Cake\Network\Http\Request
Пространство имён: Cake\Network\Http
Расположение: Network/Http/Request.php

Унаследованные константы

  • 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

Краткое описание свойств

  • $_body protected
    mixed
    Тело запроса для отправки.
  • $_headers protected
    array
    Заголовки для отправки.
  • $_method protected
    string
    Метод HTTP для использования.
  • $_url protected
    string
    URL для запроса.

Унаследованные свойства

  • _cookies, _version

Краткое описание методов

  • 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 или значение тела.

cookies()source public

cookies( )

Получить все cookie

Возвращает

array

headers()source public

headers( )

Получить все заголовки

Возвращает

array

Подробное описание свойств

$_bodysource

protected mixed

Тело запроса для отправки.

$_headerssource

protected array

Заголовки для отправки.

[
    'Connection' => 'close',
    'User-Agent' => 'CakePHP'
]

$_methodsource

protected string

Метод HTTP для использования.

self::METHOD_GET

$_urlsource

protected string

URL для запроса.

© 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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API