Класс ServerRequest

__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-адрес без базового пути для запроса.
• uri Объект PSR7 UriInterface. Если null, будет создан новый.
• base Базовый URL-адрес запроса.
• webroot Директория webroot для запроса.
• input Данные, которые бы пришли из php://input, это полезно для имитации запросов с данными put, patch или delete.
• session Экземпляр объекта Session

Параметры

string|array $config необязательно []

Массив данных запроса для создания объекта запроса. Строковый вариант этого аргумента устарел и будет удален в версии 4.0.0

__get()source public устаревший

__get( string $name )

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

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

Устаревший

3.4.0 Доступ к параметрам маршрутизации через __get будет удален в версии 4.0.0. Используйте getParam() вместо этого.

Параметры

string $name

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

Возвращает

mixed
Значение параметра или null.

__isset()source public устаревший

__isset( string $name )

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

Устаревший

3.4.0 Доступ к параметрам маршрутизации через __isset будет удален в версии 4.0.0. Используйте getParam() вместо этого.

Параметры

string $name

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

Возвращает

boolean
Существование

__set()source public устаревший

__set( string $name , mixed $value )

Магический метод set позволяет обеспечить обратную совместимость для прежних свойств.

Устаревший

3.6.0 Публичные свойства будут удалены в версии 4.0.0. Используйте соответствующие методы-сеттеры вместо этого.

Параметры

string $name

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

mixed $value

Значение свойства.

Возвращает

mixed
Значение параметра или null.

_acceptHeaderDetector()source protected

_acceptHeaderDetector( array $detect )

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

Параметры

array $detect

Массив опций для определения.

Возвращает

boolean
Результат проверки.

_createUploadedFile()source protected

_createUploadedFile( array $value )

Создать экземпляр UploadedFile из массива $_FILES.

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

Параметры

array $value

Структура $_FILES

Возвращает

array|Psr\Http\Message\UploadedFileInterface

_environmentDetector()source protected

_environmentDetector( array $detect )

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

Параметры

array $detect

Массив опций для определения.

Возвращает

boolean
Результат проверки.

_headerDetector()source protected

_headerDetector( array $detect )

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

Параметры

array $detect

Массив опций для определения.

Возвращает

boolean
Результат проверки.

_is()source protected

_is( string $type , array $args )

Вспомогательная функция для public is()

Параметры

string $type

Тип запроса, который нужно проверить.

array $args

Массив пользовательских аргументов для определения.

Возвращает

boolean
Результат проверки.

_normalizeNestedFiles()source protected

_normalizeNestedFiles( array $files = [] )

Нормализовать массив спецификаций файлов.

Перебирает все вложенные файлы и возвращает нормализованный массив объектов UploadedFileInterface.

Параметры

array $files необязательно []

Данные файла для нормализации и преобразования.

Возвращает

array
Массив объектов UploadedFileInterface.

_paramDetector()source protected

_paramDetector( array $detect )

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

Параметры

array $detect

Массив опций для определения.

Возвращает

boolean
Результат проверки.

_parseAcceptWithQualifier()source protected

_parseAcceptWithQualifier( string $header )

Обработать заголовки Accept* с квалификаторами.

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

Параметры

string $header

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

Возвращает

array

_processFiles()source protected

_processFiles( array $post , array $files )

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

Параметры

array $post

Данные POST, к которым нужно добавить файлы.

array $files

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

Возвращает

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

_processGet()source protected

_processGet( array $query , string $queryString = '' )

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

Параметры

array $query

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

string $queryString необязательно ''

Строка запроса из URL, если предоставлена.

Возвращает

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

_processPost()source protected

_processPost( array $data )

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

Параметры

array $data

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

Возвращает

array

_readInput()source protected

_readInput( )

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

Возвращает

string
Содержимое php://input

_setConfig()source protected

_setConfig( array $config )

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

Параметры

массив $config

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

acceptLanguage()source public

acceptLanguage( string|null $language = null )

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

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

