RequestContext
класс RequestContext
Содержит информацию о текущем запросе.
Этот класс реализует интерфейс потоковой обработки.
Методы
| __construct(string $baseUrl = '', string $method = 'GET', string $host = 'localhost', string $scheme = 'http', int $httpPort = 80, int $httpsPort = 443, string $path = '/', string $queryString = '') Конструктор. | ||
| RequestContext | fromRequest(Request $request) Обновляет информацию RequestContext на основе запроса HttpFoundation. | |
| string | getBaseUrl() Получает базовый URL. | |
| RequestContext | setBaseUrl(string $baseUrl) Устанавливает базовый URL. | |
| string | getPathInfo() Получает информацию о пути. | |
| RequestContext | setPathInfo(string $pathInfo) Устанавливает информацию о пути. | |
| string | getMethod() Получает HTTP-метод. | |
| RequestContext | setMethod(string $method) Устанавливает HTTP-метод. | |
| string | getHost() Получает HTTP-хост. | |
| RequestContext | setHost(string $host) Устанавливает HTTP-хост. | |
| string | getScheme() Получает HTTP-схему. | |
| RequestContext | setScheme(string $scheme) Устанавливает HTTP-схему. | |
| int | getHttpPort() Получает HTTP-порт. | |
| RequestContext | setHttpPort(int $httpPort) Устанавливает HTTP-порт. | |
| int | getHttpsPort() Получает HTTPS-порт. | |
| RequestContext | setHttpsPort(int $httpsPort) Устанавливает HTTPS-порт. | |
| string | getQueryString() Получает строку запроса. | |
| RequestContext | setQueryString(string $queryString) Устанавливает строку запроса. | |
| array | getParameters() Возвращает параметры. | |
| RequestContext | setParameters(array $parameters) Устанавливает параметры. | |
| mixed | getParameter(string $name) Получает значение параметра. | |
| bool | hasParameter(string $name) Проверяет, установлено ли значение параметра для данного параметра. | |
| RequestContext | setParameter(string $name, mixed $parameter) Устанавливает значение параметра. |
Подробности
__construct(string $baseUrl = '', string $method = 'GET', string $host = 'localhost', string $scheme = 'http', int $httpPort = 80, int $httpsPort = 443, string $path = '/', string $queryString = '')
Конструктор.
Параметры
| string | $baseUrl | Базовый URL |
| string | $method | Метод HTTP |
| string | $host | Имя хоста HTTP |
| string | $scheme | Схема HTTP |
| int | $httpPort | Порт HTTP |
| int | $httpsPort | Порт HTTPS |
| string | $path | Путь |
| string | $queryString | Строка запроса |
RequestContext fromRequest(Request $request)
Обновляет информацию RequestContext на основе объекта HttpFoundation Request.
Параметры
| Request | $request | Экземпляр Request |
Возвращаемое значение
| RequestContext | Текущий экземпляр, реализующий интерфейс fluent |
string getBaseUrl()
Получение базового URL.
Возвращаемое значение
| string | Базовый URL |
RequestContext setBaseUrl(string $baseUrl)
Установка базового URL.
Параметры
| string | $baseUrl | Базовый URL |
Возвращаемое значение
| RequestContext | Текущий экземпляр, реализующий интерфейс fluent |
string getPathInfo()
Получение информации о пути.
Возвращаемое значение
| string | Информация о пути |
RequestContext setPathInfo(string $pathInfo)
Установка информации о пути.
Параметры
| string | $pathInfo | Информация о пути |
Возвращаемое значение
| RequestContext | Текущий экземпляр, реализующий интерфейс fluent |
string getMethod()
Получение метода HTTP.
Метод всегда представляет собой строку в верхнем регистре.
Возвращаемое значение
| string | Метод HTTP |
RequestContext setMethod(string $method)
Установка метода HTTP.
Параметры
| string | $method | Метод HTTP |
Возвращаемое значение
| RequestContext | Текущий экземпляр, реализующий интерфейс fluent |
string getHost()
Получение хоста HTTP.
Хост всегда в нижнем регистре, так как он должен рассматриваться как нечувствительный к регистру.
Возвращаемое значение
| string | Хост HTTP |
RequestContext setHost(string $host)
Установка хоста HTTP.
Параметры
| string | $host | Хост HTTP |
Возвращаемое значение
| RequestContext | Текущий экземпляр, реализующий интерфейс fluent |
string getScheme()
Получение схемы HTTP.
Возвращаемое значение
| string | Схема HTTP |
RequestContext setScheme(string $scheme)
Установка схемы HTTP.
Параметры
| string | $scheme | Схема HTTP |
Возвращаемое значение
| RequestContext | Текущий экземпляр, реализующий интерфейс fluent |
int getHttpPort()
Получение порта HTTP.
Возвращаемое значение
| int | Порт HTTP |
RequestContext setHttpPort(int $httpPort)
Установка порта HTTP.
Параметры
| int | $httpPort | Порт HTTP |
Возвращаемое значение
| RequestContext | Текущий экземпляр, реализующий интерфейс fluent |
int getHttpsPort()
Получение порта HTTPS.
Возвращаемое значение
| int | Порт HTTPS |
RequestContext setHttpsPort(int $httpsPort)
Установка порта HTTPS.
Параметры
| int | $httpsPort | Порт HTTPS |
Возвращаемое значение
| RequestContext | Текущий экземпляр, реализующий интерфейс fluent |
string getQueryString()
Получение строки запроса.
Возвращаемое значение
| string | Строка запроса без "?" |
RequestContext setQueryString(string $queryString)
Установка строки запроса.
Параметры
| string | $queryString | Строка запроса (после "?") |
Возвращаемое значение
| RequestContext | Текущий экземпляр, реализующий интерфейс fluent |
array getParameters()
Возвращает параметры.
Возвращаемое значение
| array | Параметры |
RequestContext setParameters(array $parameters)
Установка параметров.
Параметры
| array | $parameters | Параметры |
Возвращаемое значение
| RequestContext | Текущий экземпляр, реализующий интерфейс fluent |
mixed getParameter(string $name)
Получение значения параметра.
Параметры
| string | $name | Имя параметра |
Возвращаемое значение
| mixed | Значение параметра или null, если параметр не существует |
bool hasParameter(string $name)
Проверка наличия значения параметра для заданного параметра.
Параметры
| string | $name | Имя параметра |
Возвращаемое значение
| bool | True, если значение параметра установлено, false в противном случае |
RequestContext setParameter(string $name, mixed $parameter)
Установка значения параметра.
Параметры
| string | $name | Имя параметра |
| mixed | $parameter | Значение параметра |
Возвращаемое значение
| RequestContext | Текущий экземпляр, реализующий интерфейс fluent |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/Routing/RequestContext.html
