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.

$this
fromRequest(Request $request)

Updates the RequestContext information based on a HttpFoundation Request.

string
getBaseUrl()

Gets the base URL.

$this
setBaseUrl(string $baseUrl)

Sets the base URL.

string
getPathInfo()

Gets the path info.

$this
setPathInfo(string $pathInfo)

Sets the path info.

string
getMethod()

Gets the HTTP method.

$this
setMethod(string $method)

Sets the HTTP method.

string
getHost()

Gets the HTTP host.

$this
setHost(string $host)

Sets the HTTP host.

string
getScheme()

Gets the HTTP scheme.

$this
setScheme(string $scheme)

Sets the HTTP scheme.

int
getHttpPort()

Gets the HTTP port.

$this
setHttpPort(int $httpPort)

Sets the HTTP port.

int
getHttpsPort()

Gets the HTTPS port.

$this
setHttpsPort(int $httpsPort)

Sets the HTTPS port.

string
getQueryString()

Gets the query string.

$this
setQueryString(string $queryString)

Sets the query string.

array
getParameters()

Returns the parameters.

$this
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.

$this
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
$this fromRequest(Request $request)

Updates the RequestContext information based on a HttpFoundation Request.

Parameters

Request $request A Request instance

Return Value

$this

at line line 90
string getBaseUrl()

Gets the base URL.

Return Value

string The base URL

at line line 102
$this setBaseUrl(string $baseUrl)

Sets the base URL.

Parameters

string $baseUrl The base URL

Return Value

$this

at line line 114
string getPathInfo()

Gets the path info.

Return Value

string The path info

at line line 126
$this setPathInfo(string $pathInfo)

Sets the path info.

Parameters

string $pathInfo The path info

Return Value

$this

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
$this setMethod(string $method)

Sets the HTTP method.

Parameters

string $method The HTTP method

Return Value

$this

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
$this setHost(string $host)

Sets the HTTP host.

Parameters

string $host The HTTP host

Return Value

$this

at line line 190
string getScheme()

Gets the HTTP scheme.

Return Value

string The HTTP scheme

at line line 202
$this setScheme(string $scheme)

Sets the HTTP scheme.

Parameters

string $scheme The HTTP scheme

Return Value

$this

at line line 214
int getHttpPort()

Gets the HTTP port.

Return Value

int The HTTP port

at line line 226
$this setHttpPort(int $httpPort)

Sets the HTTP port.

Parameters

int $httpPort The HTTP port

Return Value

$this

at line line 238
int getHttpsPort()

Gets the HTTPS port.

Return Value

int The HTTPS port

at line line 250
$this setHttpsPort(int $httpsPort)

Sets the HTTPS port.

Parameters

int $httpsPort The HTTPS port

Return Value

$this

at line line 262
string getQueryString()

Gets the query string.

Return Value

string The query string without the "?"

at line line 274
$this setQueryString(string $queryString)

Sets the query string.

Parameters

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

Return Value

$this

at line line 287
array getParameters()

Returns the parameters.

Return Value

array The parameters

at line line 299
$this setParameters(array $parameters)

Sets the parameters.

Parameters

array $parameters The parameters

Return Value

$this

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
$this setParameter(string $name, mixed $parameter)

Sets a parameter value.

Parameters

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

Return Value

$this