\Cake\Http\ServerRequest::acceptLanguage(); ```

Check if a specific language is accepted:

\Cake\Http\ServerRequest::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 deprecated

addParams( array $params )

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

Устаревшая функция

3.6.0 ServerRequest::addParams() устарела. Используйте withParam() или withAttribute('params') вместо этого.

Параметры

массив $params

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

Возвращает

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

addPaths()source public deprecated

addPaths( array $paths )

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

Устаревшая функция

3.6.0 Изменение запроса на месте устарело. Используйте withAttribute() для модификации путей вместо этого.

Параметры

массив $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\Http\Exception\MethodNotAllowedException

clearDetectorCache()source public

clearDetectorCache( )

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

clientIp()source public

clientIp( )

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

Возвращает

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

contentType()source public

contentType( )

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

Возвращает

строка

cookie()source public deprecated

cookie( string $key )

Прочитать данные куки из данных куки запроса.

Устаревшая функция

3.4.0 Используйте getCookie() вместо этого.

Параметры

строка $key

Ключ, который нужно прочитать.

Возвращает

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

createFromGlobals()source public static deprecated

createFromGlobals( )

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

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

Устаревшая функция

3.4.0 Используйте Cake\Http\ServerRequestFactory вместо этого.

Возвращает

Cake\Http\ServerRequest

data()source public deprecated

data( string|null $name , ... $args )

Предоставляет чтение/запись доступа к $this->data. Позволяет использовать синтаксис, совместимый с Hash::get() для чтения данных post.

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

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

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

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

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

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

Устаревшая функция

3.4.0 Используйте withData() и getData() или getParsedBody() вместо этого.

Параметры

строка|null $name

Имя значения с точкой, разделяющей, для чтения/записи

... $args

$args Данные для установки (устарело)

Возвращает

смешанный тип|Cake\Http\ServerRequest
$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 )

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

Устаревшее

3.5.0 Используйте вместо этого getEnv()/withEnv().

Параметры

строка $key

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

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

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

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

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

Возвращает

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

getAttribute()source public

getAttribute( string $name , mixed|null $default = null )

Считать атрибут из запроса или получить значение по умолчанию.

Параметры

строка $name

Имя атрибута.

смешанный|null $default необязательно null

Значение по умолчанию, если атрибут не задан.

Возвращает

смешанный

getAttributes()source public

getAttributes( )

Получить все атрибуты в запросе.

Включает атрибуты params, webroot, base и here, предоставляемые CakePHP.

Возвращает

массив

getBody()source public

getBody( )

Получить тело сообщения.

Возвращает

Psr\Http\Message\StreamInterface
Возвращает тело как поток.

getCookie()source public

getCookie( string $key , string $default = null )

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

Параметры

строка $key

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

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

Значение по умолчанию, если куки не установлено.

Возвращает

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

getCookieCollection()source public

getCookieCollection( )

Получить коллекцию куки на основе куки запроса.

CookieCollection позволяет взаимодействовать с куки запроса с помощью \Cake\Http\Cookie\Cookie объектов и упрощает конвертацию куки запроса в куки ответа.

Этот метод создает новую коллекцию куки каждый раз, когда вызывается. Это оптимизация, которая позволяет выделять меньше объектов, пока не потребуется более сложная CookieCollection. В целом, вы должны отдавать предпочтение getCookie() и getCookieParams() этому методу. Использование CookieCollection идеально подходит, если ваши куки содержат сложные данные, закодированные в JSON.

Возвращает

Cake\Http\Cookie\CookieCollection

getCookieParams()source public

getCookieParams( )

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

Возвращает

массив
Массив данных куки.

getData()source public

getData( string|null $name = null , mixed $default = null )

Обеспечивает безопасный доступ к данным запроса. Позволяет использовать пути, совместимые с Hash::get().

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

// get all data
$request->getData();

// Read a specific field.
$request->getData('Post.title');

// With a default value.
$request->getData('Post.not there', 'default value');

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

Параметры

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

Имя значения с разделителями точек. Или null для чтения всех данных.

смешанный $default необязательно null

Данные по умолчанию.

Возвращает

null|строка|массив
Считанное значение.

getEnv()source public

getEnv( string $key , string|null $default = null )

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

Параметры

строка $key

Ключ, из которого нужно считать.

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

Значение по умолчанию, если переменной окружения не существует.

Возвращает

строка|null
Значение переменной окружения или null, если значение не существует.

getHeader()source public

getHeader( string $name )

Получить один заголовок из запроса.

Возвращает значение заголовка как массив. Если заголовок отсутствует, возвращается пустой массив.

Параметры

строка $name

Заголовок, который нужно получить (регистронезависимый)

Возвращает

массив

Ассоциативный массив заголовков и их значений. Если заголовок не найден, возвращается пустой массив.

Ссылка

Этот метод является частью интерфейса PSR-7 серверного запроса.

getHeaderLine()source public

getHeaderLine( string $name )

Получить один заголовок как строку из запроса.

Параметры

строка $name

Заголовок, который нужно получить (регистронезависимый)

Возвращает

строка
Значения заголовков, объединенные в строку, разделенную запятыми.

Ссылка

Этот метод является частью интерфейса PSR-7 серверного запроса.

getHeaders()source public

getHeaders( )

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

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

Хотя имена заголовков не чувствительны к регистру, getHeaders() будет нормализовать заголовки.

Возвращает

массив
Ассоциативный массив заголовков и их значений.

Ссылка

Этот метод является частью интерфейса PSR-7 серверного запроса.

getMethod()source public

getMethod( )

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

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

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

Возвращает

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

Ссылка

Этот метод является частью интерфейса PSR-7 серверного запроса.

getParam()source public

getParam( string $name , mixed $default = false )

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

Параметры

строка $name

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

смешанный $default необязательно false

Значение по умолчанию, если $name не задан. По умолчанию false.

Возвращает

смешанный

getParsedBody()source public

getParsedBody( )

Получить данные тела запроса, прошедшие парсинг.

Если тип содержимого запроса — application/x-www-form-urlencoded или multipart/form-data, а метод запроса — POST, это будут данные POST. Для других типов содержимого это может быть десериализованное тело запроса.

Возвращает

null|массив|объект

Десериализованные параметры тела, если таковые имеются. Обычно это массив или объект.

getPath()source public

getPath( )

Получить путь текущего запроса.

Возвращает

string

С тех пор как

3.6.1

getProtocolVersion()source public

getProtocolVersion( )

Возвращает версию HTTP-протокола в виде строки.

Возвращает

string
Версия HTTP-протокола.

getQuery()source public

getQuery( string|null $name = null , mixed $default = null )

Прочитать определённое значение запроса или путь с точкой.

Разработчикам рекомендуется использовать getQueryParams(), так как оно соответствует PSR-7, а этот метод — нет.

Альтернатива PSR-7

$value = Hash::get($request->getQueryParams(), 'Post.id', null);

Параметры

string|null $name необязательно null

Имя или путь с точкой до параметра запроса или null для чтения всех.

mixed $default необязательно null

Значение по умолчанию, если указанный параметр не задан, и $name не равен null.

Возвращает

null|string|array
Данные запроса.

См. также

ServerRequest::getQueryParams()

getQueryParams()source public

getQueryParams( )

Получить все параметры запроса в соответствии со спецификациями PSR-7. Для чтения конкретных значений параметров запроса используйте альтернативный метод getQuery().

Возвращает

array

Ссылка

Этот метод является частью интерфейса запроса сервера PSR-7.

getRequestTarget()source public

getRequestTarget( )

Возвращает целевой адрес запроса.

Возвращает целевой адрес запроса сообщения, как он был запрошен или как он был задан с помощью withRequestTarget(). По умолчанию возвращает относительный путь приложения без базового каталога и строки запроса, определённой в переменной окружения SERVER.

Возвращает

string

getServerParams()source public

getServerParams( )

Получить все параметры среды сервера.

Считать все данные «среды» или «сервера», которые были использованы для создания этого запроса.

Возвращает

array

Ссылка

Этот метод является частью интерфейса запроса сервера PSR-7.

getSession()source public

getSession( )

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

Возвращает

Cake\Http\Session

getUploadedFile()source public

getUploadedFile( string $path )

Получить загруженный файл по пути с точкой.

Параметры

string $path

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

Возвращает

null|Psr\Http\Message\UploadedFileInterface

getUploadedFiles()source public

getUploadedFiles( )

Получить массив загруженных файлов из запроса.

Возвращает

array

getUri()source public

getUri( )

Возвращает экземпляр URI.

Возвращает

Psr\Http\Message\UriInterface

Возвращает экземпляр UriInterface, представляющий URI запроса.

hasHeader()source public

hasHeader( string $name )

Проверить, установлен ли заголовок в запросе.

Параметры

string $name

Заголовок, который вы хотите получить (регистронезависимо)

Возвращает

boolean
Определён ли заголовок.

Ссылка

Этот метод является частью интерфейса запроса сервера PSR-7.

header()source public deprecated

header( string $name )

Прочитать заголовок HTTP из информации запроса.

Если заголовок не определён в запросе, этот метод переходит к чтению данных из $_SERVER и $_ENV. Это поведение по умолчанию устарело и будет удалено в версии 4.0.0.

Устарело

4.0.0 Автоматическое обращение к env() будет удалено в версии 4.0.0, см. getHeader()

Параметры

string $name

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

Возвращает

string|null
null, если заголовок не установлен, или значение заголовка.

here()source public deprecated

here( boolean $base = true )

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

Устарело

3.4.0 Этот метод будет удалён в версии 4.0.0. Используйте вместо него getRequestTarget().

Параметры

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

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

Возвращает

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

host()source public

host( )

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

Возвращает

string

input()source public

input( string|null $callback , ... $args )

Прочитать данные из php://input. Полезно при взаимодействии с содержанием тела запроса XML или JSON.

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

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

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

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

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

Параметры

string|null $callback

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

... $args

$args Дополнительные аргументы

Возвращает

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

is()source public

is( string|array $type , ... $args )

Проверить, является ли запрос определённого типа.

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

Параметры

string|array $type

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

... $args

$args Список аргументов

Возвращает

boolean
Является ли запрос указанного типа.

isAll()source public

isAll( array $types )

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

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

Параметры

array $types

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

Возвращает

boolean
Успешно.

См. также

\Cake\Http\ServerRequest::is()

method()source public deprecated

method( )

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

Устарело

3.4.0 Этот метод будет удалён в версии 4.0.0. Используйте вместо него getMethod().

Возвращает

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

normalizeHeaderName()source protected

normalizeHeaderName( string $name )

Нормализовать имя заголовка в соответствии с версией SERVER.

Параметры

string $name

Имя заголовка.

Возвращает

string
Нормализованное имя заголовка.

offsetExists()source public deprecated

offsetExists( string $name )

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

Устарело

3.4.0 Методы ArrayAccess будут удалены в версии 4.0.0. Используйте вместо них getParam().

Параметры

string $name

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

Возвращает

boolean

Реализация

ArrayAccess::offsetExists()

offsetGet()source public deprecated

offsetGet( string $name )

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

Устарело

3.4.0 Методы ArrayAccess будут удалены в версии 4.0.0. Используйте вместо них getParam(), getData() и getQuery().

Параметры

string $name

Имя ключа для доступа.

Возвращает

mixed

Реализация

ArrayAccess::offsetGet()

offsetSet()source public deprecated

offsetSet( string $name , mixed $value )

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

Устарело

3.4.0 Методы ArrayAccess будут удалены в версии 4.0.0. Используйте вместо них withParam().

Параметры

string $name

Имя ключа для записи

mixed $value

Значение для записи.

Реализация

ArrayAccess::offsetSet()

offsetUnset()source public deprecated

offsetUnset( string $name )

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

Устарело

3.4.0 Методы ArrayAccess будут удалены в версии 4.0.0. Используйте вместо них withParam().

Параметры

string $name

Имя для удаления.

Реализация

ArrayAccess::offsetUnset()

param()source public deprecated

param( string $name , ... $args )

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

Устарело

3.4.0 Используйте getParam() и withParam() вместо этого.

Параметры

string $name

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

... $args

$args Значение для установки (устарело).

Возвращает

mixed|Cake\Http\ServerRequest

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

parseAccept()source public

parseAccept( )

Разбор заголовка HTTP_ACCEPT и возвращение отсортированного массива с типами контента в качестве ключей и значениями pref.

Обычно вы хотите использовать Cake\Http\ServerRequest::accept() для получения простого списка поддерживаемых типов контента.

Возвращает

array
Массив prefValue => [типы контента]

port()source public

port( )

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

Возвращает

string

query()source public deprecated

query( string|null $name = null )

Предоставляет метод чтения для $this->query. Позволяет использовать совместимый с Hash::get() синтаксис для чтения данных POST.

Устарело

3.4.0 Используйте getQuery() или методы PSR-7 getQueryParams() и withQueryParams() вместо этого.

Параметры

string|null $name optional null

Имя переменной строки запроса или null для чтения всех.

Возвращает

string|array|null
Считываемое значение

referer()source public

referer( boolean $local = false )

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

Параметры

boolean $local optional false

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

Возвращает

string
Адрес, направивший данный запрос.

scheme()source public

scheme( )

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

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

Возвращает

string
Используемый протокол запроса.

session()source public deprecated

session( Cake\Http\Session $session = null )

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

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

Устарело

3.5.0 Используйте getSession() вместо этого. Часть установки будет удалена.

Параметры

Cake\Http\Session $session optional null

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

Возвращает

Cake\Http\Session

setInput()source public deprecated

setInput( string $input )

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

Устарело

3.4.0 Этот метод будет удалён в версии 4.0.0. Используйте вместо него withBody().

Параметры

string $input

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

subdomains()source public

subdomains( integer $tldLength = 1 )

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

Параметры

integer $tldLength optional 1

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

Возвращает

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

validateUploadedFiles()source protected

validateUploadedFiles( array $uploadedFiles , string $path )

Рекурсивно валидировать данные загруженных файлов.

Параметры

array $uploadedFiles

Новый массив файлов для валидации.

string $path

Путь до сих пор.

Исключения

InvalidArgumentException
Если какие-либо листовые элементы не являются допустимыми файлами.

withAddedHeader()source public

withAddedHeader( string $name , string|array $value )

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

Существующие значения заголовка сохранятся. Предоставленное значение будет добавлен в существующие значения.

Параметры

string $name

Имя заголовка.

string|array $value

Значение заголовка

Возвращает

Cake\Http\ServerRequest

Ссылка

Этот метод является частью интерфейса PSR-7 серверного запроса.

withAttribute()source public

withAttribute( string $name , mixed $value )

Возвращает экземпляр с указанным атрибутом запроса.

Параметры

строка $name

Имя атрибута.

смешанное $value

Значение атрибута.

Возвращаемое значение

Cake\Http\ServerRequest

withBody()source public

withBody( Psr\Http\Message\StreamInterface $body )

Возвращает экземпляр с указанным телом сообщения.

Параметры

Psr\Http\Message\StreamInterface $body

Новое тело запроса

Возвращаемое значение

Cake\Http\ServerRequest

withCookieCollection()source public

withCookieCollection( Cake\Http\Cookie\CookieCollection $cookies )

Заменяет куки в запросе теми, которые содержатся в предоставленном объекте CookieCollection.

Параметры

Cake\Http\Cookie\CookieCollection $cookies

Коллекция куки

Возвращаемое значение

Cake\Http\ServerRequest

withCookieParams()source public

withCookieParams( array $cookies )

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

Параметры

массив $cookies

Новые данные куки для использования.

Возвращаемое значение

Cake\Http\ServerRequest

withData()source public

withData( string $name , mixed $value )

Обновляет запрос с новым элементом данных запроса.

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

Используйте withParsedBody() если вам нужно заменить все данные запроса.

Параметры

строка $name

Путь с точками для вставки $value.

смешанное $value

Значение для вставки в данные запроса.

Возвращаемое значение

Cake\Http\ServerRequest

withEnv()source public

withEnv( string $key , string $value )

Обновляет запрос с новым элементом данных среды.

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

Параметры

строка $key

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

строка $value

Значение для установки

Возвращаемое значение

Cake\Http\ServerRequest

withHeader()source public

withHeader( string $name , string|array $value )

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

Параметры

строка $name

Имя заголовка.

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

Значение заголовка

Возвращаемое значение

Cake\Http\ServerRequest

Ссылка

Этот метод является частью интерфейса PSR-7 серверного запроса.

withMethod()source public

withMethod( string $method )

Обновляет метод запроса и получает новый экземпляр.

Параметры

строка $method

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

Возвращаемое значение

Cake\Http\ServerRequest
Новый экземпляр с обновлённым методом.

Ссылка

Этот метод является частью интерфейса PSR-7 серверного запроса.

withParam()source public

withParam( string $name , mixed $value )

Обновляет запрос с новым параметром маршрутизации

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

Параметры

строка $name

Путь с точками для вставки $value.

смешанное $value

Значение для вставки в параметры запроса.

Возвращаемое значение

Cake\Http\ServerRequest

withParsedBody()source public

withParsedBody( null|array|object $data )

Обновляет разобранное тело и получает новый экземпляр.

Параметры

null|массив|объект $data

Данные тела, десериализованные в массив или объект.

Возвращаемое значение

Cake\Http\ServerRequest

withProtocolVersion()source public

withProtocolVersion( string $version )

Возвращает экземпляр с указанной версией протокола HTTP.

Строка версии должна содержать только номер версии HTTP (например, "1.1", "1.0").

Параметры

строка $version

Версия протокола HTTP

Возвращаемое значение

Cake\Http\ServerRequest

withQueryParams()source public

withQueryParams( array $query )

Обновляет данные строки запроса и получает новый экземпляр.

Параметры

массив $query

Данные строки запроса для использования

Возвращаемое значение

Cake\Http\ServerRequest
Новый экземпляр с обновлёнными данными строки запроса.

Ссылка

Этот метод является частью интерфейса PSR-7 серверного запроса.

withRequestTarget()source public

withRequestTarget( string $target )

Создаёт новый экземпляр с определённой целью запроса.

Вы можете использовать этот метод для перезаписи целевого объекта запроса, который выводится из Uri запроса. Это также позволяет изменить форму целевого объекта запроса на абсолютную, авторитетную или с звёздочкой.

Параметры

строка $target

Целевой объект запроса.

Возвращаемое значение

Cake\Http\ServerRequest

Ссылка

(для различных форм целевого объекта запроса, разрешённых в сообщениях запроса)

withUploadedFiles()source public

withUploadedFiles( array $files )

Обновляет запрос, заменяя файлы и создавая новый экземпляр.

Параметры

массив $files

Массив объектов загруженных файлов.

Возвращаемое значение

Cake\Http\ServerRequest

Исключения

InvalidArgumentException
если $files содержит недопустимый объект.

withUri()source public

withUri( Psr\Http\Message\UriInterface $uri , boolean $preserveHost = false )

Возвращает экземпляр с указанным uri

Предупреждение Замена Uri не обновит base, webroot, и url атрибуты.

Параметры

Psr\Http\Message\UriInterface $uri

Новый uri запроса

логическое $preserveHost необязательно false

Сохранять ли хост.

Возвращаемое значение

Cake\Http\ServerRequest

withoutAttribute()source public

withoutAttribute( string $name )

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

Параметры

строка $name

Имя атрибута.

Возвращаемое значение

Cake\Http\ServerRequest

Исключения

InvalidArgumentException

withoutData()source public

withoutData( string $name )

Обновляет запрос, удаляя элемент данных.

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

Параметры

строка $name

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

Возвращаемое значение

Cake\Http\ServerRequest

withoutHeader()source public

withoutHeader( string $name )

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

Параметры

строка $name

Имя заголовка для удаления.

Возвращаемое значение

Cake\Http\ServerRequest

Ссылка

Этот метод является частью интерфейса запроса сервера PSR-7.

[]

[
    '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'],
]

[]

[]

[]

[]

['session', 'webroot', 'base', 'params', 'here']

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

[]

false

[]

'/'