class ApacheRequest extends Request

Request represents an HTTP request from an Apache server.

Constants

HEADER_FORWARDED

HEADER_CLIENT_IP

HEADER_CLIENT_HOST

HEADER_CLIENT_PROTO

HEADER_CLIENT_PORT

METHOD_HEAD

METHOD_GET

METHOD_POST

METHOD_PUT

METHOD_PATCH

METHOD_DELETE

METHOD_PURGE

METHOD_OPTIONS

METHOD_TRACE

METHOD_CONNECT

Properties

static protected string[] $trustedProxies from Request
static protected string[] $trustedHostPatterns from Request
static protected string[] $trustedHosts from Request
static protected $trustedHeaders Names for headers that can be trusted when using trusted proxies. from Request
static protected $httpMethodParameterOverride from Request
ParameterBag $attributes Custom parameters. from Request
ParameterBag $request Request body parameters ($_POST). from Request
ParameterBag $query Query string parameters ($_GET). from Request
ServerBag $server Server and execution environment parameters ($_SERVER). from Request
FileBag $files Uploaded files ($_FILES). from Request
ParameterBag $cookies Cookies ($_COOKIE). from Request
HeaderBag $headers Headers (taken from the $_SERVER). from Request
protected string|resource|false|null $content from Request
protected array $languages from Request
protected array $charsets from Request
protected array $encodings from Request
protected array $acceptableContentTypes from Request
protected string $pathInfo from Request
protected string $requestUri from Request
protected string $baseUrl from Request
protected string $basePath from Request
protected string $method from Request
protected string $format from Request
protected SessionInterface $session from Request
protected string $locale from Request
protected string $defaultLocale from Request
static protected array $formats from Request
static protected $requestFactory from Request

Methods

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

No description

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

Sets the parameters for this request.

from Request
static Request
createFromGlobals()

Creates a new request with values from PHP's super globals.

from 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)

Creates a Request based on a given URI and configuration.

from Request
static 
setFactory(callable|null $callable)

Sets a callable able to create a Request instance.

from Request
duplicate(array $query = null, array $request = null, array $attributes = null, array $cookies = null, array $files = null, array $server = null)

Clones a request and overrides some of its parameters.

from Request
__clone()

Clones the current request.

from Request
string
__toString()

Returns the request as a string.

from Request
overrideGlobals()

Overrides the PHP global variables according to this request instance.

from Request
static 
setTrustedProxies(array $proxies)

Sets a list of trusted proxies.

from Request
static array
getTrustedProxies()

Gets the list of trusted proxies.

from Request
static 
setTrustedHosts(array $hostPatterns)

Sets a list of trusted host patterns.

from Request
static array
getTrustedHosts()

Gets the list of trusted host patterns.

from Request
static 
setTrustedHeaderName(string $key, string $value)

Sets the name for trusted headers.

from Request
static string
getTrustedHeaderName(string $key)

Gets the trusted proxy header name.

from Request
static string
normalizeQueryString(string $qs)

Normalizes a query string.

from Request
static 
enableHttpMethodParameterOverride()

Enables support for the _method request parameter to determine the intended HTTP method.

from Request
static bool
getHttpMethodParameterOverride()

Checks whether support for the _method request parameter is enabled.

from Request
mixed
get(string $key, mixed $default = null, bool $deep = false)

Gets a "parameter" value.

from Request
getSession()

Gets the Session.

from Request
bool
hasPreviousSession()

Whether the request contains a Session which was started in one of the previous requests.

from Request
bool
hasSession()

Whether the request contains a Session object.

from Request
setSession(SessionInterface $session)

Sets the Session.

from Request
array
getClientIps()

Returns the client IP addresses.

from Request
string|null
getClientIp()

Returns the client IP address.

from Request
string
getScriptName()

Returns current script name.

from Request
string
getPathInfo()

Returns the path being requested relative to the executed script.

from Request
string
getBasePath()

