Class Illuminate\Http\Request

`extends`	`Request`
`implements`	`Arrayable, ArrayAccess`
`uses`	`CanBePrecognitive, InteractsWithContentTypes, InteractsWithFlashData, InteractsWithInput, Conditionable, Macroable`

Symfony\Component\HttpFoundation\Request
- Illuminate\Http\Request implements Arrayable, ArrayAccess uses CanBePrecognitive, InteractsWithContentTypes, InteractsWithFlashData, InteractsWithInput, Conditionable, Macroable

Methods


					
	public
					static

capture(): static

Create a new Illuminate HTTP request from server variables.


					
	public

instance(): $this

Return the Request instance.


					
	public

method(): string

Get the request method.


					
	public

uri(): Uri

Get a URI instance for the request.


					
	public

root(): string

Get the root URL for the application.


					
	public

url(): string

Get the URL (no query string) for the request.


					
	public

fullUrl(): string

Get the full URL for the request.


					
	public

fullUrlWithQuery(array $query): string

Get the full URL for the request with the added query string parameters.


					
	public

fullUrlWithoutQuery(array|string $keys): string

Get the full URL for the request without the given query string parameters.


					
	public

path(): string

Get the current path info for the request.


					
	public

decodedPath(): string

Get the current decoded path info for the request.


					
	public

segment(int $index, string|null $default = null): string|null

Get a segment from the URI (1 based index).


					
	public

segments(): array

Get all of the segments for the request path.


					
	public

is(mixed ...$patterns): bool

Determine if the current request URI matches a pattern.


					
	public

routeIs(mixed ...$patterns): bool

Determine if the route name matches a given pattern.


					
	public

fullUrlIs(mixed ...$patterns): bool

Determine if the current request URL and query string match a pattern.


					
	public

host(): string

Get the host name.


					
	public

httpHost(): string

Get the HTTP host being requested.


					
	public

schemeAndHttpHost(): string

Get the scheme and HTTP host.


					
	public

ajax(): bool

Determine if the request is the result of an AJAX call.


					
	public

pjax(): bool

Determine if the request is the result of a PJAX call.


					
	public

prefetch(): bool

Determine if the request is the result of a prefetch call.


					
	public

secure(): bool

Determine if the request is over HTTPS.


					
	public

ip(): string|null

Get the client IP address.


					
	public

ips(): array

Get the client IP addresses.


					
	public

userAgent(): string|null

Get the client user agent.


					
	public

merge(array $input): $this

Merge new input into the current request's input array.


					
	public

mergeIfMissing(array $input): $this

Merge new input into the request's input, but only when that key is missing from the request.


					
	public

replace(array $input): $this

Replace the input values for the current request.


					
	public

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

This method belongs to Symfony HttpFoundation and is not usually needed when using Laravel.

Instead, you may use the "input" method.


					
	public

json(string|null $key = null, mixed $default = null): InputBag|mixed

Get the JSON payload for the request.


					
	protected

getInputSource(): InputBag

Get the input source for the request.


					
	public
					static

createFrom(Request $from, Request|null $to = null): static

Create a new request instance from the given Laravel request.


					
	public
					static

createFromBase(Request $request): static

Create an Illuminate request from a Symfony instance.


					
	public

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

{@inheritdoc}

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

Overrides

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


					
	protected

filterFiles(mixed $files): mixed

Filter the given array of files, removing any empty values.


					
	public

hasSession(bool $skipIfUninitialized = false): bool

{@inheritdoc}

Parameters

$skipIfUninitialized

When true, ignores factories injected by setSessionFactory

Overrides

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


					
	public

getSession(): SessionInterface

{@inheritdoc}

Overrides

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


					
	public

session(): Session

Get the session associated with the request.

Throws

RuntimeException


					
	public

setLaravelSession(Session $session): void

Set the session instance on the request.


					
	public

setRequestLocale(string $locale): void

Set the locale for the request instance.


					
	public

