Spec-Zone.ru › Symfony 3.2

RequestContext

class RequestContext

Содержит информацию о текущем запросе.

Этот класс реализует интерфейс fluent.

Методы

__construct(string $baseUrl = '', string $method = 'GET', string $host = 'localhost', string $scheme = 'http', int $httpPort = 80, int $httpsPort = 443, string $path = '/', string $queryString = '')

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

$this fromRequest(Request $request)

Обновляет информацию RequestContext на основе объекта HttpFoundation Request.

string getBaseUrl()

Получает базовый URL.

$this setBaseUrl(string $baseUrl)

Устанавливает базовый URL.

string getPathInfo()

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

$this setPathInfo(string $pathInfo)

Устанавливает информацию о пути.

string getMethod()

Получает HTTP-метод.

$this setMethod(string $method)

Устанавливает HTTP-метод.

string getHost()

Получает HTTP-хост.

$this setHost(string $host)

Устанавливает HTTP-хост.

string getScheme()

Получает HTTP-схему.

$this setScheme(string $scheme)

Устанавливает HTTP-схему.

int getHttpPort()

Получает HTTP-порт.

$this setHttpPort(int $httpPort)

Устанавливает HTTP-порт.

int getHttpsPort()

Получает HTTPS-порт.

$this setHttpsPort(int $httpsPort)

Устанавливает HTTPS-порт.

string getQueryString()

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

$this setQueryString(string $queryString)

Устанавливает строку запроса.

array getParameters()

Возвращает параметры.

$this setParameters(array $parameters)

Устанавливает параметры.

mixed getParameter(string $name)

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

bool hasParameter(string $name)

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

$this 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 Строка запроса

$this fromRequest(Request $request)

Обновляет информацию RequestContext на основе объекта HttpFoundation Request.

Параметры

Request $request Экземпляр Request

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

$this

string getBaseUrl()

Возвращает базовый URL.

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

string Базовый URL

$this setBaseUrl(string $baseUrl)

Устанавливает базовый URL.

Параметры

string $baseUrl Базовый URL

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

$this

string getPathInfo()

Возвращает информацию о пути.

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

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

$this setPathInfo(string $pathInfo)

Устанавливает информацию о пути.

Параметры

string $pathInfo Информация о пути

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

$this

string getMethod()

Возвращает HTTP-метод.

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

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

string HTTP-метод

$this setMethod(string $method)

Устанавливает HTTP-метод.

Параметры

string $method HTTP-метод

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

$this

string getHost()

Возвращает HTTP-хост.

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

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

string HTTP-хост

$this setHost(string $host)

Устанавливает HTTP-хост.

Параметры

string $host HTTP-хост

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

$this

string getScheme()

Возвращает HTTP-схему.

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

string HTTP-схема

$this setScheme(string $scheme)

Устанавливает HTTP-схему.

Параметры

string $scheme HTTP-схема

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

$this

int getHttpPort()

Возвращает порт HTTP.

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

int Порт HTTP

$this setHttpPort(int $httpPort)

Устанавливает порт HTTP.

Параметры

int $httpPort Порт HTTP

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

$this

int getHttpsPort()

Возвращает порт HTTPS.

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

int Порт HTTPS

$this setHttpsPort(int $httpsPort)

Устанавливает порт HTTPS.

Параметры

int $httpsPort Порт HTTPS

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

$this

string getQueryString()

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

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

string Строка запроса без "?"

$this setQueryString(string $queryString)

Устанавливает строку запроса.

Параметры

string $queryString Строка запроса (после "?")

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

$this

array getParameters()

Возвращает параметры.

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

array Параметры

$this setParameters(array $parameters)

Устанавливает параметры.

Параметры

array $parameters Параметры

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

$this

mixed getParameter(string $name)

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

Параметры

string $name Имя параметра

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

mixed Значение параметра или null, если параметр не существует

bool hasParameter(string $name)

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

Параметры

string $name Имя параметра

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

bool True, если значение параметра установлено, иначе false

$this setParameter(string $name, mixed $parameter)

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

Параметры

string $name Имя параметра
mixed $parameter Значение параметра

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

$this

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.2/Symfony/Component/Routing/RequestContext.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API