Returns the root path from which this request is executed.

from Request
string
getBaseUrl()

Returns the root URL from which this request is executed.

from Request
string
getScheme()

Gets the request's scheme.

from Request
int|string
getPort()

Returns the port on which the request is made.

from Request
string|null
getUser()

Returns the user.

from Request
string|null
getPassword()

Returns the password.

from Request
string
getUserInfo()

Gets the user info.

from Request
string
getHttpHost()

Returns the HTTP host being requested.

from Request
string
getRequestUri()

Returns the requested URI (path and query string).

from Request
string
getSchemeAndHttpHost()

Gets the scheme and HTTP host.

from Request
string
getUri()

Generates a normalized URI (URL) for the Request.

from Request
string
getUriForPath(string $path)

Generates a normalized URI for the given path.

from Request
string
getRelativeUriForPath(string $path)

Returns the path as relative reference from the current Request path.

from Request
string|null
getQueryString()

Generates the normalized query string for the Request.

from Request
bool
isSecure()

Checks whether the request is secure or not.

from Request
string
getHost()

Returns the host name.

from Request
setMethod(string $method)

Sets the request method.

from Request
string
getMethod()

Gets the request "intended" method.

from Request
string
getRealMethod()

Gets the "real" request method.

from Request
string|null
getMimeType(string $format)

Gets the mime type associated with the format.

from Request
string|null
getFormat(string $mimeType)

Gets the format associated with the mime type.

from Request
setFormat(string $format, string|array $mimeTypes)

Associates a format with mime types.

from Request
string
getRequestFormat(string|null $default = 'html')

Gets the request format.

from Request
setRequestFormat(string $format)

Sets the request format.

from Request
string|null
getContentType()

Gets the format associated with the request.

from Request
setDefaultLocale(string $locale)

Sets the default locale.

from Request
string
getDefaultLocale()

Get the default locale.

from Request
setLocale(string $locale)

Sets the locale.

from Request
string
getLocale()

Get the locale.

from Request
bool
isMethod(string $method)

Checks if the request method is of specified type.

from Request
bool
isMethodSafe()

Checks whether the method is safe or not.

from Request
bool
isMethodCacheable()

Checks whether the method is cacheable or not.

from Request
string|resource
getContent(bool $asResource = false)

Returns the request body content.

from Request
array
getETags()

Gets the Etags.

from Request
bool
isNoCache()

No description

from Request
string|null
getPreferredLanguage(array $locales = null)

Returns the preferred language.

from Request
array
getLanguages()

Gets a list of languages acceptable by the client browser.

from Request
array
getCharsets()

Gets a list of charsets acceptable by the client browser.

from Request
array
getEncodings()

Gets a list of encodings acceptable by the client browser.

from Request
array
getAcceptableContentTypes()

Gets a list of content types acceptable by the client browser.

from Request
bool
isXmlHttpRequest()

Returns true if the request is a XMLHttpRequest.

from Request
prepareRequestUri()

No description

string
prepareBaseUrl()

Prepares the base URL.

string
prepareBasePath()

Prepares the base path.

from Request
string
preparePathInfo()

Prepares the path info.

from Request
static 
initializeFormats()

Initializes HTTP request formats.

from Request

Details

in Request at line 227
__construct(array $query = array(), array $request = array(), array $attributes = array(), array $cookies = array(), array $files = array(), array $server = array(), string|resource|null $content = null)

Parameters

array $query The GET parameters
array $request The POST parameters
array $attributes The request attributes (parameters parsed from the PATH_INFO, ...)
array $cookies The COOKIE parameters
array $files The FILES parameters
array $server The SERVER parameters
string|resource|null $content The raw body data

in Request at line 245
initialize(array $query = array(), array $request = array(), array $attributes = array(), array $cookies = array(), array $files = array(), array $server = array(), string|resource|null $content = null)

Sets the parameters for this request.

This method also re-initializes all properties.

Parameters

