PHP Class Symfony\Component\HttpFoundation\Request

The methods dealing with URL accept / return a raw path (% encoded): * getBasePath * getBaseUrl * getPathInfo * getRequestUri * getUri * getUriForPath

Author: Fabien Potencier ([email protected])

Datei anzeigen Open project: symfony/symfony Class Usage Examples

Public Properties

Property	Type	Description
$attributes	Symfony\Component\HttpFoundation\ParameterBag	Custom parameters.
$cookies	Symfony\Component\HttpFoundation\ParameterBag	Cookies ($_COOKIE).
$files	FileBag	Uploaded files ($_FILES).
$headers	HeaderBag	Headers (taken from the $_SERVER).
$query	Symfony\Component\HttpFoundation\ParameterBag	Query string parameters ($_GET).
$request	Symfony\Component\HttpFoundation\ParameterBag	Request body parameters ($_POST).
$server	ServerBag	Server and execution environment parameters ($_SERVER).

Protected Properties

Property	Type	Description
$acceptableContentTypes	array
$basePath	string
$baseUrl	string
$charsets	array
$content	string
$defaultLocale	string
$encodings	array
$format	string
$formats	array
$httpMethodParameterOverride
$languages	array
$locale	string
$method	string
$pathInfo	string
$requestFactory
$requestUri	string
$session	Symfony\Component\HttpFoundation\Session\SessionInterface
$trustedHeaders		The FORWARDED header is the standard as of rfc7239. The other headers are non-standard, but widely used by popular reverse proxies (like Apache mod_proxy or Amazon EC2).
$trustedHostPatterns	string[]
$trustedHosts	string[]
$trustedProxies	string[]

Public Methods

