__construct()

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

Constructor.

Parameters

initialize()

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

Sets the parameters for this request.

This method also re-initializes all properties.

Parameters

createFromGlobals()

createFromGlobals() : \Symfony\Component\HttpFoundation\Request

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

Returns

A new request

create()

create(string  $uri, string  $method = 'GET', array  $parameters = array(), array  $cookies = array(), array  $files = array(), array  $server = array(), string  $content = null) : \Symfony\Component\HttpFoundation\Request

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

Returns

A Request instance

duplicate()

duplicate(array  $query = null, array  $request = null, array  $attributes = null, array  $cookies = null, array  $files = null, array  $server = null) : \Symfony\Component\HttpFoundation\Request

Clones a request and overrides some of its parameters.

Parameters

Returns

The duplicated request

__clone()

__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.

__toString()

__toString() : string

Returns the request as a string.

Returns

The request

overrideGlobals()

overrideGlobals() 

Overrides the PHP global variables according to this request instance.

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

trustProxyData()

trustProxyData() 

Trusts $_SERVER entries coming from proxies.

setTrustedProxies()

setTrustedProxies(array  $proxies) 

Sets a list of trusted proxies.

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

Parameters

getTrustedProxies()

getTrustedProxies() : array

Gets the list of trusted proxies.

Returns

An array of trusted proxies.

setTrustedHeaderName()

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 getClientHost())
• Request::HEADER_CLIENT_PORT: defaults to X-Forwarded-Port (see getClientPort())
• Request::HEADER_CLIENT_PROTO: defaults to X-Forwarded-Proto (see getScheme() and isSecure())

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

Parameters

Throws

InvalidArgumentException

isProxyTrusted()

isProxyTrusted() : boolean

Returns true if $_SERVER entries coming from proxies are trusted, false otherwise.

Returns

normalizeQueryString()

normalizeQueryString(string  $qs) : string

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

Returns

A normalized query string for the Request

enableHttpMethodParameterOverride()

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.

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

getHttpMethodParameterOverride()

getHttpMethodParameterOverride() : Boolean

Checks whether support for the _method request parameter is enabled.

Returns

True when the _method request parameter is enabled, false otherwise

get()

get(string  $key, mixed  $default = null, Boolean  $deep = false) : mixed

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

Parameters

Returns

getSession()

getSession() : \Symfony\Component\HttpFoundation\Session\SessionInterface|null

Gets the Session.

Returns

The session

hasPreviousSession()

hasPreviousSession() : Boolean

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

Returns

hasSession()

hasSession() : Boolean

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.

Returns

true when the Request contains a Session object, false otherwise

setSession()

setSession(\Symfony\Component\HttpFoundation\Session\SessionInterface  $session) 

Sets the Session.

Parameters

getClientIp()

getClientIp() : string

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.

Returns

The client IP address

getScriptName()

getScriptName() : string

Returns current script name.

Returns

getPathInfo()

getPathInfo() : string

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 ded returns '/enco ded'
• http://localhost/mysite/about?var=1 returns '/about'

Returns

The raw path (i.e. not urldecoded)

getBasePath()

getBasePath() : string

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 b/index.php returns '/we b'

Returns

The raw path (i.e. not urldecoded)

getBaseUrl()

getBaseUrl() : string

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.

Returns

The raw url (i.e. not urldecoded)

getScheme()

getScheme() : string

Gets the request's scheme.

Returns

getPort()

getPort() : string

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.

Returns

getUser()

getUser() : string|null

Returns the user.

Returns

getPassword()

getPassword() : string|null

Returns the password.

Returns

getUserInfo()

getUserInfo() : string

Gets the user info.

Returns

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

getHttpHost()

getHttpHost() : string

Returns the HTTP host being requested.

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

Returns

getRequestUri()

getRequestUri() : string

Returns the requested URI.

Returns

The raw URI (i.e. not urldecoded)

getSchemeAndHttpHost()

getSchemeAndHttpHost() : string

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.

Returns