array $query The GET parameters
array $request The POST parameters
array $attributes The request attributes (parameters parsed from the PATH_INFO, ...)
array $cookies The COOKIE parameters
array $files The FILES parameters
array $server The SERVER parameters
string|resource|null $content The raw body data

in Request at line 273
static Request createFromGlobals()

Creates a new request with values from PHP's super globals.

Return Value

Request

in Request at line 316
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)

Creates a Request based on a given URI and configuration.

The information contained in the URI always take precedence over the other information (server and parameters).

Parameters

string $uri The URI
string $method The HTTP method
array $parameters The query (GET) or request (POST) parameters
array $cookies The request cookies ($_COOKIE)
array $files The request files ($_FILES)
array $server The server parameters ($_SERVER)
string|resource|null $content The raw body data

Return Value

Request

in Request at line 417
static setFactory(callable|null $callable)

Sets a callable able to create a Request instance.

This is mainly useful when you need to override the Request class to keep BC with an existing system. It should not be used for any other purpose.

Parameters

callable|null $callable A PHP callable

in Request at line 434
Request duplicate(array $query = null, array $request = null, array $attributes = null, array $cookies = null, array $files = null, array $server = null)

Clones a request and overrides some of its parameters.

Parameters

array $query The GET parameters
array $request The POST parameters
array $attributes The request attributes (parameters parsed from the PATH_INFO, ...)
array $cookies The COOKIE parameters
array $files The FILES parameters
array $server The SERVER parameters

Return Value

Request

in Request at line 484
__clone()

Clones the current request.

Note that the session is not cloned as duplicated requests are most of the time sub-requests of the main one.

in Request at line 500
string __toString()

Returns the request as a string.

Return Value

string The request

in Request at line 532
overrideGlobals()

Overrides the PHP global variables according to this request instance.

It overrides $_GET, $_POST, $_REQUEST, $_SERVER, $_COOKIE. $_FILES is never overridden, see rfc1867

in Request at line 568
static setTrustedProxies(array $proxies)

Sets a list of trusted proxies.

You should only list the reverse proxies that you manage directly.

Parameters

array $proxies A list of trusted proxies

in Request at line 578
static array getTrustedProxies()

Gets the list of trusted proxies.

Return Value

array An array of trusted proxies

in Request at line 590
static setTrustedHosts(array $hostPatterns)

Sets a list of trusted host patterns.

You should only list the hosts you manage using regexs.

Parameters

array $hostPatterns A list of trusted host patterns

in Request at line 604
static array getTrustedHosts()

Gets the list of trusted host patterns.

Return Value

array An array of trusted host patterns

in Request at line 627
static setTrustedHeaderName(string $key, string $value)

Sets the name for trusted headers.

The following header keys are supported:

  • Request::HEADER_CLIENT_IP: defaults to X-Forwarded-For (see getClientIp())
  • Request::HEADER_CLIENT_HOST: defaults to X-Forwarded-Host (see getHost())
  • Request::HEADER_CLIENT_PORT: defaults to X-Forwarded-Port (see getPort())
  • Request::HEADER_CLIENT_PROTO: defaults to X-Forwarded-Proto (see getScheme() and isSecure())
  • Request::HEADER_FORWARDED: defaults to Forwarded (see RFC 7239)

Setting an empty value allows to disable the trusted header for the given key.

Parameters

string $key The header key
string $value The header name

Exceptions

InvalidArgumentException

in Request at line 645
static string getTrustedHeaderName(string $key)

Gets the trusted proxy header name.

Parameters

string $key The header key

Return Value

string The header name

Exceptions

InvalidArgumentException

in Request at line 664
static string normalizeQueryString(string $qs)

Normalizes a query string.

It builds a normalized query string, where keys/value pairs are alphabetized, have consistent escaping and unneeded delimiters are removed.

Parameters

string $qs Query string

Return Value

string A normalized query string for the Request

in Request at line 708
static enableHttpMethodParameterOverride()

