Класс ServerRequest

__call()source public

__call( string $name , array $params )

Обработчик отсутствующего метода, обрабатывает обертывание методов старого стиля, таких как isAjax()

Параметры

строка $name

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

массив $params

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

Возвращает

mixed

Выбрасывает

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 )

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

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

Устаревший

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

Параметры

string $name

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

Возвращает

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

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

__isset( string $name )

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

Устаревший

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 )

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

Устарело

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

Параметры

строка $key

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

Возвращает

null|строка
Значение cookie или 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 сегменты TLD.

Параметры

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

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

Возвращает

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

env()source public устаревшее

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

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

Устаревшее

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

Параметры

строка $key

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

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

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

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

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

Возвращает

$this|строка|null Это экземпляр, если используется как setter, если используется как getter, либо значение среды, либо 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 )

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

Параметры

строка $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

Любой из этих трёх подходов можно использовать для установки 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( )

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

Если тип запроса Content-Type равен 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

getTrustedProxies()source public

getTrustedProxies( )

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

Возвращает

array

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 устаревшее

method( )

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

Устаревшее

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

Возвращает

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

normalizeHeaderName()source protected

normalizeHeaderName( string $name )

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

Параметры

string $name

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

Возвращает

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

offsetExists()source public устаревшее

offsetExists( string $name )

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

Устаревшее

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

Параметры

string $name

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

Возвращает

boolean

Реализация

ArrayAccess::offsetExists()

offsetGet()source public устаревшее

offsetGet( string $name )

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

Устаревшее

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

Параметры

string $name

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

Возвращает

mixed

Реализация

ArrayAccess::offsetGet()

offsetSet()source public устаревшее

offsetSet( string $name , mixed $value )

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

Устаревшее

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

Параметры

string $name

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

mixed $value

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

Реализация

ArrayAccess::offsetSet()

offsetUnset()source public устаревшее

offsetUnset( string $name )

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

Устаревшее

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

Параметры

string $name

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

Реализация

ArrayAccess::offsetUnset()

param()source public устаревшее

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 и вернуть отсортированный массив с типами контента в качестве ключей и значениями предпочтений.

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

Возвращает

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

port()source public

port( )

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

Возвращает

string

query()source public устаревшее

query( string|null $name = null )

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

Устаревшее

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

Параметры

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

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

Возвращает

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

referer()source public

referer( boolean $local = false )

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

Параметры

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

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

Возвращает

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

scheme()source public

scheme( )

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

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

Возвращает

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

session()source public устаревшее

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

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

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

Устаревшее

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

Параметры

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

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

Возвращает

Cake\Http\Session

setInput()source public устаревшее

setInput( string $input )

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

Устаревшее

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

Параметры

string $input

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

setTrustedProxies()source public

setTrustedProxies( array $proxies )

зарегистрировать доверенные прокси-серверы

Параметры

array $proxies

список доверенных прокси-серверов

subdomains()source public

subdomains( integer $tldLength = 1 )

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

Параметры

integer $tldLength необязательно 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 )

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

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

Параметры

строка $name

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

строка|массив $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 запроса

boolean $preserveHost необязательно false

Выполнять ли сохранение хоста.

Возвращает

Cake\Http\ServerRequest

withoutAttribute()source public

withoutAttribute( string $name )

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

Параметры

string $name

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

Возвращает

Cake\Http\ServerRequest

Исключения

InvalidArgumentException

withoutData()source public

withoutData( string $name )

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

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

Параметры

string $name

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

Возвращает

Cake\Http\ServerRequest

withoutHeader()source public

withoutHeader( string $name )

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

Параметры

string $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

[]

[]

'/'