Запрос

__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 Request createFromGlobals()

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

Значение результата

Request

static Request 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	Необработанные данные тела

Значение результата

Request

static setFactory(callable|null $callable)

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

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

Параметры

callable|null

$callable

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

Request 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

Значение результата

Request

__clone()

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

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

string __toString()

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

Значение результата

string

Запрос

overrideGlobals()

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

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

static setTrustedProxies(array $proxies)

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

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

Параметры

array

$proxies

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

static array getTrustedProxies()

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

Значение результата

array

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

static setTrustedHosts(array $hostPatterns)

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

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

Параметры

array

$hostPatterns

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

static array getTrustedHosts()

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

Значение результата

array

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

static setTrustedHeaderName(string $key, string $value)

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

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

• 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())

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

Параметры

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

Исключения

InvalidArgumentException

static string getTrustedHeaderName(string $key)

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

Параметры

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

mixed get(string $key, mixed $default = null)

Получает значение "параметра" из любого хранилища.

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

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

Параметры

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

Значение результата

mixed

SessionInterface|null getSession()

Получает сессию.

Значение результата

SessionInterface|null

Сессия

bool hasPreviousSession()

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

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

bool

bool hasSession()

Содержит ли запрос объект сеанса (Session).

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

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

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

setSession(SessionInterface $session)

Устанавливает сеанс (Session).

Параметры

SessionInterface

$session

Сеанс (Session)

array getClientIps()

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

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

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

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

array

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

См. также

getClientIp()

string getClientIp()

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

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

Если ваш обратный прокси использует имя заголовка, отличное от «X-Forwarded-For» (например, «Client-Ip»), настройте его с помощью «setTrustedHeaderName()» с ключом «client-ip».

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

string

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

См. также

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

string getScriptName()

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

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

string

string getPathInfo()

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

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

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

• 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

string getPort()

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

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

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

Если ваш обратный прокси использует имя заголовка, отличное от «X-Forwarded-Port», настройте его с помощью «setTrustedHeaderName()» с ключом «client-port».

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

string

string|null getUser()

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

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

string|null

string|null getPassword()

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

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

string|null

string getUserInfo()

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

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

string

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

string getHttpHost()

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

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

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

string

string getRequestUri()

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

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

string

Необработанный URI (т.е. не декодированный по URL)

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»), настройте его с помощью «setTrustedHeaderName()» с ключом «client-proto».

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

bool

string getHost()

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

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

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

Если ваш обратный прокси использует имя заголовка, отличное от «X-Forwarded-Host», настройте его с помощью «setTrustedHeaderName()» с ключом «client-host».

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

string

Исключения

UnexpectedValueException

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

setMethod(string $method)

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

Параметры

string

$method

string 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()

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

Значение возвращаемого значения

строка

bool isMethod(строка $method)

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

Параметры

строка

$method

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

Значение возвращаемого значения

bool

bool isMethodSafe()

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

Значение возвращаемого значения

bool

См. также

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

bool isMethodCacheable()

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

Значение возвращаемого значения

bool

См. также

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

строка|ресурс getContent(bool $asResource = false)

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

Параметры

bool

$asResource

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

Значение возвращаемого значения

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

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

Исключения

LogicException

массив getETags()

Получает ETags.

Значение возвращаемого значения

массив

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

bool isNoCache()

Значение возвращаемого значения

bool

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

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

Параметры

массив

$locales

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

Значение возвращаемого значения

строка|null

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

массив getLanguages()

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

Значение возвращаемого значения

массив

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

массив getCharsets()

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

Значение возвращаемого значения

массив

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

массив getEncodings()

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

Значение возвращаемого значения

массив

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

массив getAcceptableContentTypes()

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

Значение возвращаемого значения

массив

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

bool isXmlHttpRequest()

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

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

Значение возвращаемого значения

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

См. также

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

bool isFromTrustedProxy()

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

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

Значение возвращаемого значения

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