Spec-Zone.ru › CakePHP 3.1

Класс Request

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

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

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

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

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

cookiessource public

cookies( )

Получение всех cookie

Возвращает

array
массив

headerssource public

headers( )

Получение всех заголовков

Возвращает

array
массив

Константы, унаследованные от Cake\Network\Http\Message

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

Резюме свойств

$_bodysource

protected смешанный

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

$_headerssource

protected массив

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

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

$_methodsource

protected строка

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

Cake\Network\Http\Message::METHOD_GET

$_urlsource

protected строка

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

Свойства, унаследованные от Cake\Network\Http\Message

$_cookiessource

protected массив

Массив cookie в ответе.

[]

$_versionsource

protected строка

Используемая версия HTTP.

'1.1'

© 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

Spec-Zone.ru

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