Method	Description
__clone ( )	Clones the current request.
__construct ( array $query = [], array $request = [], array $attributes = [], array $cookies = [], array $files = [], array $server = [], string \| resource $content = null )	Constructor.
__toString ( ) : string	Returns the request as a string.
create ( string $uri, string $method = 'GET', array $parameters = [], array $cookies = [], array $files = [], array $server = [], string $content = null ) : Request	Creates a Request based on a given URI and configuration.
createFromGlobals ( ) : Request	Creates a new request with values from PHP's super globals.
duplicate ( array $query = null, array $request = null, array $attributes = null, array $cookies = null, array $files = null, array $server = null ) : Request	Clones a request and overrides some of its parameters.
enableHttpMethodParameterOverride ( )	Enables support for the _method request parameter to determine the intended HTTP method.
get ( string $key, mixed $default = null ) : mixed	Gets a "parameter" value from any bag.
getAcceptableContentTypes ( ) : array	Gets a list of content types acceptable by the client browser.
getBasePath ( ) : string	Returns the root path from which this request is executed.
getBaseUrl ( ) : string	Returns the root URL from which this request is executed.
getCharsets ( ) : array	Gets a list of charsets acceptable by the client browser.
getClientIp ( ) : string	Returns the client IP address.
getClientIps ( ) : array	Returns the client IP addresses.
getContent ( boolean $asResource = false ) : string \| resource	Returns the request body content.
getContentType ( ) : string \| null	Gets the format associated with the request.
getDefaultLocale ( ) : string	Get the default locale.
getETags ( ) : array	Gets the Etags.
getEncodings ( ) : array	Gets a list of encodings acceptable by the client browser.
getFormat ( string $mimeType ) : string \| null	Gets the format associated with the mime type.
getHost ( ) : string	Returns the host name.
getHttpHost ( ) : string	Returns the HTTP host being requested.
getHttpMethodParameterOverride ( ) : boolean	Checks whether support for the _method request parameter is enabled.
getLanguages ( ) : array	Gets a list of languages acceptable by the client browser.
getLocale ( ) : string	Get the locale.
getMethod ( ) : string	Gets the request "intended" method.
getMimeType ( string $format ) : string	Gets the mime type associated with the format.
getMimeTypes ( string $format ) : array	Gets the mime types associated with the format.
getPassword ( ) : string \| null	Returns the password.
getPathInfo ( ) : string	Returns the path being requested relative to the executed script.
getPort ( ) : string	Returns the port on which the request is made.
getPreferredLanguage ( array $locales = null ) : string \| null	Returns the preferred language.
getQueryString ( ) : string \| null	Generates the normalized query string for the Request.
getRealMethod ( ) : string	Gets the "real" request method.
getRelativeUriForPath ( string $path ) : string	Returns the path as relative reference from the current Request path.
getRequestFormat ( string $default = 'html' ) : string	Gets the request format.
getRequestUri ( ) : string	Returns the requested URI (path and query string).
getScheme ( ) : string	Gets the request's scheme.
getSchemeAndHttpHost ( ) : string	Gets the scheme and HTTP host.
getScriptName ( ) : string	Returns current script name.
getSession ( ) : Symfony\Component\HttpFoundation\Session\SessionInterface \| null	Gets the Session.
getTrustedHeaderName ( string $key ) : string	Gets the trusted proxy header name.
getTrustedHosts ( ) : array	Gets the list of trusted host patterns.
getTrustedProxies ( ) : array	Gets the list of trusted proxies.
getUri ( ) : string	Generates a normalized URI (URL) for the Request.
getUriForPath ( string $path ) : string	Generates a normalized URI for the given path.
getUser ( ) : string \| null	Returns the user.
getUserInfo ( ) : string	Gets the user info.
hasPreviousSession ( ) : boolean	Whether the request contains a Session which was started in one of the previous requests.
hasSession ( ) : boolean	Whether the request contains a Session object.
initialize ( array $query = [], array $request = [], array $attributes = [], array $cookies = [], array $files = [], array $server = [], string \| resource $content = null )	Sets the parameters for this request.
isFromTrustedProxy ( ) : boolean	Indicates whether this request originated from a trusted proxy.
isMethod ( string $method ) : boolean	Checks if the request method is of specified type.
isMethodCacheable ( ) : boolean	Checks whether the method is cacheable or not.
isMethodIdempotent ( ) : boolean	Checks whether or not the method is idempotent.
isMethodSafe ( ) : boolean	Checks whether or not the method is safe.
isNoCache ( ) : boolean
isSecure ( ) : boolean	Checks whether the request is secure or not.
isXmlHttpRequest ( ) : boolean	Returns true if the request is a XMLHttpRequest.
normalizeQueryString ( string $qs ) : string	Normalizes a query string.
overrideGlobals ( )	Overrides the PHP global variables according to this request instance.
setDefaultLocale ( string $locale )	Sets the default locale.
setFactory ( callable \| null $callable )	Sets a callable able to create a Request instance.
setFormat ( string $format, string \| array $mimeTypes )	Associates a format with mime types.
setLocale ( string $locale )	Sets the locale.
setMethod ( string $method )	Sets the request method.
setRequestFormat ( string $format )	Sets the request format.
setSession ( Symfony\Component\HttpFoundation\Session\SessionInterface $session )	Sets the Session.
setTrustedHeaderName ( string $key, string $value )	Sets the name for trusted headers.
setTrustedHosts ( array $hostPatterns )	Sets a list of trusted host patterns.
setTrustedProxies ( array $proxies )	Sets a list of trusted proxies.

Protected Methods

Method	Description
initializeFormats ( )	Initializes HTTP request formats.
prepareBasePath ( ) : string	Prepares the base path.
prepareBaseUrl ( ) : string	Prepares the base URL.
preparePathInfo ( ) : string	Prepares the path info.
prepareRequestUri ( )	* The following methods are derived from code of the Zend Framework (1.10dev - 2010-01-24)

Private Methods

Method	Description
createRequestFromFactory ( array $query = [], array $request = [], array $attributes = [], array $cookies = [], array $files = [], array $server = [], $content = null )
getUrlencodedPrefix ( $string, $prefix )	* Returns the prefix as encoded in the string when the string starts with the given prefix, false otherwise.
normalizeAndFilterClientIps ( array $clientIps, $ip )
setPhpDefaultLocale ( string $locale )	Sets the default PHP locale.

Method Details

__clone() public method

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

public __clone ( )

__construct() public method

Constructor.

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

__toString() public method

Returns the request as a string.

public __toString ( ) : string
return	string	The request

create() public static method

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

public static create ( string $uri, string $method = 'GET', array $parameters = [], array $cookies = [], array $files = [], array $server = [], string $content = null ) : Request
$uri	string	The URI
$method	string	The HTTP method
$parameters	array	The query (GET) or request (POST) parameters
$cookies	array	The request cookies ($_COOKIE)
$files	array	The request files ($_FILES)
$server	array	The server parameters ($_SERVER)
$content	string	The raw body data
return	Request	A Request instance