Enables support for the _method request parameter to determine the intended HTTP method.

Be warned that enabling this feature might lead to CSRF issues in your code. Check that you are using CSRF tokens when required. If the HTTP method parameter override is enabled, an html-form with method "POST" can be altered and used to send a "PUT" or "DELETE" request via the _method request parameter. If these methods are not protected against CSRF, this presents a possible vulnerability.

The HTTP method can only be overridden when the real HTTP method is POST.

in Request at line 718
static bool getHttpMethodParameterOverride()

Checks whether support for the _method request parameter is enabled.

Return Value

bool True when the _method request parameter is enabled, false otherwise

in Request at line 746
mixed get(string $key, mixed $default = null, bool $deep = false)

Gets a "parameter" value.

This method is mainly useful for libraries that want to provide some flexibility.

Order of precedence: GET, PATH, POST

Avoid using this method in controllers:

  • slow
  • prefer to get from a "named" source

It is better to explicitly get request parameters from the appropriate public property instead (query, attributes, request).

Note: Finding deep items is deprecated since version 2.8, to be removed in 3.0.

Parameters

string $key The key
mixed $default The default value if the parameter key does not exist
bool $deep Is parameter deep in multidimensional array

Return Value

mixed

in Request at line 772
SessionInterface|null getSession()

Gets the Session.

Return Value

SessionInterface|null The session

in Request at line 783
bool hasPreviousSession()

Whether the request contains a Session which was started in one of the previous requests.

Return Value

bool

in Request at line 798
bool hasSession()

Whether the request contains a Session object.

This method does not give any information about the state of the session object, like whether the session is started or not. It is just a way to check if this Request is associated with a Session instance.

Return Value

bool true when the Request contains a Session object, false otherwise

in Request at line 808
setSession(SessionInterface $session)

Sets the Session.

Parameters

SessionInterface $session The Session

in Request at line 826
array getClientIps()

Returns the client IP addresses.

In the returned array the most trusted IP address is first, and the least trusted one last. The "real" client IP address is the last one, but this is also the least trusted one. Trusted proxies are stripped.

Use this method carefully; you should use getClientIp() instead.

Return Value

array The client IP addresses

See also

getClientIp()

in Request at line 855
string|null getClientIp()

Returns the client IP address.

This method can read the client IP address from the "X-Forwarded-For" header when trusted proxies were set via "setTrustedProxies()". The "X-Forwarded-For" header value is a comma+space separated list of IP addresses, the left-most being the original client, and each successive proxy that passed the request adding the IP address where it received the request from.

If your reverse proxy uses a different header name than "X-Forwarded-For", ("Client-Ip" for instance), configure it via "setTrustedHeaderName()" with the "client-ip" key.

Return Value

string|null The client IP address

See also

getClientIps()
http://en.wikipedia.org/wiki/X-Forwarded-For

in Request at line 867
string getScriptName()

Returns current script name.

Return Value

string

in Request at line 886
string getPathInfo()

Returns the path being requested relative to the executed script.

The path info always starts with a /.

Suppose this request is instantiated from /mysite on localhost:

  • http://localhost/mysite returns an empty string
  • http://localhost/mysite/about returns '/about'
  • http://localhost/mysite/enco%20ded returns '/enco%20ded'
  • http://localhost/mysite/about?var=1 returns '/about'

Return Value

string The raw path (i.e. not urldecoded)

in Request at line 907
string getBasePath()

Returns the root path from which this request is executed.

Suppose that an index.php file instantiates this request object:

  • http://localhost/index.php returns an empty string
  • http://localhost/index.php/page returns an empty string
  • http://localhost/web/index.php returns '/web'
  • http://localhost/we%20b/index.php returns '/we%20b'

Return Value

string The raw path (i.e. not urldecoded)

in Request at line 926
string getBaseUrl()

Returns the root URL from which this request is executed.

The base URL never ends with a /.

