Запрос

__construct(array $query = array(), array $request = array(), array $attributes = array(), array $cookies = array(), array $files = array(), array $server = array(), string|resource $content = null)

Параметры

array	$query	Параметры GET
array	$request	Параметры POST
array	$attributes	Атрибуты запроса (параметры, извлечённые из PATH_INFO и т. д.)
array	$cookies	Параметры COOKIE
array	$files	Параметры FILES
array	$server	Параметры SERVER
string|resource	$content	Сырые данные тела запроса

initialize(array $query = array(), array $request = array(), array $attributes = array(), array $cookies = array(), array $files = array(), array $server = array(), string|resource $content = null)

Устанавливает параметры для этого запроса.

Этот метод также повторно инициализирует все свойства.

Параметры

array	$query	Параметры GET
array	$request	Параметры POST
array	$attributes	Атрибуты запроса (параметры, извлечённые из PATH_INFO и т. д.)
array	$cookies	Параметры COOKIE
array	$files	Параметры FILES
array	$server	Параметры SERVER
string|resource	$content	Сырые данные тела запроса

static Запрос createFromGlobals()

Создаёт новый запрос с значениями из глобальных переменных PHP.

Значение, возвращаемое функцией

Запрос

static Запрос create(string $uri, string $method = 'GET', array $parameters = array(), array $cookies = array(), array $files = array(), array $server = array(), string $content = null)

Создаёт запрос на основе заданного URI и конфигурации.

Информация, содержащаяся в URI, всегда имеет приоритет над другой информацией (сервер и параметры).

Параметры

string	$uri	URI
string	$method	HTTP-метод
array	$parameters	Параметры запроса (GET или POST)
array	$cookies	Куки запроса ($_COOKIE)
array	$files	Файлы запроса ($_FILES)
array	$server	Параметры сервера ($_SERVER)
string	$content	Сырые данные тела запроса

Значение, возвращаемое функцией

Запрос

static setFactory(callable|null $callable)

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

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

Параметры

callable|null

$callable

Вызываемый объект PHP

Запрос duplicate(array $query = null, array $request = null, array $attributes = null, array $cookies = null, array $files = null, array $server = null)

Создаёт копию запроса и переопределяет некоторые его параметры.

Параметры

array	$query	Параметры GET
array	$request	Параметры POST
array	$attributes	Атрибуты запроса (параметры, извлечённые из PATH_INFO и т. д.)
array	$cookies	Параметры COOKIE
array	$files	Параметры FILES
array	$server	Параметры SERVER

Значение, возвращаемое функцией

Запрос

__clone()

Создаёт копию текущего запроса.

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

string __toString()

Возвращает запрос в виде строки.

Значение, возвращаемое функцией

string

Запрос

overrideGlobals()

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

Переопределяет $GET, $POST, $REQUEST, $SERVER, $COOKIE. $FILES никогда не переопределяется, см. rfc1867

static setTrustedProxies(array $proxies)

Устанавливает список доверенных прокси-серверов.

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

Параметры

array

$proxies

Исключения

InvalidArgumentException

Если $trustedHeaderSet некорректен

static array getTrustedProxies()

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

Значение, возвращаемое функцией

array

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

static int getTrustedHeaderSet()

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

Значение, возвращаемое функцией

int	Поле битов Request::HEADER_*, определяющее, какие заголовки доверяются вашими прокси-серверами

static setTrustedHosts(array $hostPatterns)

Устанавливает список доверенных шаблонов хостов.

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

Параметры

array

$hostPatterns

Список доверенных шаблонов хостов

static array getTrustedHosts()

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

Значение, возвращаемое функцией

array

Массив доверенных шаблонов хостов

static setTrustedHeaderName(string $key, string $value) ^{устарело}

^{устарело}

since версия 3.3, будет удалено в 4.0. Используйте аргумент $trustedHeaderSet метода Request::setTrustedProxies() вместо него.

Устанавливает имя доверенных заголовков.

Поддерживаются следующие ключи заголовков:

• Request::HEADERCLIENTIP: по умолчанию X-Forwarded-For (см. getClientIp())
• Request::HEADERCLIENTHOST: по умолчанию X-Forwarded-Host (см. getHost())
• Request::HEADERCLIENTPORT: по умолчанию X-Forwarded-Port (см. getPort())
• Request::HEADERCLIENTPROTO: по умолчанию X-Forwarded-Proto (см. getScheme() и isSecure())
• Request::HEADER_FORWARDED: по умолчанию Forwarded (см. RFC 7239)