createFromGlobals() public static method

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

public static createFromGlobals ( ) : Request
return	Request	A new request

duplicate() public method

Clones a request and overrides some of its parameters.

public duplicate ( array $query = null, array $request = null, array $attributes = null, array $cookies = null, array $files = null, array $server = null ) : Request
$query	array	The GET parameters
$request	array	The POST parameters
$attributes	array	The request attributes (parameters parsed from the PATH_INFO, ...)
$cookies	array	The COOKIE parameters
$files	array	The FILES parameters
$server	array	The SERVER parameters
return	Request	The duplicated request

enableHttpMethodParameterOverride() public static 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.

public static enableHttpMethodParameterOverride ( )

get() public method

This method is mainly useful for libraries that want to provide some flexibility. If you don't need the flexibility in controllers, it is better to explicitly get request parameters from the appropriate public property instead (attributes, query, request). Order of precedence: PATH (routing placeholders or custom attributes), GET, BODY

public get ( string $key, mixed $default = null ) : mixed
$key	string	the key
$default	mixed	the default value if the parameter key does not exist
return	mixed

getAcceptableContentTypes() public method

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

public getAcceptableContentTypes ( ) : array
return	array	List of content types in preferable order

getBasePath() public method

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'

public getBasePath ( ) : string
return	string	The raw path (i.e. not urldecoded)

getBaseUrl() public method

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.

public getBaseUrl ( ) : string
return	string	The raw URL (i.e. not urldecoded)

getCharsets() public method

Gets a list of charsets acceptable by the client browser.

public getCharsets ( ) : array
return	array	List of charsets in preferable order

getClientIp() public method

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.

getClientIps() public method

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.

getContent() public method

Returns the request body content.

public getContent ( boolean $asResource = false ) : string \| resource
$asResource	boolean	If true, a resource will be returned
return	string \| resource	The request body content or a resource to read the body stream

getContentType() public method

Gets the format associated with the request.

public getContentType ( ) : string \| null
return	string \| null	The format (null if no content type is present)

getDefaultLocale() public method

Get the default locale.

public getDefaultLocale ( ) : string
return	string

getETags() public method

Gets the Etags.

public getETags ( ) : array
return	array	The entity tags

getEncodings() public method

Gets a list of encodings acceptable by the client browser.

public getEncodings ( ) : array
return	array	List of encodings in preferable order

getFormat() public method

Gets the format associated with the mime type.

public getFormat ( string $mimeType ) : string \| null
$mimeType	string	The associated mime type
return	string \| null	The format (null if not found)

getHost() public method

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.

public getHost ( ) : string
return	string

getHttpHost() public method

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

public getHttpHost ( ) : string
return	string

getHttpMethodParameterOverride() public static method

Checks whether support for the _method request parameter is enabled.

public static getHttpMethodParameterOverride ( ) : boolean
return	boolean	True when the _method request parameter is enabled, false otherwise

getLanguages() public method

Gets a list of languages acceptable by the client browser.

public getLanguages ( ) : array
return	array	Languages ordered in the user browser preferences

getLocale() public method

Get the locale.

public getLocale ( ) : string
return	string

getMethod() public 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.

getMimeType() public method

Gets the mime type associated with the format.

public getMimeType ( string $format ) : string
$format	string	The format
return	string	The associated mime type (null if not found)

getMimeTypes() public static method

Gets the mime types associated with the format.

public static getMimeTypes ( string $format ) : array
$format	string	The format
return	array	The associated mime types

getPassword() public method

Returns the password.

public getPassword ( ) : string \| null
return	string \| null

getPathInfo() public method

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'

public getPathInfo ( ) : string
return	string	The raw path (i.e. not urldecoded)

getPort() public method

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.

public getPort ( ) : string
return	string

getPreferredLanguage() public method

Returns the preferred language.

public getPreferredLanguage ( array $locales = null ) : string \| null
$locales	array	An array of ordered available locales
return	string \| null	The preferred locale

getQueryString() public method

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

public getQueryString ( ) : string \| null
return	string \| null	A normalized query string for the Request

getRealMethod() public method

