ApacheRequest

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

Параметры

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

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

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

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

Параметры

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

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

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

Параметры

string	$uri	URI
string	$method	HTTP-метод
array	$parameters	Параметры запроса (GET или POST)
array	$cookies	Куки запроса ($_COOKIE)
array	$files	Файлы запроса ($_FILES)
array	$server	Параметры сервера ($_SERVER)
string|resource|null	$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, int $trustedHeaderSet)

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

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

Параметры

array	$proxies	Список доверенных прокси
int	$trustedHeaderSet	Поле битов Request::HEADER_*, определяющее, какие заголовки следует доверять от ваших прокси

Исключения

InvalidArgumentException

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

static array getTrustedProxies()

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

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

array

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

static int getTrustedHeaderSet()

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

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

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

static setTrustedHosts(array $hostPatterns)

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

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

Параметры

array

$hostPatterns

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

static array getTrustedHosts()

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

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

array

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

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)

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

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

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

Параметры

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

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

mixed

SessionInterface|null getSession()

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

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

SessionInterface|null

Сессия

bool hasPreviousSession()

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

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

bool

bool hasSession()

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

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

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

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

setSession(SessionInterface $session)

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

Параметры

SessionInterface

$session

Сеанс

setSessionFactory(callable $factory)

Параметры

callable

$factory

array getClientIps()

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

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

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

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

array

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

См. также

getClientIp()

string|null getClientIp()

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

Этот метод может читать адрес IP-клиента из заголовка «X-Forwarded-For», если доверенные прокси-серверы были установлены с помощью «setTrustedProxies()». Значение заголовка «X-Forwarded-For» представляет собой список 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» должен содержать порт клиента.

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

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».

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

bool

string getHost()

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

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

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

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

string

Исключения

SuspiciousOperationException

если имя хоста недействительно или недоверенно

setMethod(string $method)

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

Параметры

string

$method

string getMethod()

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

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

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

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

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

string

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

См. также

getRealMethod()

string getRealMethod()

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

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

string

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

См. также

getMethod()

string|null getMimeType(string $format)

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

Параметры

string

$format

Формат

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

string|null

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

static array getMimeTypes(string $format)

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

Параметры

string

$format

Формат

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

array

Сопоставленные типы MIME

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|null $default = 'html')

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

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

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

Параметры

string|null

$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

См. также

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

bool isMethodIdempotent()

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

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

bool

bool isMethodCacheable()

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

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

bool

См. также

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

string getProtocolVersion()

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

Если приложение находится за прокси-сервером, версия протокола, используемая в запросах между клиентом и прокси-сервером и между прокси-сервером и сервером, может отличаться. Это возвращает первую (из заголовка "Via"), если прокси-сервер надёжен (см. "setTrustedProxies()"), в противном случае возвращает последнюю (из параметра сервера "SERVER_PROTOCOL").

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

string

string|resource getContent(bool $asResource = false)

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

Параметры

bool

$asResource

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

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

string|resource

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

Исключения

LogicException

array getETags()

Получает ETags.

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

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

См. также

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

protected prepareRequestUri()

protected string prepareBaseUrl()

Подготавливает базовый URL.

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

string

protected string prepareBasePath()

Подготавливает базовый путь.

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

string

базовый путь

protected string preparePathInfo()

Подготавливает информацию о пути.

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

string

информация о пути

static protected initializeFormats()

Инициализирует форматы HTTP-запроса.

bool isFromTrustedProxy()

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

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

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

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