Класс Request

__call()source public

__call( string $name , array $params )

Обработчик отсутствующего метода, обрабатывает методы типа isAjax() более старой записи.

Параметры

строка $name

Вызываемый метод

массив $params

Массив параметров для вызова метода

Возвращает

смешанный тип

Исключения

BadMethodCallException
при вызове недопустимого метода.

__construct()source public

__construct( string|array $config [] )

Создает новый объект запроса.

Вы можете предоставить данные в виде массива или строки. Если вы используете строку, вы можете указать только URL запроса. Использование массива позволит предоставить следующие ключи:

• post Данные POST или данные, не являющиеся частью строки запроса
• query Дополнительные данные из строки запроса.
• files Данные загруженных файлов, отформатированные как $_FILES.
• cookies Куки для данного запроса.
• environment Данные $_SERVER и $_ENV.
• url URL без базового пути для запроса.
• base Базовый URL для запроса.
• webroot Директория webroot для запроса.
• input Данные, которые должны были бы поступать из php://input, это полезно для имитации
• session Экземпляр объекта Session, запросы с данными put, patch или delete.

Параметры

строка|массив $config необязательно []

Массив данных запроса для создания запроса.

__get()source public

__get( string $name )

Магический метод get позволяет получить доступ к параметрам маршрутизации напрямую в объекте.

Позволяет получить доступ к $this->params['controller'] через $this->controller

Параметры

строка $name

Доступное свойство.

Возвращает

смешанный тип
Значение параметра или null.

__isset()source public

__isset( string $name )

Магический метод isset позволяет выполнять проверки isset/empty на параметрах маршрутизации.

Параметры

строка $name

Доступное свойство.

Возвращает

булево
Существование

_acceptHeaderDetector()source protected

_acceptHeaderDetector( array $detect )

Определяет, присутствует ли определённый заголовок accept.

Параметры

массив $detect

Массив опций детектора.

Возвращает

булево
Является ли запрос требуемого типа.

_base()source protected static

_base( )

Возвращает базовый URL и устанавливает правильную директорию webroot

Если CakePHP вызывается с index.php в URL, даже если переписывание URL включено (и, следовательно, оно не нужно), оно поглощает ненужную часть от $base, чтобы предотвратить проблему #3318.

Возвращает

массив
Базовый URL, директория webroot, заканчивающаяся на /

_environmentDetector()source protected

_environmentDetector( array $detect )

Определяет, присутствует ли определённая переменная среды.

Параметры

массив $detect

Массив опций детектора.

Возвращает

булево
Является ли запрос требуемого типа.

_headerDetector()source protected

_headerDetector( array $detect )

Определяет, присутствует ли определённый заголовок.

Параметры

массив $detect

Массив опций детектора.

Возвращает

булево
Является ли запрос требуемого типа.

_is()source protected

_is( string|array $type )

Функция-обработчик для публичной функции is()

Параметры

строка|массив $type

Тип запроса, который вы хотите проверить. Если массив, этот метод вернёт true, если запрос соответствует любому типу.

Возвращает

булево
Является ли запрос требуемого типа.

_paramDetector()source protected

_paramDetector( array $detect )

Определяет, присутствует ли определённый параметр запроса.

Параметры

массив $detect

Массив опций детектора.

Возвращает

булево
Является ли запрос требуемого типа.

_parseAcceptWithQualifier()source protected

_parseAcceptWithQualifier( string $header )

Парсит заголовки Accept* с опциями квалификатора.

Извлекаются только квалификаторы, любые другие расширения accept будут отброшены, так как они редко используются.

Параметры

строка $header

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

Возвращает

массив

_processFileData()source protected

_processFileData( array $data , array $post , string $path '' , string $field '' )

Рекурсивно обходит массив FILES, перестраивая данные в удобный для использования формат.

Параметры

массив $data

Данные, которые строятся

массив $post

Обрабатываемые данные POST

строка $path необязательно ''

Путь, разделитель точек, для вставки $data.

строка $field необязательно ''

Конечное поле в пути. Это одно из свойств $_FILES, например, name, tmp_name, size, error

