Class Symfony\Component\HttpFoundation\Request


					
	public

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

Parameters

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

#


					
	public

initialize(
	array $query = [],
	array $request = [],
	array $attributes = [],
	array $cookies = [],
	array $files = [],
	array $server = [],
	string|resource|null $content = null,
): void

Sets the parameters for this request.

This method also re-initializes all properties.

Parameters

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

#


					
	public
					static

createFromGlobals(): static

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

#


					
	public
					static

create(
	string $uri,
	string $method = 'GET',
	array $parameters = [],
	array $cookies = [],
	array $files = [],
	array $server = [],
	string|resource|null $content = null,
): static

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

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

Throws

Symfony\Component\HttpFoundation\Exception\BadRequestException

When the URI is invalid

#


					
	public
					static

setFactory(?callable $callable): void

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.

#


					
	public

duplicate(
	array|null $query = null,
	array|null $request = null,
	array|null $attributes = null,
	array|null $cookies = null,
	array|null $files = null,
	array|null $server = null,
): static

Clones a request and overrides some of its parameters.

Parameters

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

Overriden by

Illuminate\Http\Request::duplicate()

#


					
	public

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

#


					
	public

__toString(): string

#


					
	public

overrideGlobals(): void

Overrides the PHP global variables according to this request instance.

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

#


					
	public
					static

setTrustedProxies(array $proxies, int-mask-of<Request::HEADER_*> $trustedHeaderSet): void

Sets a list of trusted proxies.

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

Parameters

`$proxies`	A list of trusted proxies, the string 'REMOTE_ADDR' will be replaced with $_SERVER['REMOTE_ADDR'] and 'PRIVATE_SUBNETS' by IpUtils::PRIVATE_SUBNETS
`$trustedHeaderSet`	A bit field to set which headers to trust from your proxies

#


					
	public
					static

getTrustedProxies(): string[]

Gets the list of trusted proxies.

#


					
	public
					static

getTrustedHeaderSet(): int

Gets the set of trusted headers from trusted proxies.

Returns

A bit field of Request::HEADER_* that defines which headers are trusted from your proxies

#


					
	public
					static

setTrustedHosts(array $hostPatterns): void

Sets a list of trusted host patterns.

You should only list the hosts you manage using regexs.

Parameters

$hostPatterns

A list of trusted host patterns

#


					
	public
					static

getTrustedHosts(): string[]

Gets the list of trusted host patterns.

#


					
	public
					static

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.

#


					
	public
					static

enableHttpMethodParameterOverride(): void

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.

#


					
	public
					static

getHttpMethodParameterOverride(): bool

Checks whether support for the _method request parameter is enabled.

#


					
	public

getSession(): SessionInterface

Gets the Session.

Throws

Symfony\Component\HttpFoundation\Exception\SessionNotFoundException

When session is not set properly

Overriden by

Illuminate\Http\Request::getSession()

#


					
	public

hasPreviousSession(): bool

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

#


					
	public

hasSession(bool $skipIfUninitialized = false): bool

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.

Parameters

$skipIfUninitialized

When true, ignores factories injected by setSessionFactory

Overriden by

Illuminate\Http\Request::hasSession()

#


					
	public

setSession(SessionInterface $session): void

#


					
	public

getClientIps(): array

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.

#


					
	public

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 the $trustedHeaderSet argument of the Request::setTrustedProxies() method instead.

#


					
	public

getScriptName(): string

Returns current script name.

#


					
	public

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

Returns

The raw path (i.e. not urldecoded)

#


					
	public

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

Returns

The raw path (i.e. not urldecoded)

#


					
	public

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)

#


					
	public

getScheme(): string

Gets the request's scheme.

#


					
	public

getPort(): int|string|null

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.

Returns

Can be a string if fetched from the server bag

#


					
	public

getUser(): ?string

Returns the user.

#


					
	public

getPassword(): ?string

Returns the password.

#


					
	public

getUserInfo(): string|null

Gets the user info.

Returns

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

#


					
	public

getHttpHost(): string

Returns the HTTP host being requested.

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

#


					
	public

getRequestUri(): string

Returns the requested URI (path and query string).

Returns

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

#


					
	public

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.

#


					
	public

getUri(): string

Generates a normalized URI (URL) for the Request.

