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

Параметры

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

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

__get()source public

__get( string $name )

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

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

Устарело

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

Параметры

строка $name

Доступная свойство.

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

смешанное
либо значение параметра, либо null.

__isset()source public

__isset( string $name )

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

Устаревшее

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

Параметры

строка $name

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

Возвращает

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

_acceptHeaderDetector()source protected

_acceptHeaderDetector( array $detect )

Определяет наличие определённого заголовка Accept.

Параметры

массив $detect

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

Возвращает

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

_createUploadedFile()source protected

_createUploadedFile( array $value )

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

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

Параметры

массив $value

Структура $_FILES

Возвращает

массив|Psr\Http\Message\UploadedFileInterface

_environmentDetector()source protected

_environmentDetector( array $detect )

Определяет наличие определённой переменной окружения.

Параметры

массив $detect

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

Возвращает

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

_headerDetector()source protected

_headerDetector( array $detect )

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

Параметры

массив $detect

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

Возвращает

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

_is()source protected

_is( string|array $type , array $args )

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

Параметры

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

Тип запроса для проверки. Если массив, метод вернет true, если запрос соответствует любому типу.

массив $args

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

Возвращает

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

_normalizeNestedFiles()source protected

_normalizeNestedFiles( array $files [] )

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

Проходит по всем вложенным файлам и возвращает нормализованный массив экземпляров UploadedFileInterface.

Параметры

массив $files необязательно []

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

Возвращает

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

_paramDetector()source protected

_paramDetector( array $detect )

Определяет наличие определённого параметра запроса.

Параметры

массив $detect

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

Возвращает

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

_parseAcceptWithQualifier()source protected

_parseAcceptWithQualifier( string $header )

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

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

Параметры

строка $header

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

Возвращает

массив

_processFiles()source protected

_processFiles( array $post , array $files )

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

Параметры

массив $post

Данные POST, к которым добавляются файлы.

массив $files

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

Возвращает

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

_processGet()source protected

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

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

Параметры

массив $query

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

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

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

Возвращает

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

_processPost()source protected

_processPost( array $data )

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

Параметры

массив $data

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

Возвращает

массив

_readInput()source protected

_readInput( )

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

Возвращает

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

_setConfig()source protected

_setConfig( array $config )

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

Параметры

массив $config

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

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

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

Возвращает

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

accepts()source public

accepts( string|null $type null )

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

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

$this->request->accepts();

Проверить один тип:

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

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

Параметры

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

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

Возвращает

массив|boolean

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

addDetector()source public static

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Параметры

строка $name

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

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

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

addParams()source public

addParams( array $params )

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

Параметры

массив $params

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

Возвращает

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

addPaths()source public

addPaths( array $paths )

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

Параметры

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

Возвращает

boolean
true

Выбрасывает

Cake\Network\Exception\MethodNotAllowedException

clearDetectorCache()source public

clearDetectorCache( )

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

clientIp()source public

clientIp( )

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

Возвращает

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

contentType()source public

contentType( )

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

Возвращает

строка

cookie()source public

cookie( string $key )

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

Устарело

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

Параметры

строка $key

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

Возвращает

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

createFromGlobals()source public static

createFromGlobals( )

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

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

Устарело

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

Возвращает

Cake\Http\ServerRequest

data()source public

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

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

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

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

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

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

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

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

Устарело

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

Параметры

строка|null $name

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

... $args

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

Возвращает

mixed|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 )

Получить/установить значение из данных среды запроса. Вернуться к использованию env(), если ключ не установлен в свойстве $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, предоставленные CakePHP.

Возвращает

массив

getBody()source public

getBody( )

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

Возвращает

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

getCookie()source public

getCookie( string $key , string $default null )

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

Параметры

строка $key

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

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

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

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

null|array|string
Либо значение куки, либо null, если значение не существует.

getCookieCollection()source public

getCookieCollection( )

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

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

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

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

Cake\Http\Cookie\CookieCollection

getCookieParams()source public

getCookieParams( )

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

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

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

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|string|array
Читаемое значение.

getEnv()source public

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

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

Параметры

строка $key

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

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

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

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

string|null
Либо значение среды, либо null, если значение не существует.

getHeader()source public

getHeader( string $name )

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

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

Параметры

строка $name

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

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

array

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

Ссылка

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

getHeaderLine()source public

getHeaderLine( string $name )

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

Параметры

строка $name

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

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

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

Ссылка

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

getHeaders()source public

getHeaders( )

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

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

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

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

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

Ссылка

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

getMethod()source public

getMethod( )

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

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

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

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

string
Название используемого HTTP-метода.

Ссылка

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

getParam()source public

getParam( string $name , mixed $default false )

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

Параметры

строка $name

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

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

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

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

смешанное

getParsedBody()source public

getParsedBody( )

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

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

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

null|array|object

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

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);

Параметры

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

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

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

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

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

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

См. также

ServerRequest::getQueryParams()

getQueryParams()source public

getQueryParams( )

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

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

array

Ссылка

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

getRequestTarget()source public

