Класс ServerRequest

__call()source public

__call( string $name , array $params )

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

Параметры

string $name

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

array $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 )

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

Параметры

array $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'); ```

Параметры

string|null $language необязательный null

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

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

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

accepts()source public

accepts( string|null $type = null )

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

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

$this->request->accepts();

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

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

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

Параметры

string|null $type необязательный null

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

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

array|boolean

Возвращает массив всех типов, которые принимает клиент, или boolean, если клиент принимает указанный тип.

addDetector()source public static

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

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

Сравнение по обратным вызовам

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

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

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

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

addDetector('post', ['env' => 'REQUEST_METHOD', 'value' => 'POST']);

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

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

addDetector('requested', ['param' => 'requested', 'value' => 1]);

Сравнение по Accept

Позволяет сравнивать с значением заголовка Accept.

addDetector('csv', ['accept' => 'text/csv']);

Сравнение по заголовкам

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

addDetector('fancy', ['header' => ['X-Fancy' => 1]);

Типы сравнения param, env и позволяют следующие варианты сравнения значений:

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

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

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

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

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

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

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

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

Параметры

string $name

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

callable|array $callable

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

addParams()source public deprecated

addParams( array $params )

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

Устарело

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

Параметры

array $params

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

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

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

addPaths()source public deprecated

addPaths( array $paths )

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

Устарело

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

Параметры

array $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.

Параметры

string|array $methods

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

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

boolean
true

Исключения

Cake\Http\Exception\MethodNotAllowedException

clearDetectorCache()source public

clearDetectorCache( )

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

clientIp()source public

clientIp( )

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

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

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

contentType()source public

contentType( )

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

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

string

cookie()source public deprecated

cookie( string $key )

Чтение данных cookie из данных cookie запроса.

Устарело

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

Параметры

string $key

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

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

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

createFromGlobals()source public static deprecated

createFromGlobals( )

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

Использует данные $_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() вместо этого.

Параметры

string|null $name

Название значения с разделением точками для чтения/записи

... $args

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

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

mixed|Cake\Http\ServerRequest
$this либо значение, которое читается, либо this, чтобы вы могли выполнить последовательные записи.

domain()source public

domain( integer $tldLength = 1 )

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

Параметры

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

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

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

string
Доменное имя без поддоменов.

env()source public deprecated

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 )

Чтение данных cookie из данных cookie запроса.

Параметры

строка $key

Ключ или путь через точки для чтения.

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

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

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

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

getCookieCollection()source public

getCookieCollection( )

Получение коллекции cookie на основе cookie запроса

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

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

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

Cake\Http\Cookie\CookieCollection

getCookieParams()source public

getCookieParams( )

Получение всех данных cookie из запроса.

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

массив
Массив данных cookie.

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

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

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

mixed $default optional null

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

Возвращает

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

См.

ServerRequest::getQueryParams()

getQueryParams()source public

getQueryParams( )

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

Возвращает

array

Ссылка

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

getRequestTarget()source public

getRequestTarget( )

Возвращает целевой объект запроса.

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

Возвращает

string

getServerParams()source public

getServerParams( )

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

Прочитайте все данные 'среды' или 'сервера', которые были использованы для создания этого запроса.

Возвращает

array

Ссылка

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

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 server request.

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 optional 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() вместо него.

Возвращает

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

normalizeHeaderName()source protected

normalizeHeaderName( string $name )

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

Параметры

строка $name

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

Возвращает

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

offsetExists()source public deprecated

offsetExists( string $name )

Реализация Array access isset()

Устаревшее

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

Параметры

строка $name

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

Возвращает

Булево значение

Реализация

ArrayAccess::offsetExists()

offsetGet()source public deprecated

offsetGet( string $name )

Реализация Array access read

Устаревшее

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

Параметры

строка $name

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

Возвращает

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

Реализация

ArrayAccess::offsetGet()

offsetSet()source public deprecated

offsetSet( string $name , mixed $value )

Реализация Array access write

Устаревшее

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

Параметры

строка $name

Имя записываемого ключа

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

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

Реализация

ArrayAccess::offsetSet()

offsetUnset()source public deprecated

offsetUnset( string $name )

Реализация Array access unset()

Устаревшее

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

Параметры

строка $name

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

Реализация

ArrayAccess::offsetUnset()

param()source public deprecated

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

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

Устаревшее

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

Параметры

строка $name

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

... $args

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

Возвращает

смешанный тип|Cake\Http\ServerRequest

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

parseAccept()source public

parseAccept( )

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

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

Возвращает

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

port()source public

port( )

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

Возвращает

строка

query()source public deprecated

query( string|null $name = null )

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

Устаревшее

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

Параметры

строка|null $name optional null

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

Возвращает

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

referer()source public

referer( boolean $local = false )

Возвращает ссылку, по которой был сделан данный запрос.

Параметры

булево значение $local optional false

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

Возвращает

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

scheme()source public

scheme( )

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

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

Возвращает

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

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() вместо него.

Параметры

строка $input

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

setTrustedProxies()source public

setTrustedProxies( array $proxies )

Регистрация доверенных прокси.

Параметры

массив $proxies

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

subdomains()source public

subdomains( integer $tldLength = 1 )

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

Параметры

целое число $tldLength optional 1

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

Возвращает

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

validateUploadedFiles()source protected

validateUploadedFiles( array $uploadedFiles , string $path )

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

Параметры

массив $uploadedFiles

Новый массив файлов для проверки.

строка $path

Путь до данного момента.

Исключения

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

withAddedHeader()source public

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

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

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

Параметры

строка $name

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

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

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

Возвращает

Cake\Http\ServerRequest

Ссылка

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

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 )

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

Параметры

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

[]

[]

'/'