Возвращает

массив
Перестроенные данные FILES

_processFiles()source protected

_processFiles( array $post , array $files )

Обрабатывает загруженные файлы и перемещает их в данные POST.

Параметры

массив $post

Данные POST, для объединения с файлами.

массив $files

Загруженные файлы для объединения.

Возвращает

массив
Объединённые данные POST + файлы.

_processGet()source protected

_processGet( array $query )

Обрабатывает параметры GET и помещает их в объект.

Параметры

массив $query

Массив, в который добавляются обработанные ключи/значения.

Возвращает

массив
Массив, содержащий обработанные ключи/значения строки запроса.

_processPost()source protected

_processPost( array $data )

Устанавливает переменную среды REQUEST_METHOD на основе значения имитируемой переопределяющей HTTP-заголовка _method. Переменная 'ORIGINAL_REQUEST_METHOD' также сохраняется. Если вам нужен исходный HTTP-метод, используемый клиентом, прочтите его значение.

Параметры

массив $data

Массив данных POST.

Возвращает

массив

_readInput()source protected

_readInput( )

Считывает данные из php://input, имитируется в тестах.

Возвращает

строка
Содержание php://input

_setConfig()source protected

_setConfig( array $config )

Обрабатывает данные конфигурации/настроек и помещает их в свойства.

Параметры

массив $config

Данные конфигурации для использования.

_url()source protected static

_url( array $config )

Получить URI запроса. Сначала проверяется PATH_INFO, так как это точное значение, которое нам необходимо подготовить PHP. После этого проверяются REQUEST_URI, PHP_SELF, HTTP_X_REWRITE_URL и argv в указанном порядке. Каждая из этих переменных сервера имеет базовый путь и удаляет подстроки запроса

Параметры

массив $config

Конфигурация для настройки.

Возвращает

строка
URI Путь запроса CakePHP, к которому осуществляется доступ.

acceptLanguage()source public

acceptLanguage( string|null $language null )

Получить языки, принимаемые клиентом, или проверить, принимается ли определенный язык.

Получить список принятых языков:

\Cake\Network\Request::acceptLanguage(); ```

Check if a specific language is accepted:

\Cake\Network\Request::acceptLanguage('es-es'); ```

Параметры

строка|null $language необязательно null

Язык для проверки.

Возвращает

массив|булево
Если задан $language, возвращает булево значение. В противном случае возвращает массив принятых языков.

accepts()source public

accepts( string|null $type null )

Определить, какие типы контента принимает клиент, или проверить, принимает ли он определенный тип контента.

Получить все типы:

$this->request->accepts();

Проверить на наличие одного типа:

$this->request->accepts('application/json');

Этот метод упорядочит возвращаемые типы контента по значениям приоритета, указанным клиентом.

Параметры

строка|null $type необязательно null

Тип контента для проверки. Оставьте null, чтобы получить все типы, которые принимает клиент.

Возвращает

массив|булево

Массив всех типов, которые принимает клиент, или булево значение, если он принимает указанный тип.

addDetector()source public static

addDetector( string $name , callable|array $callable )

Добавить новый детектор в список детекторов, которые может использовать запрос. Существует несколько различных форматов и типов детекторов, которые можно задать.

Детекторы обратных вызовов

Детекторы обратных вызовов позволяют предоставить вызываемый объект для обработки проверки. Обратный вызов получит объект запроса в качестве единственного параметра.