#


					
	public

getUriForPath(string $path): string

Generates a normalized URI for the given path.

Parameters

$path

A path to use instead of the current one

#


					
	public

getRelativeUriForPath(string $path): string

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"

#


					
	public

getQueryString(): ?string

Generates the normalized query string for the Request.

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

#


					
	public

isSecure(): bool

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

#


					
	public

getHost(): string

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.

Throws

Symfony\Component\HttpFoundation\Exception\SuspiciousOperationException

when the host name is invalid or not trusted

#


					
	public

setMethod(string $method): void

Sets the request method.

#


					
	public

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.

#


					
	public

getRealMethod(): string

Gets the "real" request method.

#


					
	public

getMimeType(string $format): ?string

Gets the mime type associated with the format.

#


					
	public
					static

getMimeTypes(string $format): string[]

Gets the mime types associated with the format.

#


					
	public

getFormat(?string $mimeType): ?string

Gets the format associated with the mime type.

#


					
	public

setFormat(?string $format, string|string[] $mimeTypes): void

Associates a format with mime types.

Parameters

$mimeTypes

The associated mime types (the preferred one must be the first as it will be used as the content type)

#


					
	public

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 attribute
$default

#


					
	public

setRequestFormat(?string $format): void

Sets the request format.

#


					
	public

getContentTypeFormat(): ?string

Gets the usual name of the format associated with the request's media type (provided in the Content-Type header).

#


					
	public

setDefaultLocale(string $locale): void

Sets the default locale.

#


					
	public

getDefaultLocale(): string

Get the default locale.

#


					
	public

setLocale(string $locale): void

Sets the locale.

#


					
	public

getLocale(): string

Get the locale.

#


					
	public

isMethod(string $method): bool

Checks if the request method is of specified type.

Parameters

$method

Uppercase request method (GET, POST etc)

#


					
	public

isMethodSafe(): bool

Checks whether or not the method is safe.

#


					
	public

isMethodIdempotent(): bool

Checks whether or not the method is idempotent.

#


					
	public

isMethodCacheable(): bool

Checks whether the method is cacheable or not.

#


					
	public

getProtocolVersion(): ?string

Returns the protocol version.

If the application is behind a proxy, the protocol version used in the requests between the client and the proxy and between the proxy and the server might be different. This returns the former (from the "Via" header) if the proxy is trusted (see "setTrustedProxies()"), otherwise it returns the latter (from the "SERVER_PROTOCOL" server parameter).

#


					
	public

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

Returns the request body content.

Parameters

$asResource

If true, a resource will be returned

#


					
	public

getPayload(): InputBag

Gets the decoded form or json request body.

Throws

Symfony\Component\HttpFoundation\Exception\JsonException

When the body cannot be decoded to an array

#


					
	public

toArray(): array

Gets the request body decoded as array, typically from a JSON payload.

Throws

Symfony\Component\HttpFoundation\Exception\JsonException

When the body cannot be decoded to an array

Overriden by

Illuminate\Http\Request::toArray()

#


					
	public

getETags(): array

Gets the Etags.

#


					
	public

isNoCache(): bool

#


					
	public

getPreferredFormat(?string $default = 'html'): ?string

Gets the preferred format for the response by inspecting, in the following order: * the request format set using…

Gets the preferred format for the response by inspecting, in the following order:

the request format set using setRequestFormat;
the values of the Accept HTTP header.

Note that if you use this method, you should send the "Vary: Accept" header in the response to prevent any issues with intermediary HTTP caches.

#


					
	public

getPreferredLanguage(string[] $locales = null): ?string

Returns the preferred language.

Parameters

$locales

An array of ordered available locales

#


					
	public

getLanguages(): string[]

Gets a list of languages acceptable by the client browser ordered in the user browser preferences.

#


					
	public

getCharsets(): string[]

Gets a list of charsets acceptable by the client browser in preferable order.

#


					
	public

getEncodings(): string[]

Gets a list of encodings acceptable by the client browser in preferable order.

#


					
	public

getAcceptableContentTypes(): string[]

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

#


					
	public

isXmlHttpRequest(): bool

Returns true if the request is an XMLHttpRequest.

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

#


					
	public

preferSafeContent(): bool