Установка пустого значения позволяет отключить доверенный заголовок для данного ключа.

Параметры

string	$key	Ключ заголовка
string	$value	Имя заголовка

Исключения

InvalidArgumentException

static string getTrustedHeaderName(string $key) ^{устарело}

^{устарело}

since версия 3.3, будет удалено в 4.0. Используйте метод Request::getTrustedHeaderSet() вместо него.

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

Параметры

string

$key

Ключ заголовка

Значение, возвращаемое функцией

string

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

Исключения

InvalidArgumentException

static string normalizeQueryString(string $qs)

Нормализует строку запроса.

Создаёт нормализованную строку запроса, где пары ключ/значение отсортированы по алфавиту, имеют согласованную кодировку и удалены ненужные разделители.

Параметры

string

$qs

Строка запроса

Значение, возвращаемое функцией

string

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

static enableHttpMethodParameterOverride()

Включает поддержку параметра запроса _method для определения предполагаемого HTTP-метода.

Обратите внимание, что включение этой функции может привести к проблемам с CSRF в вашем коде. Убедитесь, что вы используете токены CSRF при необходимости. Если переопределение параметра HTTP-метода включено, HTML-форма с методом «POST» может быть изменена и использована для отправки запроса «PUT» или «DELETE» через параметр запроса _method. Если эти методы не защищены от CSRF, это представляет собой возможную уязвимость.

HTTP-метод может быть переопределён только тогда, когда реальный HTTP-метод равен POST.

static bool getHttpMethodParameterOverride()

Проверяет, включена ли поддержка параметра запроса _method.

Значение, возвращаемое функцией

bool	True, если параметр запроса _method включён, иначе false

смешанный тип get(string $key, mixed $default = null)

Получает значение «параметра» из любого пакета.

Этот метод в основном полезен для библиотек, которые хотят обеспечить некоторую гибкость. Если вам не нужна гибкость в контроллерах, лучше явно получить параметры запроса из соответствующего публичного свойства вместо этого (атрибуты, запросы, параметры запроса).

Порядок приоритетов: PATH (маркеры маршрутизации или пользовательские атрибуты), GET, BODY

Параметры

string	$key	Ключ
mixed	$default	Значение по умолчанию, если ключ параметра не существует

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

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

SessionInterface|null getSession()

Получает сеанс.

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

SessionInterface|null

Сеанс

bool hasPreviousSession()

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

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

bool

bool hasSession()

Указывает, содержит ли запрос объект сеанса.

Этот метод не предоставляет никакой информации о состоянии объекта сеанса, например, о том, начат ли сеанс или нет. Это просто способ проверить, связан ли этот запрос с экземпляром сеанса.

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

bool	true, если запрос содержит объект сеанса, false в противном случае

setSession(SessionInterface $session)

Устанавливает сеанс.

Параметры

SessionInterface

$session

Сеанс

array getClientIps()

Возвращает адреса IP клиента.

В возвращаемом массиве самый надёжный адрес IP стоит первым, а наименее надёжный — последним. «Реальный» адрес IP клиента — последний, но он также наименее надёжный. Доверенные прокси-сервера удаляются.

Используйте этот метод с осторожностью; вместо него следует использовать getClientIp().

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

array

Адреса IP клиента

См. также

getClientIp()

string|null getClientIp()

Возвращает адрес IP клиента.

Этот метод может читать адрес IP клиента из заголовка «X-Forwarded-For», если доверенные прокси-сервера были настроены с помощью «setTrustedProxies()». Значение заголовка «X-Forwarded-For» — это список IP-адресов, разделённых запятой и пробелом; самый левый — исходный клиент, а каждый последующий прокси-сервер, обработший запрос, добавляет IP-адрес, с которого он получил запрос.

Если ваш обратный прокси-сервер использует имя заголовка, отличное от «X-Forwarded-For» (например, «Client-Ip»), настройте его через аргумент $trustedHeaderSet метода Request::setTrustedProxies() вместо этого.

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

string|null

Адрес IP клиента

См. также

getClientIps()
http://en.wikipedia.org/wiki/X-Forwarded-For

string getScriptName()

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

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

string

string getPathInfo()

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

Путь всегда начинается с /.

Предположим, что этот запрос создаётся из /mysite на локальном хосте:

• http://localhost/mysite возвращает пустую строку
• http://localhost/mysite/about возвращает '/about'
• http://localhost/mysite/enco%20ded возвращает '/enco%20ded'
• http://localhost/mysite/about?var=1 возвращает '/about'

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

string

Исходный путь (т. е. не декодированный с учётом URL)

