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

Afficher le fichier Open project: symfony/symfony Class Usage Examples

Méthodes publiques

Свойство	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

Свойство	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[]

Méthodes publiques

Méthode	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.

Méthodes protégées

Méthode	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

Méthode	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 méthode

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 méthode

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 méthode

Returns the request as a string.

public __toString ( ) : string
Résultat	string	The request

create() public static méthode

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
Résultat	Request	A Request instance

createFromGlobals() public static méthode

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

public static createFromGlobals ( ) : Request
Résultat	Request	A new request

duplicate() public méthode

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
Résultat	Request	The duplicated request

enableHttpMethodParameterOverride() public static méthode

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 méthode

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
Résultat	mixed

getAcceptableContentTypes() public méthode

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

public getAcceptableContentTypes ( ) : array
Résultat	array	List of content types in preferable order

getBasePath() public méthode

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
Résultat	string	The raw path (i.e. not urldecoded)

getBaseUrl() public méthode

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
Résultat	string	The raw URL (i.e. not urldecoded)

getCharsets() public méthode

Gets a list of charsets acceptable by the client browser.

public getCharsets ( ) : array
Résultat	array	List of charsets in preferable order

getClientIp() public méthode

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 méthode

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 méthode

Returns the request body content.

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

getContentType() public méthode

Gets the format associated with the request.

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

getDefaultLocale() public méthode

Get the default locale.

public getDefaultLocale ( ) : string
Résultat	string

getETags() public méthode

Gets the Etags.

public getETags ( ) : array
Résultat	array	The entity tags

getEncodings() public méthode

Gets a list of encodings acceptable by the client browser.

public getEncodings ( ) : array
Résultat	array	List of encodings in preferable order

getFormat() public méthode

Gets the format associated with the mime type.

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

getHost() public méthode

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
Résultat	string

getHttpHost() public méthode

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

public getHttpHost ( ) : string
Résultat	string

getHttpMethodParameterOverride() public static méthode

Checks whether support for the _method request parameter is enabled.

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

getLanguages() public méthode

Gets a list of languages acceptable by the client browser.

public getLanguages ( ) : array
Résultat	array	Languages ordered in the user browser preferences

getLocale() public méthode

Get the locale.

public getLocale ( ) : string
Résultat	string

getMethod() public méthode

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 méthode

Gets the mime type associated with the format.

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

getMimeTypes() public static méthode

Gets the mime types associated with the format.

public static getMimeTypes ( string $format ) : array
$format	string	The format
Résultat	array	The associated mime types

getPassword() public méthode

Returns the password.

public getPassword ( ) : string \| null
Résultat	string \| null

getPathInfo() public méthode

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
Résultat	string	The raw path (i.e. not urldecoded)

getPort() public méthode

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
Résultat	string

getPreferredLanguage() public méthode

Returns the preferred language.

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

getQueryString() public méthode

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

public getQueryString ( ) : string \| null
Résultat	string \| null	A normalized query string for the Request

getRealMethod() public méthode

Gets the "real" request method.

getRelativeUriForPath() public méthode

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
Résultat	string	The relative target path

getRequestFormat() public méthode

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
Résultat	string	The request format

getRequestUri() public méthode

Returns the requested URI (path and query string).

public getRequestUri ( ) : string
Résultat	string	The raw URI (i.e. not URI decoded)

getScheme() public méthode

Gets the request's scheme.

public getScheme ( ) : string
Résultat	string

getSchemeAndHttpHost() public méthode

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

public getSchemeAndHttpHost ( ) : string
Résultat	string	The scheme and HTTP host

getScriptName() public méthode

Returns current script name.

public getScriptName ( ) : string
Résultat	string

getSession() public méthode

Gets the Session.

public getSession ( ) : Symfony\Component\HttpFoundation\Session\SessionInterface \| null
Résultat	Symfony\Component\HttpFoundation\Session\SessionInterface \| null	The session

getTrustedHeaderName() public static méthode

Gets the trusted proxy header name.

public static getTrustedHeaderName ( string $key ) : string
$key	string	The header key
Résultat	string	The header name

getTrustedHosts() public static méthode

Gets the list of trusted host patterns.

public static getTrustedHosts ( ) : array
Résultat	array	An array of trusted host patterns

getTrustedProxies() public static méthode

Gets the list of trusted proxies.

public static getTrustedProxies ( ) : array
Résultat	array	An array of trusted proxies

getUri() public méthode

Generates a normalized URI (URL) for the Request.

getUriForPath() public méthode

Generates a normalized URI for the given path.

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

getUser() public méthode

Returns the user.

public getUser ( ) : string \| null
Résultat	string \| null

getUserInfo() public méthode

Gets the user info.

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

hasPreviousSession() public méthode

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

public hasPreviousSession ( ) : boolean
Résultat	boolean

hasSession() public méthode

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
Résultat	boolean	true when the Request contains a Session object, false otherwise

initialize() public méthode

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 méthode

Initializes HTTP request formats.

protected static initializeFormats ( )