Gets the "real" request method.

getRelativeUriForPath() public method

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"

public getRelativeUriForPath ( string $path ) : string
$path	string	The target path
return	string	The relative target path

getRequestFormat() public method

Here is the process to determine the format: * format defined by the user (with setRequestFormat()) * _format request attribute * $default

public getRequestFormat ( string $default = 'html' ) : string
$default	string	The default format
return	string	The request format

getRequestUri() public method

Returns the requested URI (path and query string).

public getRequestUri ( ) : string
return	string	The raw URI (i.e. not URI decoded)

getScheme() public method

Gets the request's scheme.

public getScheme ( ) : string
return	string

getSchemeAndHttpHost() public method

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

public getSchemeAndHttpHost ( ) : string
return	string	The scheme and HTTP host

getScriptName() public method

Returns current script name.

public getScriptName ( ) : string
return	string

getSession() public method

Gets the Session.

public getSession ( ) : Symfony\Component\HttpFoundation\Session\SessionInterface \| null
return	Symfony\Component\HttpFoundation\Session\SessionInterface \| null	The session

getTrustedHeaderName() public static method

Gets the trusted proxy header name.

public static getTrustedHeaderName ( string $key ) : string
$key	string	The header key
return	string	The header name

getTrustedHosts() public static method

Gets the list of trusted host patterns.

public static getTrustedHosts ( ) : array
return	array	An array of trusted host patterns

getTrustedProxies() public static method

Gets the list of trusted proxies.

public static getTrustedProxies ( ) : array
return	array	An array of trusted proxies

getUri() public method

Generates a normalized URI (URL) for the Request.

getUriForPath() public method

Generates a normalized URI for the given path.

public getUriForPath ( string $path ) : string
$path	string	A path to use instead of the current one
return	string	The normalized URI for the path

getUser() public method

Returns the user.

public getUser ( ) : string \| null
return	string \| null

getUserInfo() public method

Gets the user info.

public getUserInfo ( ) : string
return	string	A user name and, optionally, scheme-specific information about how to gain authorization to access the server

hasPreviousSession() public method

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

public hasPreviousSession ( ) : boolean
return	boolean

hasSession() public method

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.

public hasSession ( ) : boolean
return	boolean	true when the Request contains a Session object, false otherwise

initialize() public method

This method also re-initializes all properties.

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

initializeFormats() protected static method

Initializes HTTP request formats.

protected static initializeFormats ( )

isFromTrustedProxy() public method

This can be useful to determine whether or not to trust the contents of a proxy-specific header.

public isFromTrustedProxy ( ) : boolean
return	boolean	true if the request came from a trusted proxy, false otherwise

isMethod() public method

Checks if the request method is of specified type.

public isMethod ( string $method ) : boolean
$method	string	Uppercase request method (GET, POST etc)
return	boolean

isMethodCacheable() public method

Checks whether the method is cacheable or not.

See also: https://tools.ietf.org/html/rfc7231#section-4.2.3

public isMethodCacheable ( ) : boolean
return	boolean

isMethodIdempotent() public method

Checks whether or not the method is idempotent.

public isMethodIdempotent ( ) : boolean
return	boolean

isMethodSafe() public method

Checks whether or not the method is safe.

See also: https://tools.ietf.org/html/rfc7231#section-4.2.1

public isMethodSafe ( ) : boolean
return	boolean

isNoCache() public method

public isNoCache ( ) : boolean
return	boolean

isSecure() public method

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.

public isSecure ( ) : boolean
return	boolean

isXmlHttpRequest() public method

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

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

public isXmlHttpRequest ( ) : boolean
return	boolean	true if the request is an XMLHttpRequest, false otherwise

normalizeQueryString() public static method

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

public static normalizeQueryString ( string $qs ) : string
$qs	string	Query string
return	string	A normalized query string for the Request

overrideGlobals() public method

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

public overrideGlobals ( )

prepareBasePath() protected method

Prepares the base path.

protected prepareBasePath ( ) : string
return	string	base path

prepareBaseUrl() protected method

Prepares the base URL.

protected prepareBaseUrl ( ) : string
return	string

preparePathInfo() protected method

Prepares the path info.

protected preparePathInfo ( ) : string
return	string	path info

prepareRequestUri() protected method

protected prepareRequestUri ( )

