1. class
  2. Symfony
  3. Component
  4. Routing
  5. RequestContext

RequestContext

class RequestContext

Holds information about the current request.

This class implements a fluent interface.

Methods

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

Constructor.

RequestContext
fromRequest(Request $request)

Updates the RequestContext information based on a HttpFoundation Request.

string
getBaseUrl()

Gets the base URL.

RequestContext
setBaseUrl(string $baseUrl)

Sets the base URL.

string
getPathInfo()

Gets the path info.

RequestContext
setPathInfo(string $pathInfo)

Sets the path info.

string
getMethod()

Gets the HTTP method.

RequestContext
setMethod(string $method)

Sets the HTTP method.

string
getHost()

Gets the HTTP host.

RequestContext
setHost(string $host)

Sets the HTTP host.

string
getScheme()

Gets the HTTP scheme.

RequestContext
setScheme(string $scheme)

Sets the HTTP scheme.

int
getHttpPort()

Gets the HTTP port.

RequestContext
setHttpPort(int $httpPort)

Sets the HTTP port.

int
getHttpsPort()

Gets the HTTPS port.

RequestContext
setHttpsPort(int $httpsPort)

Sets the HTTPS port.

string
getQueryString()

Gets the query string.

RequestContext
setQueryString(string $queryString)

Sets the query string.

array
getParameters()

Returns the parameters.

RequestContext
setParameters(array $parameters)

Sets the parameters.

mixed
getParameter(string $name)

Gets a parameter value.

bool
hasParameter(string $name)

Checks if a parameter value is set for the given parameter.

RequestContext
setParameter(string $name, mixed $parameter)

Sets a parameter value.

Details

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

Constructor.

Parameters

string $baseUrl The base URL
string $method The HTTP method
string $host The HTTP host name
string $scheme The HTTP scheme
int $httpPort The HTTP port
int $httpsPort The HTTPS port
string $path The path
string $queryString The query string

at line line 71
RequestContext fromRequest(Request $request)

Updates the RequestContext information based on a HttpFoundation Request.

Parameters

Request $request A Request instance

Return Value

RequestContext The current instance, implementing a fluent interface

at line line 90
string getBaseUrl()

Gets the base URL.

Return Value

string The base URL

at line line 102
RequestContext setBaseUrl(string $baseUrl)

Sets the base URL.

Parameters

string $baseUrl The base URL

Return Value

RequestContext The current instance, implementing a fluent interface

at line line 114
string getPathInfo()

Gets the path info.

Return Value

string The path info

at line line 126
RequestContext setPathInfo(string $pathInfo)

Sets the path info.

Parameters

string $pathInfo The path info

Return Value

RequestContext The current instance, implementing a fluent interface

at line line 140
string getMethod()

Gets the HTTP method.

The method is always an uppercased string.

Return Value

string The HTTP method

at line line 152
RequestContext setMethod(string $method)

Sets the HTTP method.

Parameters

string $method The HTTP method

Return Value

RequestContext The current instance, implementing a fluent interface

at line line 166
string getHost()

Gets the HTTP host.

The host is always lowercased because it must be treated case-insensitive.

Return Value

string The HTTP host

at line line 178
RequestContext setHost(string $host)

Sets the HTTP host.

Parameters

string $host The HTTP host

Return Value

RequestContext The current instance, implementing a fluent interface

at line line 190
string getScheme()

Gets the HTTP scheme.

Return Value

string The HTTP scheme

at line line 202
RequestContext setScheme(string $scheme)

Sets the HTTP scheme.

Parameters

string $scheme The HTTP scheme

Return Value

RequestContext The current instance, implementing a fluent interface

at line line 214
int getHttpPort()

Gets the HTTP port.

Return Value

int The HTTP port

at line line 226
RequestContext setHttpPort(int $httpPort)

Sets the HTTP port.

Parameters

int $httpPort The HTTP port

Return Value

RequestContext The current instance, implementing a fluent interface

at line line 238
int getHttpsPort()

Gets the HTTPS port.

Return Value

int The HTTPS port

at line line 250
RequestContext setHttpsPort(int $httpsPort)

Sets the HTTPS port.

Parameters

int $httpsPort The HTTPS port

Return Value

RequestContext The current instance, implementing a fluent interface

at line line 262
string getQueryString()

Gets the query string.

Return Value

string The query string without the "?"

at line line 274
RequestContext setQueryString(string $queryString)

Sets the query string.

Parameters

string $queryString The query string (after "?")

Return Value

RequestContext The current instance, implementing a fluent interface

at line line 287
array getParameters()

Returns the parameters.

Return Value

array The parameters

at line line 299
RequestContext setParameters(array $parameters)

Sets the parameters.

Parameters

array $parameters The parameters

Return Value

RequestContext The current instance, implementing a fluent interface

at line line 313
mixed getParameter(string $name)

Gets a parameter value.

Parameters

string $name A parameter name

Return Value

mixed The parameter value or null if nonexistent

at line line 325
bool hasParameter(string $name)

Checks if a parameter value is set for the given parameter.

Parameters

string $name A parameter name

Return Value

bool True if the parameter value is set, false otherwise

at line line 338
RequestContext setParameter(string $name, mixed $parameter)

Sets a parameter value.

Parameters

string $name A parameter name
mixed $parameter The parameter value

Return Value

RequestContext The current instance, implementing a fluent interface