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

Параметры

string|array $config optional []

Массив данных запроса для создания запроса. Строковая версия этого аргумента устарела и будет удалена в версии 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 на параметрах маршрутизации.

Устаревшее

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

Параметры

string $name

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

Возвращает

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

_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|array $type , array $args )

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

Параметры

string|array $type

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

array $args

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

Возвращает

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

_normalizeNestedFiles()source protected

_normalizeNestedFiles( array $files [] )

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

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

Параметры

array $files optional []

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

Возвращает

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

Строка запроса из 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 optional null

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

Возвращает

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

accepts()source public

accepts( string|null $type null )

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

Получение всех типов:

$this->request->accepts();

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

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

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

Параметры

string|null $type optional null

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

Возвращает

array|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 Данные для установки (устарело)

Возвращает

смешанный|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 )

Получить/Установить значение из данных среды запроса. Используйте 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( )

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

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

Этот метод будет создавать новую коллекцию куки каждый раз при вызове. Это оптимизация, которая позволяет распределять меньше объектов, пока не понадобится более сложная коллекция Cookie. В общем случае вы должны предпочитать 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

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

Возвращает

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

getHeader()source public

getHeader( string $name )

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

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

Параметры

строка $name

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

Возвращает

array

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

Ссылка

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

getHeaderLine()source public

getHeaderLine( string $name )

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

Параметры

строка $name

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

Возвращает

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

Ссылка

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

getHeaders()source public

getHeaders( )

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

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

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

Возвращает

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

Ссылка

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

getMethod()source public

getMethod( )

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

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

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

Возвращает

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

Ссылка

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

getParam()source public

getParam( string $name , mixed $default false )

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

Параметры

строка $name

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

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

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

Возвращает

смешанное

getParsedBody()source public

getParsedBody( )

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

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

Возвращает

null|array|object

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

getProtocolVersion()source public

getProtocolVersion( )

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

Возвращает

строка
Версия 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|строка|массив
Данные запроса.

См.

ServerRequest::getQueryParams()

getQueryParams()source public

getQueryParams( )

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

Возвращает

array

Ссылка

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

getRequestTarget()source public

getRequestTarget( )

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

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

Возвращает

строка

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

$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().

Параметры

строка $name

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

... $args

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

Возвращает

mixed|Cake\Http\ServerRequest

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

parseAccept()source public

parseAccept( )

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

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

Возвращает

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

port()source public

port( )

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

Возвращает

строка

query()source public

query( string|null $name null )

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

Устаревшее

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

Параметры

строка|null $name опционально null

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

Возвращает

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

referer()source public

referer( boolean $local false )

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

Параметры

логическое $local опционально false

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

Возвращает

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

scheme()source public

scheme( )

Возвращает текущий URL-схему, используемый для запроса.

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

Возвращает

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

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 в middleware или DispatcherFilters перед передачей в RequestHandlerComponent

Устаревшее

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

Параметры

строка $input

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

subdomains()source public

subdomains( integer $tldLength 1 )

Возвращает доменные зоны для хоста.

Параметры

целое число $tldLength опционально 1

Количество сегментов, содержащихся в вашей зоне верхнего уровня. Например: example.com содержит 1 доменную зону. В то время как 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 для серверных запросов.

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 )

Заменяет cookie в запросе cookie, содержащимися в предоставленном CookieCollection.

Параметры

Cake\Http\Cookie\CookieCollection $cookies

Коллекция cookie

Возвращает

Cake\Http\ServerRequest

withCookieParams()source public

withCookieParams( array $cookies )

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

Параметры

массив $cookies

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

Возвращает

Cake\Http\ServerRequest

withData()source public

withData( string $name , mixed $value )

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

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

Параметры

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

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

Параметры

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

[]

'/'