This is similar to getBasePath(), except that it also includes the script filename (e.g. index.php) if one exists.

Return Value

string The raw URL (i.e. not urldecoded)

in Request at line 940
string getScheme()

Gets the request's scheme.

Return Value

string

in Request at line 958
int|string getPort()

Returns the port on which the request is made.

This method can read the client port from the "X-Forwarded-Port" header when trusted proxies were set via "setTrustedProxies()".

The "X-Forwarded-Port" header must contain the client port.

If your reverse proxy uses a different header name than "X-Forwarded-Port", configure it via "setTrustedHeaderName()" with the "client-port" key.

Return Value

int|string can be a string if fetched from the server bag

in Request at line 986
string|null getUser()

Returns the user.

Return Value

string|null

in Request at line 996
string|null getPassword()

Returns the password.

Return Value

string|null

in Request at line 1006
string getUserInfo()

Gets the user info.

Return Value

string A user name and, optionally, scheme-specific information about how to gain authorization to access the server

in Request at line 1025
string getHttpHost()

Returns the HTTP host being requested.

The port name will be appended to the host if it's non-standard.

Return Value

string

in Request at line 1042
string getRequestUri()

Returns the requested URI (path and query string).

Return Value

string The raw URI (i.e. not URI decoded)

in Request at line 1059
string getSchemeAndHttpHost()

Gets the scheme and HTTP host.

If the URL was called with basic authentication, the user and the password are not added to the generated string.

Return Value

string The scheme and HTTP host

in Request at line 1071
string getUri()

Generates a normalized URI (URL) for the Request.

Return Value

string A normalized URI (URL) for the Request

See also

getQueryString()

in Request at line 1087
string getUriForPath(string $path)

Generates a normalized URI for the given path.

Parameters

string $path A path to use instead of the current one

Return Value

string The normalized URI for the path

in Request at line 1111
string getRelativeUriForPath(string $path)

Returns the path as relative reference from the current Request path.

Only the URIs path component (no schema, host etc.) is relevant and must be given. Both paths must be absolute and not contain relative parts. Relative URLs from one resource to another are useful when generating self-contained downloadable document archives. Furthermore, they can be used to reduce the link size in documents.

Example target paths, given a base path of "/a/b/c/d": - "/a/b/c/d" -> "" - "/a/b/c/" -> "./" - "/a/b/" -> "../" - "/a/b/c/other" -> "other" - "/a/x/y" -> "../../x/y"

Parameters

string $path The target path

Return Value

string The relative target path

in Request at line 1155
string|null getQueryString()

Generates the normalized query string for the Request.

It builds a normalized query string, where keys/value pairs are alphabetized and have consistent escaping.

Return Value

string|null A normalized query string for the Request

in Request at line 1176
bool isSecure()

Checks whether the request is secure or not.

This method can read the client protocol from the "X-Forwarded-Proto" header when trusted proxies were set via "setTrustedProxies()".

The "X-Forwarded-Proto" header must contain the protocol: "https" or "http".

If your reverse proxy uses a different header name than "X-Forwarded-Proto" ("SSL_HTTPS" for instance), configure it via "setTrustedHeaderName()" with the "client-proto" key.

Return Value

bool

in Request at line 1202
string getHost()

Returns the host name.

This method can read the client host name from the "X-Forwarded-Host" header when trusted proxies were set via "setTrustedProxies()".

The "X-Forwarded-Host" header must contain the client host name.

If your reverse proxy uses a different header name than "X-Forwarded-Host", configure it via "setTrustedHeaderName()" with the "client-host" key.

Return Value

string

Exceptions

UnexpectedValueException when the host name is invalid

in Request at line 1249
setMethod(string $method)

Sets the request method.

Parameters

string $method

in Request at line 1270
string getMethod()

Gets the request "intended" method.

If the X-HTTP-Method-Override header is set, and if the method is a POST, then it is used to determine the "real" intended HTTP method.