addDetector('custom', function ($request) { //Return a boolean });
addDetector('custom', ['SomeClass', 'somemethod']);

Сравнение значений переменной среды

Сравнение значений переменной среды сравнивает значение, извлеченное из env() с известным значением. Значение переменной среды сравнивается на равенство с предоставленным значением.

Например, addDetector('post', ['env' => 'REQUEST_METHOD', 'value' => 'POST'])

Сравнение значений по шаблону

Сравнение значений по шаблону позволяет сравнить значение, извлеченное из env() с регулярным выражением.

addDetector('iphone', ['env' => 'HTTP_USER_AGENT', 'pattern' => '/iPhone/i']);

Сравнение на основе параметров

Сравнение на основе параметров использует список параметров для создания регулярного выражения. Последующие вызовы добавления уже определенного детектора параметров объединят параметры.

addDetector('mobile', ['env' => 'HTTP_USER_AGENT', 'options' => ['Fennec']]);

Детекторы параметров запроса

Позволяет создавать пользовательские детекторы параметров запроса.

Например, addDetector('requested', ['param' => 'requested', 'value' => 1]

Вы также можете создавать детекторы параметров, принимающие несколько значений, используя ключ options. Это полезно, когда необходимо проверить, является ли параметр запроса одним из списка параметров.

addDetector('extension', ['param' => 'ext', 'options' => ['pdf', 'csv']]

Параметры

строка $name

Имя детектора.

вызываемый объект|массив $callable

Вызываемый объект или массив параметров для определения детектора.

addParams()source public

addParams( array $params )

Добавить параметры к набору параметров запроса. Это перезапишет все существующие параметры. Это изменяет доступные параметры через $request->params.

Параметры

массив $params

Массив параметров для объединения.

Возвращает

$this Текущий объект, вы можете использовать цепочку вызовов этого метода.

addPaths()source public

addPaths( array $paths )

Добавить пути к переменным путей запроса. Это перезапишет все существующие пути. Предлагает простой способ изменить webroot и базовый путь.

Параметры

массив $paths

Массив путей для объединения.

Возвращает

$this Текущий объект, вы можете использовать цепочку вызовов этого метода.

allowMethod()source public

allowMethod( string|array $methods )

Разрешить только определенные методы HTTP-запросов. Если метод запроса не соответствует запросу, будет показана ошибка 405, и будет установлен необходимый заголовок ответа "Allow".

Пример:

$this->request->allowMethod('post'); или $this->request->allowMethod(['post', 'delete']);

Если запрос будет GET, заголовок ответа "Allow: POST, DELETE" будет установлен, и будет возвращена ошибка 405.

Параметры

строка|массив $methods

Разрешенные методы HTTP-запроса.

Возвращает

булево
true

Выбрасывает

Cake\Network\Exception\MethodNotAllowedException

clearDetectorCache()source public

clearDetectorCache( )

Очищает кэш детектора экземпляра, используемый функцией is()

clientIp()source public

clientIp( )

Получить IP-адрес, используемый клиентом, или указанный им.

Возвращает

строка
IP-адрес клиента.

contentType()source public

contentType( )

Получить тип контента, используемый в этом запросе.

Возвращает

строка

cookie()source public

cookie( string $key )

Считывать данные cookie из данных cookie запроса.

Параметры

строка $key

Ключ, который вы хотите прочитать.

Возвращает

null|строка
Значение cookie, или null, если значение не существует.

createFromGlobals()source public static

createFromGlobals( )

Метод-обёртка для создания нового запроса из глобальных переменных PHP.

Использует данные $_GET, $_POST, $_FILES, $_COOKIE, $_SERVER, $_ENV и php://input для построения запроса.

Возвращает

Cake\Network\Request

data()source public

data( string|null $name null )

Обеспечивает доступ для чтения/записи для $this->data. Позволяет использовать синтаксис, аналогичный Cake\Model\Datasource\Session для чтения данных post.

Чтение значений.

$request->data('Post.title');

При чтении значений вы получите null для ключей/значений, которые не существуют.

Запись значений

$request->data('Post.title', 'New post!');

Вы можете записывать любое значение, даже пути/ключи, которые не существуют, и массивы будут созданы для вас.

Параметры

строка|null $name необязательно null

Имя значения (через точки) для чтения/записи.

Возвращает

смешанный тип|Cake\Network\Request
$this Значение, которое считывается, или этот объект, чтобы вы могли использовать цепочку вызовов при последовательных записях.

domain()source public

domain( integer $tldLength 1 )

Получить доменное имя и включить сегменты $tldLength расширения домена.

Параметры

целое число $tldLength необязательно 1

Количество сегментов, содержащихся в расширении домена. Например: example.com содержит 1 сегмент расширения домена. А example.co.uk содержит 2.

Возвращает

строка
Доменное имя без поддоменов.

env()source public

env( string $key , string|null $value null , string|null $default null )

Получение/установка значения из данных среды запроса. Использует env(), если ключ не задан в свойстве $environment.

Параметры

строка $key

Ключ, из которого нужно считать/в который нужно записать значение.

строка|null $value необязательно null

Значение для установки. По умолчанию null.

строка|null $default необязательно null

Значение по умолчанию при попытке получить несуществующую переменную среды. Параметр value должен быть null.

Возвращает

$this|строка|null Это экземпляр, если используется в качестве установщика, если используется в качестве получателя, либо значение среды, либо null, если значение не существует.

header()source public

header( string $name )

Чтение HTTP-заголовка из информации запроса.

Параметры

строка $name

Имя заголовка, который нужно получить.

Возвращает

строка|null
Либо null, если заголовок не задан, либо значение заголовка.

here()source public

here( boolean $base true )

Получение значения текущего URL запроса. Будет включать аргументы запроса.

Параметры

булево $base необязательно true

Включить базовый путь, установить в false, чтобы обрезать базовый путь.

Возвращает

строка
Текущий URL запроса, включая аргументы строки запроса.

host()source public

host( )

Получение хоста, на котором был обработан запрос.

Возвращает

строка

input()source public

input( string|null $callback null )

Чтение данных из php://input. Полезно при работе с телом запроса в формате XML или JSON.

Получение ввода с функцией декодирования:

$this->request->input('json_decode');

Получение ввода с функцией декодирования и дополнительными параметрами:

$this->request->input('Xml::build', ['return' => 'DOMDocument']);

Дополнительные параметры применяются к обратной функции вызова в заданном порядке.

Параметры

строка|null $callback необязательно null

Функция обратного вызова декодирования, которая преобразует строковые данные в другое представление. Оставьте пустым, чтобы получить исходные данные ввода. Вы также можете передать дополнительные параметры для функции обратного вызова декодирования, используя аргументы var, см. выше.

Возвращает

строка
Декодированные/обработанные данные запроса.

is()source public

is( string|array $type )

Проверка типа запроса.

Использует встроенные правила определения, а также дополнительные правила, определенные с помощью Cake\Network\CakeRequest::addDetector(). Любой детектор можно вызвать как is($type) или is$Type().

Параметры

строка|массив $type

Тип запроса, который нужно проверить. Если массив, этот метод вернет true, если запрос соответствует любому типу.

Возвращает

булево
Соответствует ли запрос указанному типу.

isAll()source public

isAll( array $types )

Проверка соответствия запроса всем указанным типам.

Позволяет проверить несколько типов и объединить результаты. См. Request::is() для добавления дополнительных типов и встроенных типов.

Параметры

массив $types

Типы для проверки.

Возвращает

булево
Успех.

См. также

\Cake\Network\Request::is()

method()source public

method( )

Получение HTTP-метода, используемого для этого запроса. Существует несколько способов указать метод.

• Если ваш клиент его поддерживает, можно использовать стандартные HTTP-методы.
• Можно установить заголовок HTTP-X-Method-Override.
• Можно отправить ввод с именем _method

Любой из этих трех подходов может использоваться для установки HTTP-метода, используемого CakePHP внутри, и повлияет на результат этого метода.

Возвращает

строка
Имя используемого HTTP-метода.

offsetExists()source public

offsetExists( string $name )

Реализация isset() для доступа к массиву.

Параметры

строка $name

Элемент для проверки.

Возвращает

булево

Реализация

ArrayAccess::offsetExists()

offsetGet()source public

offsetGet( string $name )

Реализация чтения для доступа к массиву.

Параметры

строка $name

Имя ключа, к которому осуществляется доступ.

Возвращает

смешанный тип

Реализация

ArrayAccess::offsetGet()

offsetSet()source public

offsetSet( string $name , mixed $value )

Реализация записи для доступа к массиву.

Параметры

строка $name

Имя ключа, в который записывается значение

смешанный тип $value

Записываемое значение.

Реализация

ArrayAccess::offsetSet()

offsetUnset()source public

offsetUnset( string $name )

Реализация unset() для доступа к массиву.

Параметры

строка $name

Имя ключа для удаления.

Реализация

ArrayAccess::offsetUnset()

param()source public

param( string $name )

Безопасный доступ к значениям в $this->params.

Параметры

строка $name

Имя параметра для получения.

Возвращает

смешанный тип|Cake\Network\Request

$this Значение предоставленного параметра. Вернет false, если параметр не существует или является ложным.

parseAccept()source public

parseAccept( )

Парсинг HTTP-заголовка ACCEPT и возвращает отсортированный массив, где ключами являются типы контента, а значениями — значения приоритетов.

В целом, для получения простого списка поддерживаемых типов контента, вы хотите использовать Cake\Network\Request::accept().

Возвращает

массив
Массив prefValue => [content/types]

port()source public

port( )

Получение порта, на котором был обработан запрос.

Возвращает

строка

query()source public

query( string $name )

Предоставляет средство чтения для $this->query. Позволяет использовать синтаксис, аналогичный CakeSession для чтения данных строки запроса.

Параметры

строка $name

Имя переменной строки запроса

Возвращает

смешанный тип
Считываемое значение

referer()source public

referer( boolean $local false )

Возвращает referer, который направил этот запрос.

Параметры

булево $local необязательно false

Попытка вернуть локальный адрес. Локальные адреса не содержат имен хостов.

Возвращает

строка
Адрес, направивший этот запрос.

scheme()source public

scheme( )

Получить текущую схему URL, используемую для запроса.

Например, 'http' или 'https'

Возвращает

string
Схема, используемая для запроса.

session()source public

session( Cake\Network\Session $session null )

Возвращает экземпляр объекта Session для данного запроса.

Если объект сессии передан в качестве первого аргумента, он будет установлен в качестве сессии для использования в этом запросе.

Параметры

Cake\Network\Session $session необязательно null

объект сессии для использования

Возвращает

Cake\Network\Session

setInput()source public

setInput( string $input )

Изменить данные, изначально полученные из php://input. Полезно для изменения данных json/xml в middleware или DispatcherFilters перед передачей в RequestHandlerComponent.

Параметры

string $input

Строка, которая заменит исходные распарсенные данные из input()

subdomains()source public

subdomains( integer $tldLength 1 )

Получить поддомены для хоста.

Параметры

integer $tldLength необязательно 1

Количество сегментов, которые содержит ваша доменная зона. Например: example.com содержит 1 доменную зону. А example.co.uk содержит 2.

Возвращает

array
Массив поддоменов.

[]

[
    'get' => ['env' => 'REQUEST_METHOD', 'value' => 'GET'],
    'post' => ['env' => 'REQUEST_METHOD', 'value' => 'POST'],
    'put' => ['env' => 'REQUEST_METHOD', 'value' => 'PUT'],
    'patch' => ['env' => 'REQUEST_METHOD', 'value' => 'PATCH'],
    'delete' => ['env' => 'REQUEST_METHOD', 'value' => 'DELETE'],
    'head' => ['env' => 'REQUEST_METHOD', 'value' => 'HEAD'],
    'options' => ['env' => 'REQUEST_METHOD', 'value' => 'OPTIONS'],
    'ssl' => ['env' => 'HTTPS', 'options' => [1, 'on']],
    'ajax' => ['env' => 'HTTP_X_REQUESTED_WITH', 'value' => 'XMLHttpRequest'],
    'flash' => ['env' => 'HTTP_USER_AGENT', 'pattern' => '/^(Shockwave|Adobe) Flash/'],
    'requested' => ['param' => 'requested', 'value' => 1],
    'json' => ['accept' => ['application/json'], 'param' => '_ext', 'value' => 'json'],
    'xml' => ['accept' => ['application/xml', 'text/xml'], 'param' => '_ext', 'value' => 'xml'],
]

[]

''

[]

[]

[
    'plugin' => null,
    'controller' => null,
    'action' => null,
    '_ext' => null,
    'pass' => []
]

[]

false

'/'