Запрос

__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())
• Request::HEADER_FORWARDED: по умолчанию Forwarded (см. RFC 7239)

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

Параметры

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

Исключения

InvalidArgumentException

static string getTrustedHeaderName(string $key)

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

Параметры

string

$key

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

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

string

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

Исключения

InvalidArgumentException

static string normalizeQueryString(string $qs)

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

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

Параметры

string

$qs

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

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

string

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

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, если запрос содержит объект Session, иначе 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»), настройте его с помощью «setTrustedHeaderName()» с ключом «client-ip».

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

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

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

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

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

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

строка

логическое значение 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 = false)

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

Параметры

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

$asResource

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

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

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

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

Исключения

LogicException

массив getETags()

Получает теги ETag.

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

массив

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

логическое значение 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