The _method request parameter can also be used to determine the HTTP method, but only if enableHttpMethodParameterOverride() has been called.

The method is always an uppercased string.

Return Value

string The request method

See also

getRealMethod()

in Request at line 1297
string getRealMethod()

Gets the "real" request method.

Return Value

string The request method

See also

getMethod()

in Request at line 1309
string|null getMimeType(string $format)

Gets the mime type associated with the format.

Parameters

string $format The format

Return Value

string|null The associated mime type (null if not found)

in Request at line 1325
string|null getFormat(string $mimeType)

Gets the format associated with the mime type.

Parameters

string $mimeType The associated mime type

Return Value

string|null The format (null if not found)

in Request at line 1352
setFormat(string $format, string|array $mimeTypes)

Associates a format with mime types.

Parameters

string $format The format
string|array $mimeTypes The associated mime types (the preferred one must be the first as it will be used as the content type)

in Request at line 1374
string getRequestFormat(string|null $default = 'html')

Gets the request format.

Here is the process to determine the format:

  • format defined by the user (with setRequestFormat())
  • _format request parameter
  • $default

Parameters

string|null $default The default format

Return Value

string The request format

in Request at line 1388
setRequestFormat(string $format)

Sets the request format.

Parameters

string $format The request format

in Request at line 1398
string|null getContentType()

Gets the format associated with the request.

Return Value

string|null The format (null if no content type is present)

in Request at line 1408
setDefaultLocale(string $locale)

Sets the default locale.

Parameters

string $locale

in Request at line 1422
string getDefaultLocale()

Get the default locale.

Return Value

string

in Request at line 1432
setLocale(string $locale)

Sets the locale.

Parameters

string $locale

in Request at line 1442
string getLocale()

Get the locale.

Return Value

string

in Request at line 1454
bool isMethod(string $method)

Checks if the request method is of specified type.

Parameters

string $method Uppercase request method (GET, POST etc)

Return Value

bool

in Request at line 1468
bool isMethodSafe()

Checks whether the method is safe or not.

in Request at line 1480
bool isMethodCacheable()

Checks whether the method is cacheable or not.

in Request at line 1494
string|resource getContent(bool $asResource = false)

Returns the request body content.

Parameters

bool $asResource If true, a resource will be returned

Return Value

string|resource The request body content or a resource to read the body stream

Exceptions

LogicException

in Request at line 1540
array getETags()

Gets the Etags.

Return Value

array The entity tags

in Request at line 1548
bool isNoCache()

Return Value

bool

in Request at line 1560
string|null getPreferredLanguage(array $locales = null)

Returns the preferred language.

Parameters

array $locales An array of ordered available locales

Return Value

string|null The preferred locale

in Request at line 1593
array getLanguages()

Gets a list of languages acceptable by the client browser.

Return Value

array Languages ordered in the user browser preferences

in Request at line 1633
array getCharsets()

Gets a list of charsets acceptable by the client browser.

Return Value

array List of charsets in preferable order

in Request at line 1647
array getEncodings()

Gets a list of encodings acceptable by the client browser.

Return Value

array List of encodings in preferable order

in Request at line 1661
array getAcceptableContentTypes()

Gets a list of content types acceptable by the client browser.

Return Value

array List of content types in preferable order

in Request at line 1680
bool isXmlHttpRequest()

Returns true if the request is a XMLHttpRequest.

It works if your JavaScript library sets an X-Requested-With HTTP header. It is known to work with common JavaScript frameworks:

Return Value

bool true if the request is an XMLHttpRequest, false otherwise

See also

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

at line 24
protected prepareRequestUri()

at line 32
protected string prepareBaseUrl()

Prepares the base URL.

Return Value

string

in Request at line 1798
protected string prepareBasePath()

Prepares the base path.

Return Value

string base path

in Request at line 1824
protected string preparePathInfo()

Prepares the path info.

Return Value

string path info

in Request at line 1854
static protected initializeFormats()

Initializes HTTP request formats.