setDefaultRequestLocale(string $locale): void

Set the default locale for the request instance.


					
	public

user(string|null $guard = null): mixed

Get the user making the request.


					
	public

route(string|null $param = null, mixed $default = null): Route|object|string|null

Get the route handling the request.


					
	public

fingerprint(): string

Get a unique fingerprint for the request / route / IP address.

Throws

RuntimeException


					
	public

setJson(InputBag $json): $this

Set the JSON payload for the request.


					
	public

getUserResolver(): Closure

Get the user resolver callback.


					
	public

setUserResolver(Closure $callback): $this

Set the user resolver callback.


					
	public

getRouteResolver(): Closure

Get the route resolver callback.


					
	public

setRouteResolver(Closure $callback): $this

Set the route resolver callback.


					
	public

toArray(): array

Get all of the input and files for the request.

Overrides

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

Implements

Illuminate\Contracts\Support\Arrayable::toArray()


					
	public

offsetExists(string $offset): bool

Determine if the given offset exists.

Implements

ArrayAccess::offsetExists()


					
	public

offsetGet(string $offset): mixed

Get the value at the given offset.

Implements

ArrayAccess::offsetGet()


					
	public

offsetSet(string $offset, mixed $value): void

Set the value at the given offset.

Implements

ArrayAccess::offsetSet()


					
	public

offsetUnset(string $offset): void

Remove the value at the given offset.

Implements

ArrayAccess::offsetUnset()


					
	public

__isset(string $key): bool

Check if an input element is set on the request.


					
	public

__get(string $key): mixed

Get an input element from the request.


					
	public

validate(array $rules, ...$params): array


					
	public

validateWithBag(string $errorBag, array $rules, ...$params): array


					
	public

hasValidSignature(bool $absolute = true): bool

Methods inherited from Symfony\Component\HttpFoundation\Request
__construct(), initialize(), createFromGlobals(), create(), setFactory(), __clone(), __toString(), overrideGlobals(), setTrustedProxies(), getTrustedProxies(), getTrustedHeaderSet(), setTrustedHosts(), getTrustedHosts(), normalizeQueryString(), enableHttpMethodParameterOverride(), getHttpMethodParameterOverride(), hasPreviousSession(), setSession(), getClientIps(), getClientIp(), getScriptName(), getPathInfo(), getBasePath(), getBaseUrl(), getScheme(), getPort(), getUser(), getPassword(), getUserInfo(), getHttpHost(), getRequestUri(), getSchemeAndHttpHost(), getUri(), getUriForPath(), getRelativeUriForPath(), getQueryString(), isSecure(), getHost(), setMethod(), getMethod(), getRealMethod(), getMimeType(), getMimeTypes(), getFormat(), setFormat(), getRequestFormat(), setRequestFormat(), getContentTypeFormat(), setDefaultLocale(), getDefaultLocale(), setLocale(), getLocale(), isMethod(), isMethodSafe(), isMethodIdempotent(), isMethodCacheable(), getProtocolVersion(), getContent(), getPayload(), getETags(), isNoCache(), getPreferredFormat(), getPreferredLanguage(), getLanguages(), getCharsets(), getEncodings(), getAcceptableContentTypes(), isXmlHttpRequest(), preferSafeContent(), prepareRequestUri(), prepareBaseUrl(), prepareBasePath(), preparePathInfo(), initializeFormats(), isFromTrustedProxy()

Methods inherited from Symfony\Component\HttpFoundation\Request