isFromTrustedProxy() public méthode

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

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

isMethod() public méthode

Checks if the request method is of specified type.

public isMethod ( string $method ) : boolean
$method	string	Uppercase request method (GET, POST etc)
Résultat	boolean

isMethodCacheable() public méthode

Checks whether the method is cacheable or not.

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

public isMethodCacheable ( ) : boolean
Résultat	boolean

isMethodIdempotent() public méthode

Checks whether or not the method is idempotent.

public isMethodIdempotent ( ) : boolean
Résultat	boolean

isMethodSafe() public méthode

Checks whether or not the method is safe.

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

public isMethodSafe ( ) : boolean
Résultat	boolean

isNoCache() public méthode

public isNoCache ( ) : boolean
Résultat	boolean

isSecure() public méthode

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
Résultat	boolean

isXmlHttpRequest() public méthode

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
Résultat	boolean	true if the request is an XMLHttpRequest, false otherwise

normalizeQueryString() public static méthode

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
Résultat	string	A normalized query string for the Request

overrideGlobals() public méthode

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

public overrideGlobals ( )

prepareBasePath() protected méthode

Prepares the base path.

protected prepareBasePath ( ) : string
Résultat	string	base path

prepareBaseUrl() protected méthode

Prepares the base URL.

protected prepareBaseUrl ( ) : string
Résultat	string

preparePathInfo() protected méthode

Prepares the path info.

protected preparePathInfo ( ) : string
Résultat	string	path info

prepareRequestUri() protected méthode

protected prepareRequestUri ( )

setDefaultLocale() public méthode

Sets the default locale.

public setDefaultLocale ( string $locale )
$locale	string

setFactory() public static méthode

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 méthode

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 méthode

Sets the locale.

public setLocale ( string $locale )
$locale	string

setMethod() public méthode

Sets the request method.

public setMethod ( string $method )
$method	string

setRequestFormat() public méthode

Sets the request format.

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

setSession() public méthode

Sets the Session.

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

setTrustedHeaderName() public static méthode

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 méthode

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 méthode

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
Résultat	array

$attributes public_oe property

Custom parameters.

public ParameterBag,Symfony\Component\HttpFoundation $attributes
Résultat	Symfony\Component\HttpFoundation\ParameterBag

$basePath protected_oe property

protected string $basePath
Résultat	string

$baseUrl protected_oe property

protected string $baseUrl
Résultat	string

$charsets protected_oe property

protected array $charsets
Résultat	array

$content protected_oe property

protected string $content
Résultat	string

$cookies public_oe property

Cookies ($_COOKIE).

public ParameterBag,Symfony\Component\HttpFoundation $cookies
Résultat	Symfony\Component\HttpFoundation\ParameterBag

$defaultLocale protected_oe property

protected string $defaultLocale
Résultat	string

$encodings protected_oe property

protected array $encodings
Résultat	array

$files public_oe property

Uploaded files ($_FILES).

public FileBag,Symfony\Component\HttpFoundation $files
Résultat	FileBag

$format protected_oe property

protected string $format
Résultat	string

$formats protected_oe static_oe property

protected static array $formats
Résultat	array

$headers public_oe property

Headers (taken from the $_SERVER).

public HeaderBag,Symfony\Component\HttpFoundation $headers
Résultat	HeaderBag

$httpMethodParameterOverride protected_oe static_oe property

protected static $httpMethodParameterOverride

$languages protected_oe property

protected array $languages
Résultat	array

$locale protected_oe property

protected string $locale
Résultat	string

$method protected_oe property

protected string $method
Résultat	string

$pathInfo protected_oe property

protected string $pathInfo
Résultat	string

$query public_oe property

Query string parameters ($_GET).

public ParameterBag,Symfony\Component\HttpFoundation $query
Résultat	Symfony\Component\HttpFoundation\ParameterBag

$request public_oe property

Request body parameters ($_POST).

public ParameterBag,Symfony\Component\HttpFoundation $request
Résultat	Symfony\Component\HttpFoundation\ParameterBag

$requestFactory protected_oe static_oe property

protected static $requestFactory

$requestUri protected_oe property

protected string $requestUri
Résultat	string

$server public_oe property

Server and execution environment parameters ($_SERVER).

public ServerBag,Symfony\Component\HttpFoundation $server
Résultat	ServerBag

$session protected_oe property

protected SessionInterface,Symfony\Component\HttpFoundation\Session $session
Résultat	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
Résultat	string[]

$trustedHosts protected_oe static_oe property

protected static string[] $trustedHosts
Résultat	string[]

$trustedProxies protected_oe static_oe property

protected static string[] $trustedProxies
Résultat	string[]

public getClientIp ( ) : string
Résultat	string	The client IP address

public getClientIps ( ) : array
Résultat	array	The client IP addresses

public getMethod ( ) : string
Résultat	string	The request method

public getRealMethod ( ) : string
Résultat	string	The request method

public getUri ( ) : string
Résultat	string	A normalized URI (URL) for the Request