ApacheRequest

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

Конструктор.

Параметры

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

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

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

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

Параметры

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

Экземпляр 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 (см. getClientHost())
• Request::HEADERCLIENTPORT: по умолчанию X-Forwarded-Port (см. getClientPort())
• 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

Нормализованная строка запроса для 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, bool $deep = false)

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

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

Порядок приоритета: GET, PATH, POST

Избегайте использования этого метода в контроллерах:

• медленно
• предпочитается получать из «именованного» источника

Лучше явно получать параметры запроса из соответствующего публичного свойства (query, attributes, request).

Параметры

string	$key	ключ
mixed	$default	значение по умолчанию
bool	$deep	является ли параметр глубоко в многомерном массиве

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

mixed

SessionInterface|null getSession()

Получает Session.

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

SessionInterface|null

Сессия

bool hasPreviousSession()

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

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

bool

bool hasSession()

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

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

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

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

setSession(SessionInterface $session)

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

Параметры

SessionInterface

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

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

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

string

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

См. также

getRealMethod

string getRealMethod()

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

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

string

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

См. также

getMethod

string getMimeType(string $format)

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

Параметры

string

$format

Формат

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

string

Сопутствующий тип MIME (null, если не найден)

string|null getFormat(string $mimeType)

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

Параметры

string

$mimeType

Сопутствующий тип MIME

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

string|null

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

setFormat(string $format, string|array $mimeTypes)

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

Параметры

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

string getRequestFormat(string $default = 'html')

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

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

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

Параметры

string

$default

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

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

string

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

setRequestFormat(string $format)

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

Параметры

string

$format

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

string|null getContentType()

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

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

string|null

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

setDefaultLocale(string $locale)

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

Параметры

string

$locale

string getDefaultLocale()

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

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

string

setLocale(string $locale)

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

Параметры

string

$locale

string getLocale()

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

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

string

bool isMethod(string $method)

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

Параметры

string

$method

Заглавные буквы метода запроса (GET, POST и т. д.).

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

bool

bool isMethodSafe()

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

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

bool

string|resource getContent(bool $asResource = false)

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

Параметры

bool

$asResource

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

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

string|resource

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

Исключения

LogicException

array getETags()

Получает ETag.

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

array

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

bool isNoCache()

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

bool

string|null getPreferredLanguage(array $locales = null)

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

Параметры

array

$locales

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

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

string|null

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

array getLanguages()

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

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

array

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

array getCharsets()

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

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

array

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

array getEncodings()

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

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

array

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

array getAcceptableContentTypes()

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

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

array

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

bool isXmlHttpRequest()

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

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

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

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