__construct(), initialize(), createFromGlobals(), create(), setFactory(), __clone(), __toString(), overrideGlobals(), setTrustedProxies(), getTrustedProxies(), getTrustedHeaderSet(), setTrustedHosts(), getTrustedHosts(), normalizeQueryString(), enableHttpMethodParameterOverride(), getHttpMethodParameterOverride(), hasPreviousSession(), setSession(), getClientIps(), getClientIp(), getScriptName(), getPathInfo(), getBasePath(), getBaseUrl(), getScheme(), getPort(), getUser(), getPassword(), getUserInfo(), getHttpHost(), getRequestUri(), getSchemeAndHttpHost(), getUri(), getUriForPath(), getRelativeUriForPath(), getQueryString(), isSecure(), getHost(), setMethod(), getMethod(), getRealMethod(), getMimeType(), getMimeTypes(), getFormat(), setFormat(), getRequestFormat(), setRequestFormat(), getContentTypeFormat(), setDefaultLocale(), getDefaultLocale(), setLocale(), getLocale(), isMethod(), isMethodSafe(), isMethodIdempotent(), isMethodCacheable(), getProtocolVersion(), getContent(), getPayload(), getETags(), isNoCache(), getPreferredFormat(), getPreferredLanguage(), getLanguages(), getCharsets(), getEncodings(), getAcceptableContentTypes(), isXmlHttpRequest(), preferSafeContent(), prepareRequestUri(), prepareBaseUrl(), prepareBasePath(), preparePathInfo(), initializeFormats(), isFromTrustedProxy()

Methods used from Illuminate\Http\Concerns\CanBePrecognitive
`filterPrecognitiveRules(), isAttemptingPrecognition(), isPrecognitive()`

Methods used from Illuminate\Http\Concerns\InteractsWithContentTypes
`isJson(), expectsJson(), wantsJson(), accepts(), prefers(), acceptsAnyContentType(), acceptsJson(), acceptsHtml(), matchesType(), format()`

Methods used from Illuminate\Http\Concerns\InteractsWithFlashData
`old(), flash(), flashOnly(), flashExcept(), flush()`

Methods used from Illuminate\Http\Concerns\InteractsWithInput
`server(), hasHeader(), header(), bearerToken(), keys(), all(), input(), fluent(), query(), post(), hasCookie(), cookie(), allFiles(), convertUploadedFiles(), hasFile(), isValidFile(), file(), data(), retrieveItem(), dump()`

Methods used from Illuminate\Support\Traits\Conditionable
`when(), unless()`

Methods used from Illuminate\Support\Traits\Macroable
`macro(), mixin(), hasMacro(), flushMacros(), __callStatic(), __call()`

Constants inherited from Symfony\Component\HttpFoundation\Request
`HEADER_FORWARDED, HEADER_X_FORWARDED_FOR, HEADER_X_FORWARDED_HOST, HEADER_X_FORWARDED_PROTO, HEADER_X_FORWARDED_PORT, HEADER_X_FORWARDED_PREFIX, HEADER_X_FORWARDED_AWS_ELB, HEADER_X_FORWARDED_TRAEFIK, METHOD_HEAD, METHOD_GET, METHOD_POST, METHOD_PUT, METHOD_PATCH, METHOD_DELETE, METHOD_PURGE, METHOD_OPTIONS, METHOD_TRACE, METHOD_CONNECT`

Properties
`protected`	`InputBag\|null`	`$json`	#
`protected`	`array`	`$convertedFiles`	#
`protected`	`Closure`	`$userResolver`	#
`protected`	`Closure`	`$routeResolver`	#

Properties inherited from Symfony\Component\HttpFoundation\Request
`$trustedProxies, $trustedHostPatterns, $trustedHosts, $httpMethodParameterOverride, $attributes, $request, $query, $server, $files, $cookies, $headers, $content, $languages, $charsets, $encodings, $acceptableContentTypes, $pathInfo, $requestUri, $baseUrl, $basePath, $method, $format, $session, $locale, $defaultLocale, $formats, $requestFactory`

Properties used from Illuminate\Support\Traits\Macroable
`$macros`

Namespaces

Classes

Traits

Class Illuminate\Http\Request

Parameters

Overrides

Parameters

Overrides

Overrides

Throws

Throws

Overrides

Implements

Implements

Implements

Implements

Implements