string getBasePath()

Возвращает корневой путь, с которого выполняется этот запрос.

Предположим, что файл index.php создаёт этот объект запроса:

• http://localhost/index.php возвращает пустую строку
• http://localhost/index.php/page возвращает пустую строку
• http://localhost/web/index.php возвращает '/web'
• http://localhost/we%20b/index.php возвращает '/we%20b'

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

string

Исходный путь (т. е. не декодированный с учётом URL)

string getBaseUrl()

Возвращает корневой URL, с которого выполняется этот запрос.

Корневой URL никогда не заканчивается на /.

Это похоже на getBasePath(), за исключением того, что он также включает имя файла скрипта (например, index.php), если оно существует.

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

string

Исходный URL (т. е. не декодированный с учётом URL)

string getScheme()

Получает схему запроса.

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

string

int|string getPort()

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

Этот метод может читать порт клиента из заголовка «X-Forwarded-Port», если доверенные прокси-сервера были настроены с помощью «setTrustedProxies()».

Заголовок «X-Forwarded-Port» должен содержать порт клиента.

Если ваш обратный прокси-сервер использует имя заголовка, отличное от «X-Forwarded-Port», настройте его через аргумент $trustedHeaderSet метода Request::setTrustedProxies() вместо этого.

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

int|string

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

string|null getUser()

Возвращает пользователя.

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

string|null

string|null getPassword()

Возвращает пароль.

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

string|null

string getUserInfo()

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

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

string

Имя пользователя и, необязательно, схема-специфическая информация о способе получения авторизации для доступа к серверу

string getHttpHost()

Возвращает запрашиваемый HTTP-хост.

Имя порта будет добавлено к хосту, если он нестандартный.

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

string

string getRequestUri()

Возвращает URI запроса (путь и строка запроса).

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

string

Исходный URI (т. е. не декодированный с учётом URI)

string getSchemeAndHttpHost()

Получает схему и HTTP-хост.

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

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

string

Схема и HTTP-хост

string getUri()

Генерирует нормализованный URI (URL) для запроса.

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

string

Нормализованный URI (URL) для запроса

См. также

getQueryString()

string getUriForPath(string $path)

Генерирует нормализованный URI для заданного пути.

Параметры

string

$path

Путь для использования вместо текущего

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

string

Нормализованный URI для пути

string getRelativeUriForPath(string $path)

Возвращает путь как относительную ссылку от текущего пути запроса.

Только компонент пути URI (без схемы, хоста и т. д.) имеет значение и должен быть указан. Оба пути должны быть абсолютными и не содержать относительных частей. Относительные URL-адреса из одного ресурса в другой полезны при генерации автономных загружаемых архивов документов. Кроме того, они могут использоваться для уменьшения размера ссылок в документах.

Примеры целевых путей, учитывая базовый путь "/a/b/c/d": - "/a/b/c/d" -> "" - "/a/b/c/" -> "./" - "/a/b/" -> "../" - "/a/b/c/other" -> "other" - "/a/x/y" -> "../../x/y"

Параметры

string

$path

Целевой путь

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

string

Относительный целевой путь

string|null getQueryString()

Генерирует нормализованную строку запроса для запроса.

Строит нормализованную строку запроса, где пары ключ/значение отсортированы по алфавиту и имеют согласованное экранирование.

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

string|null

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

bool isSecure()

Проверяет, является ли запрос защищённым или нет.

Этот метод может читать протокол клиента из заголовка «X-Forwarded-Proto», если доверенные прокси-сервера были настроены с помощью «setTrustedProxies()».

Заголовок «X-Forwarded-Proto» должен содержать протокол: «https» или «http».

Если ваш обратный прокси-сервер использует имя заголовка, отличное от «X-Forwarded-Proto» (например, «SSL_HTTPS»), настройте его через аргумент $trustedHeaderSet метода Request::setTrustedProxies() вместо этого.

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

bool

строка getHost()

Возвращает имя хоста.

Этот метод может считывать имя хоста клиента из заголовка "X-Forwarded-Host", если доверенные прокси были заданы с помощью "setTrustedProxies()".

Заголовок "X-Forwarded-Host" должен содержать имя хоста клиента.

Если ваш обратный прокси использует имя заголовка, отличное от "X-Forwarded-Host", настройте его через аргумент $trustedHeaderSet метода Request::setTrustedProxies() вместо этого.

Значение возврата

строка

Исключения

SuspiciousOperationException

при некорректном или недоверенном имени хоста

setMethod(строка $method)

Устанавливает метод запроса.