getRequestTarget( )

Получение целевого объекта запроса.

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

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

string

getServerParams()source public

getServerParams( )

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

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

Возвращает

массив

Ссылка

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

getSession()source public

getSession( )

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

Возвращает

Cake\Network\Session

getUploadedFile()source public

getUploadedFile( string $path )

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

Параметры

строка $path

Точечный путь к файлу, который вы хотите получить.

Возвращает

null|Psr\Http\Message\UploadedFileInterface

getUploadedFiles()source public

getUploadedFiles( )

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

Возвращает

массив

getUri()source public

getUri( )

Получить экземпляр URI.

Возвращает

Psr\Http\Message\UriInterface

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

hasHeader()source public

hasHeader( string $name )

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

Параметры

строка $name

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

Возвращает

булево
Определен ли заголовок.

Ссылка

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

header()source public

header( string $name )

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

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

Устарело

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

Параметры

строка $name

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

Возвращает

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

here()source public

here( boolean $base true )

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

Устарело

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

Параметры

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

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

Возвращает

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

host()source public

host( )

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

Возвращает

строка

input()source public

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

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

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

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

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

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

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

Параметры

строка|null $callback

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

... $args

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

Возвращает

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

is()source public

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

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

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

Параметры

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

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

... $args

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

Возвращает

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

isAll()source public

isAll( array $types )

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

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

Параметры

массив $types

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

Возвращает

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

См. также

\Cake\Http\ServerRequest::is()

method()source public

method( )

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

Устарело

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

Возвращает

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

normalizeHeaderName()source protected

normalizeHeaderName( string $name )

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

Параметры

строка $name

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

Возвращает

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

offsetExists()source public

offsetExists( string $name )

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

Устарело

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

Параметры

строка $name

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

Возвращает

булево

Реализация

ArrayAccess::offsetExists()

offsetGet()source public

offsetGet( string $name )

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

Устарело

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

Параметры

строка $name

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

Возвращает

смешанное

Реализация

ArrayAccess::offsetGet()

offsetSet()source public

offsetSet( string $name , mixed $value )

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

Устарело

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

Параметры

строка $name

Имя ключа, к которому осуществляется запись

смешанное $value

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

Реализация

ArrayAccess::offsetSet()

offsetUnset()source public

offsetUnset( string $name )

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

Устарело

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

Параметры

строка $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. Позволяет использовать синтаксис, аналогичный CakeSession для чтения данных запроса URL.

Устарело

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

Параметры

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

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

Возвращает

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

referer()source public

referer( boolean $local false )

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

Параметры

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

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

Возвращает

string
Адрес ссылки данного запроса.

scheme()source public

scheme( )

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

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

Возвращает

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

session()source public

session( Cake\Network\Session $session null )

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

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

Устарело

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

Параметры

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

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

Возвращает

Cake\Network\Session

setInput()source public

setInput( string $input )

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

Устарело

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

Параметры

string $input

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

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 )

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

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

Параметры

string $name

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

string|array $value

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

Возвращает

Cake\Http\ServerRequest

Ссылка

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

withAttribute()source public

withAttribute( string $name , mixed $value )

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

Параметры

string $name

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

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

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

Параметры

array $cookies

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

Возвращает

Cake\Http\ServerRequest

withData()source public

withData( string $name , mixed $value )

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

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

Параметры

string $name

Точечный путь для вставки $value.

mixed $value

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

Возвращает

Cake\Http\ServerRequest

withEnv()source public

withEnv( string $key , string $value )

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

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

Параметры

string $key

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

string $value

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

Возвращает

Cake\Http\ServerRequest

withHeader()source public

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

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

Параметры

string $name

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

string|array $value

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

Возвращает

Cake\Http\ServerRequest

Ссылка

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

withMethod()source public

withMethod( string $method )

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

Параметры

string $method

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

Возвращает

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

Ссылка

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

withParam()source public

withParam( string $name , mixed $value )

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

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

Параметры

string $name

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

mixed $value

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

Возвращает

Cake\Http\ServerRequest

withParsedBody()source public

withParsedBody( null|array|object $data )

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

Параметры

null|array|object $data

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

Возвращает

Cake\Http\ServerRequest

withProtocolVersion()source public

withProtocolVersion( string $version )

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

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

Параметры

string $version

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

Возвращает

Cake\Http\ServerRequest

withQueryParams()source public

withQueryParams( array $query )

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

Параметры

array $query

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

Возвращает

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

Ссылка

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

withRequestTarget()source public

withRequestTarget( string $target )

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

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

Параметры

string $target

Целевой запрос.

Возвращает

Cake\Http\ServerRequest

Ссылка

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

withUploadedFiles()source public

withUploadedFiles( array $files )

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

Параметры

array $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 optional false

Следует ли сохранить хост?

Возвращает

Cake\Http\ServerRequest

withoutAttribute()source public

withoutAttribute( string $name )

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

Параметры

string $name

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

Возвращает

Cake\Http\ServerRequest

Исключения

InvalidArgumentException

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

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

[]

false

[]

'/'