setDefaultLocale() public method

Sets the default locale.

public setDefaultLocale ( string $locale )
$locale	string

setFactory() public static method

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.

public static setFactory ( callable \| null $callable )
$callable	callable \| null	A PHP callable

setFormat() public method

Associates a format with mime types.

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

setLocale() public method

Sets the locale.

public setLocale ( string $locale )
$locale	string

setMethod() public method

Sets the request method.

public setMethod ( string $method )
$method	string

setRequestFormat() public method

Sets the request format.

public setRequestFormat ( string $format )
$format	string	The request format

setSession() public method

Sets the Session.

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

setTrustedHeaderName() public static method

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()) Setting an empty value allows to disable the trusted header for the given key.

public static setTrustedHeaderName ( string $key, string $value )
$key	string	The header key
$value	string	The header name

setTrustedHosts() public static method

You should only list the hosts you manage using regexs.

public static setTrustedHosts ( array $hostPatterns )
$hostPatterns	array	A list of trusted host patterns

setTrustedProxies() public static method

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

public static setTrustedProxies ( array $proxies )
$proxies	array	A list of trusted proxies

Property Details

$acceptableContentTypes protected_oe property

protected array $acceptableContentTypes
return	array

$attributes public_oe property

Custom parameters.

public ParameterBag,Symfony\Component\HttpFoundation $attributes
return	Symfony\Component\HttpFoundation\ParameterBag

$basePath protected_oe property

protected string $basePath
return	string

$baseUrl protected_oe property

protected string $baseUrl
return	string

$charsets protected_oe property

protected array $charsets
return	array

$content protected_oe property

protected string $content
return	string

$cookies public_oe property

Cookies ($_COOKIE).

public ParameterBag,Symfony\Component\HttpFoundation $cookies
return	Symfony\Component\HttpFoundation\ParameterBag

$defaultLocale protected_oe property

protected string $defaultLocale
return	string

$encodings protected_oe property

protected array $encodings
return	array

$files public_oe property

Uploaded files ($_FILES).

public FileBag,Symfony\Component\HttpFoundation $files
return	FileBag

$format protected_oe property

protected string $format
return	string

$formats protected_oe static_oe property

protected static array $formats
return	array

$headers public_oe property

Headers (taken from the $_SERVER).

public HeaderBag,Symfony\Component\HttpFoundation $headers
return	HeaderBag

$httpMethodParameterOverride protected_oe static_oe property

protected static $httpMethodParameterOverride

$languages protected_oe property

protected array $languages
return	array

$locale protected_oe property

protected string $locale
return	string

$method protected_oe property

protected string $method
return	string

$pathInfo protected_oe property

protected string $pathInfo
return	string

$query public_oe property

Query string parameters ($_GET).

public ParameterBag,Symfony\Component\HttpFoundation $query
return	Symfony\Component\HttpFoundation\ParameterBag

$request public_oe property

Request body parameters ($_POST).

public ParameterBag,Symfony\Component\HttpFoundation $request
return	Symfony\Component\HttpFoundation\ParameterBag

$requestFactory protected_oe static_oe property

protected static $requestFactory

$requestUri protected_oe property

protected string $requestUri
return	string

$server public_oe property

Server and execution environment parameters ($_SERVER).

public ServerBag,Symfony\Component\HttpFoundation $server
return	ServerBag

$session protected_oe property

protected SessionInterface,Symfony\Component\HttpFoundation\Session $session
return	Symfony\Component\HttpFoundation\Session\SessionInterface

$trustedHeaders protected_oe static_oe property

The FORWARDED header is the standard as of rfc7239. The other headers are non-standard, but widely used by popular reverse proxies (like Apache mod_proxy or Amazon EC2).

protected static $trustedHeaders

$trustedHostPatterns protected_oe static_oe property

protected static string[] $trustedHostPatterns
return	string[]

$trustedHosts protected_oe static_oe property

protected static string[] $trustedHosts
return	string[]

$trustedProxies protected_oe static_oe property

protected static string[] $trustedProxies
return	string[]

public getClientIp ( ) : string
return	string	The client IP address

public getClientIps ( ) : array
return	array	The client IP addresses

public getRealMethod ( ) : string
return	string	The request method

public getUri ( ) : string
return	string	A normalized URI (URL) for the Request