Параметры

строка

$method

строка getMethod()

Получает "намеченный" метод запроса.

Если заголовок X-HTTP-Method-Override установлен, и если метод является POST, то он используется для определения "действительного" намеченного метода HTTP.

Параметр запроса _method также может быть использован для определения метода HTTP, но только если был вызван enableHttpMethodParameterOverride().

Метод всегда является строкой в верхнем регистре.

Значение возврата

строка

Метод запроса

См. также

getRealMethod()

строка getRealMethod()

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

Значение возврата

строка

Метод запроса

См. также

getMethod()

строка getMimeType(строка $format)

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

Параметры

строка

$format

Формат

Значение возврата

строка

Связанный тип MIME (null, если не найден)

статический массив getMimeTypes(строка $format)

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

Параметры

строка

$format

Формат

Значение возврата

массив

Связанные типы MIME

строка|null getFormat(строка $mimeType)

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

Параметры

строка

$mimeType

Связанный тип MIME

Значение возврата

строка|null

Формат (null, если не найден)

setFormat(строка $format, строка|массив $mimeTypes)

Связывает формат с типами MIME.

Параметры

строка	$format	Формат
строка|массив	$mimeTypes	Связанные типы MIME (предпочтительный должен быть первым, так как он будет использоваться в качестве типа контента)

строка getRequestFormat(строка $default = 'html')

Получает формат запроса.

Вот процесс определения формата:

• формат, определенный пользователем (с помощью setRequestFormat())
• атрибут запроса _format
• $default

Параметры

строка

$default

Формат по умолчанию

Значение возврата

строка

Формат запроса

setRequestFormat(строка $format)

Устанавливает формат запроса.

Параметры

строка

$format

Формат запроса

строка|null getContentType()

Получает формат, связанный с запросом.

Значение возврата

строка|null

Формат (null, если тип контента отсутствует)

setDefaultLocale(строка $locale)

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

Параметры

строка

$locale

строка getDefaultLocale()

Получение локали по умолчанию.

Значение возврата

строка

setLocale(строка $locale)

Устанавливает локаль.

Параметры

строка

$locale

строка getLocale()

Получить локаль.

Значение возврата

строка

логическое значение isMethod(строка $method)

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

Параметры

строка

$method

Метод запроса в верхнем регистре (GET, POST и т.д.)

Значение возврата

логическое значение

логическое значение isMethodSafe()

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

Значение возврата

логическое значение

См. также

https://tools.ietf.org/html/rfc7231#section-4.2.1

логическое значение isMethodIdempotent()

Проверяет, является ли метод идемпотентным.

Значение возврата

логическое значение

логическое значение isMethodCacheable()

Проверяет, может ли метод быть кэширован.

Значение возврата

логическое значение

См. также

https://tools.ietf.org/html/rfc7231#section-4.2.3

строка|ресурс getContent(логическое значение $asResource = ложь)

Возвращает содержимое тела запроса.

Параметры

логическое значение

$asResource

Если истинно, будет возвращен ресурс

Значение возврата

строка|ресурс

Содержимое тела запроса или ресурс для чтения потока тела

Исключения

LogicException

массив getETags()

Получает ETags.

Значение возврата

массив

Теги сущности

логическое значение isNoCache()

Значение возврата

логическое значение

строка|null getPreferredLanguage(массив $locales = null)

Возвращает предпочтительный язык.

Параметры

массив

$locales

Массив доступных локалей в порядке предпочтения

Значение возврата

строка|null

Предпочтительная локаль

массив getLanguages()

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

Значение возврата

массив

Языки в порядке предпочтения пользователя в браузере

массив getCharsets()

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

Значение возврата

массив

Список кодировок в порядке предпочтения

массив getEncodings()

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

Значение возврата

массив

Список кодировок в порядке предпочтения

массив getAcceptableContentTypes()

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

Значение возврата

массив

Список типов контента в порядке предпочтения

логическое значение isXmlHttpRequest()

Возвращает true, если запрос является XMLHttpRequest.

Работает, если ваша JavaScript библиотека устанавливает заголовок HTTP X-Requested-With. Известно, что работает с распространенными JavaScript фреймворками:

Значение возврата

логическое значение

true, если запрос является XMLHttpRequest, иначе false

См. также

http://en.wikipedia.org/wiki/List_of_Ajax_frameworks#JavaScript

логическое значение isFromTrustedProxy()

Указывает, произошел ли этот запрос от доверенного прокси.

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

Значение возврата

логическое значение

true, если запрос пришёл от доверенного прокси, иначе false