The scheme and HTTP host

getUri()

getUri() : string

Generates a normalized URI for the Request.

Returns

A normalized URI for the Request

getUriForPath()

getUriForPath(string  $path) : string

Generates a normalized URI for the given path.

Parameters

Returns

The normalized URI for the path

getQueryString()

getQueryString() : string|null

Generates the normalized query string for the Request.

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

Returns

A normalized query string for the Request

isSecure()

isSecure() : Boolean

Checks whether the request is secure or not.

This method can read the client port 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.

Returns

getHost()

getHost() : string

Returns the host name.

This method can read the client port 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.

Throws

UnexpectedValueException

when the host name is invalid

Returns

setMethod()

setMethod(string  $method) 

Sets the request method.

Parameters

getMethod()

getMethod() : string

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.

Returns

The request method

getRealMethod()

getRealMethod() : string

Gets the "real" request method.

Returns

The request method

getMimeType()

getMimeType(string  $format) : string

Gets the mime type associated with the format.

Parameters

Returns

The associated mime type (null if not found)

getFormat()

getFormat(string  $mimeType) : string|null

Gets the format associated with the mime type.

Parameters

Returns

The format (null if not found)

setFormat()

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

Associates a format with mime types.

Parameters

getRequestFormat()

getRequestFormat(string  $default = 'html') : string

Gets the request format.

Here is the process to determine the format:

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

Parameters

Returns

The request format

setRequestFormat()

setRequestFormat(string  $format) 

Sets the request format.

Parameters

getContentType()

getContentType() : string|null

Gets the format associated with the request.

Returns

The format (null if no content type is present)

setDefaultLocale()

setDefaultLocale(string  $locale) 

Sets the default locale.

Parameters

setLocale()

setLocale(string  $locale) 

Sets the locale.

Parameters

getLocale()

getLocale() : string

Get the locale.

Returns

isMethod()

isMethod(string  $method) : Boolean

Checks if the request method is of specified type.

Parameters

Returns

isMethodSafe()

isMethodSafe() : Boolean

Checks whether the method is safe or not.

Returns

getContent()

getContent(Boolean  $asResource = false) : string|resource

Returns the request body content.

Parameters

Throws

LogicException

Returns

The request body content or a resource to read the body stream.

getETags()

getETags() : array

Gets the Etags.

Returns

The entity tags

isNoCache()

isNoCache() : Boolean

Returns

getPreferredLanguage()

getPreferredLanguage(array  $locales = null) : string|null

Returns the preferred language.

Parameters

Returns

The preferred locale

getLanguages()

getLanguages() : array

Gets a list of languages acceptable by the client browser.

Returns

Languages ordered in the user browser preferences

getCharsets()

getCharsets() : array

Gets a list of charsets acceptable by the client browser.

Returns

List of charsets in preferable order

getAcceptableContentTypes()

getAcceptableContentTypes() : array

Gets a list of content types acceptable by the client browser

Returns

List of content types in preferable order

isXmlHttpRequest()

isXmlHttpRequest() : Boolean

Returns true if the request is a XMLHttpRequest.

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

Returns

true if the request is an XMLHttpRequest, false otherwise

splitHttpAcceptHeader()

splitHttpAcceptHeader(string  $header) : array

Splits an Accept-* HTTP header.

Parameters

Returns

Array indexed by the values of the Accept-* header in preferred order

prepareRequestUri()

prepareRequestUri() 

prepareBaseUrl()

prepareBaseUrl() : string

Prepares the base URL.

Returns

prepareBasePath()

prepareBasePath() : string

Prepares the base path.

Returns

base path

preparePathInfo()

preparePathInfo() : string

Prepares the path info.

Returns

path info

initializeFormats()

initializeFormats() 

Initializes HTTP request formats.

setPhpDefaultLocale()

setPhpDefaultLocale(string  $locale) 

Sets the default PHP locale.

Parameters

getUrlencodedPrefix()

getUrlencodedPrefix(  $string,   $prefix) 

Parameters