Checks whether the client browser prefers safe content or not according to RFC8674.

#


					
	protected

prepareRequestUri(): string

#


					
	protected

prepareBaseUrl(): string

Prepares the base URL.

#


					
	protected

prepareBasePath(): string

Prepares the base path.

#


					
	protected

preparePathInfo(): string

Prepares the path info.

#


					
	protected
					static

initializeFormats(): void

Initializes HTTP request formats.

#


					
	public

isFromTrustedProxy(): bool

Indicates whether this request originated from a trusted proxy.

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

#

Constants
`public`	`HEADER_FORWARDED = 0b000001`	#
`public`	`HEADER_X_FORWARDED_FOR = 0b000010`	#
`public`	`HEADER_X_FORWARDED_HOST = 0b000100`	#
`public`	`HEADER_X_FORWARDED_PROTO = 0b001000`	#
`public`	`HEADER_X_FORWARDED_PORT = 0b010000`	#
`public`	`HEADER_X_FORWARDED_PREFIX = 0b100000`	#
`public`	`HEADER_X_FORWARDED_AWS_ELB = 0b0011010`	#
`public`	`HEADER_X_FORWARDED_TRAEFIK = 0b0111110`	#
`public`	`METHOD_HEAD = 'HEAD'`	#
`public`	`METHOD_GET = 'GET'`	#
`public`	`METHOD_POST = 'POST'`	#
`public`	`METHOD_PUT = 'PUT'`	#
`public`	`METHOD_PATCH = 'PATCH'`	#
`public`	`METHOD_DELETE = 'DELETE'`	#
`public`	`METHOD_PURGE = 'PURGE'`	#
`public`	`METHOD_OPTIONS = 'OPTIONS'`	#
`public`	`METHOD_TRACE = 'TRACE'`	#
`public`	`METHOD_CONNECT = 'CONNECT'`	#

Properties
`protected static`	`string[]`	`$trustedProxies = []`	#
`protected static`	`string[]`	`$trustedHostPatterns = []`	#
`protected static`	`string[]`	`$trustedHosts = []`	#
`protected static`	`bool`	`$httpMethodParameterOverride = false`	#
`public`	`ParameterBag`	`$attributes` Custom parameters. Custom parameters.	#
`public`	`InputBag`	`$request` Request body parameters ($_POST). Request body parameters ($_POST).	#
`public`	`InputBag`	`$query` Query string parameters ($_GET). Query string parameters ($_GET).	#
`public`	`ServerBag`	`$server` Server and execution environment parameters ($_SERVER). Server and execution environment parameters ($_SERVER).	#
`public`	`FileBag`	`$files` Uploaded files ($_FILES). Uploaded files ($_FILES).	#
`public`	`InputBag`	`$cookies` Cookies ($_COOKIE). Cookies ($_COOKIE).	#
`public`	`HeaderBag`	`$headers` Headers (taken from the $_SERVER). Headers (taken from the $_SERVER).	#
`protected`	`string\|resource\|false\|null`	`$content`	#
`protected`	`string[]\|null`	`$languages = null`	#
`protected`	`string[]\|null`	`$charsets = null`	#
`protected`	`string[]\|null`	`$encodings = null`	#
`protected`	`string[]\|null`	`$acceptableContentTypes = null`	#
`protected`	`?string`	`$pathInfo = null`	#
`protected`	`?string`	`$requestUri = null`	#
`protected`	`?string`	`$baseUrl = null`	#
`protected`	`?string`	`$basePath = null`	#
`protected`	`?string`	`$method = null`	#
`protected`	`?string`	`$format = null`	#
`protected`	`SessionInterface\|Closure\|null`	`$session = null`	#
`protected`	`?string`	`$locale = null`	#
`protected`	`string`	`$defaultLocale = 'en'`	#
`protected static`	`array<string, string[]>\|null`	`$formats = null`	#
`protected static`	`?Closure`	`$requestFactory = null`	#

Namespaces

Classes

Class Symfony\Component\HttpFoundation\Request

Parameters

Parameters

Parameters

Throws

Parameters

Overriden by

Parameters

Returns

Parameters

Throws

Overriden by

Parameters

Overriden by

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Throws

Parameters

Parameters

Parameters

Throws

Throws

Overriden by

Parameters