class Request extends Request implements Arrayable, ArrayAccess (View source)

Traits

Properties

static protected array $macros

The registered string macros.

from  Macroable
protected InputBag|null $json

The decoded JSON content for the request.

protected array $convertedFiles

All of the converted files for the request.

protected Closure $userResolver

The user resolver callback.

protected Closure $routeResolver

The route resolver callback.

Methods

array
filterPrecognitiveRules(array $rules)

Filter the given array of rules into an array of rules that are included in precognitive headers.

bool
isAttemptingPrecognition()

Determine if the request is attempting to be precognitive.

bool
isPrecognitive()

Determine if the request is precognitive.

bool
isJson()

Determine if the request is sending JSON.

bool
expectsJson()

Determine if the current request probably expects a JSON response.

bool
wantsJson()

Determine if the current request is asking for JSON.

bool
accepts(string|array $contentTypes)

Determines whether the current requests accepts a given content type.

string|null
prefers(string|array $contentTypes)

Return the most suitable content type from the given array based on content negotiation.

bool
acceptsAnyContentType()

Determine if the current request accepts any content type.

bool
acceptsJson()

Determines whether a request accepts JSON.

bool
acceptsHtml()

Determines whether a request accepts HTML.

static bool
matchesType(string $actual, string $type)

Determine if the given content types match.

string
format(string $default = 'html')

Get the data format expected in the response.

string|array|null
old(string|null $key = null, Model|string|array|null $default = null)

Retrieve an old input item.

void
flash()

Flash the input for the current request to the session.

void
flashOnly(array|mixed $keys)

Flash only some of the input to the session.

void
flashExcept(array|mixed $keys)

Flash only some of the input to the session.

void
flush()

Flush all of the old input from the session.

never
dd(mixed ...$args)

Dump the given arguments and terminate execution.

from  Dumpable
$this
dump(mixed ...$args)

Dump the given arguments.

from  Dumpable
string|array|null
server(string|null $key = null, string|array|null $default = null)

Retrieve a server variable from the request.

bool
hasHeader(string $key)

Determine if a header is set on the request.

string|array|null
header(string|null $key = null, string|array|null $default = null)

Retrieve a header from the request.

string|null
bearerToken()

Get the bearer token from the request headers.

bool
exists(string|array $key)

Determine if the request contains a given input item key.

bool
has(string|array $key)

Determine if the request contains a given input item key.

bool
hasAny(string|array $keys)

Determine if the request contains any of the given inputs.

$this|mixed
whenHas(string $key, callable $callback, callable|null $default = null)

Apply the callback if the request contains the given input item key.

bool
filled(string|array $key)

Determine if the request contains a non-empty value for an input item.

bool
isNotFilled(string|array $key)

Determine if the request contains an empty value for an input item.

bool
anyFilled(string|array $keys)

Determine if the request contains a non-empty value for any of the given inputs.

$this|mixed
whenFilled(string $key, callable $callback, callable|null $default = null)

Apply the callback if the request contains a non-empty value for the given input item key.

bool
missing(string|array $key)

Determine if the request is missing a given input item key.

$this|mixed
whenMissing(string $key, callable $callback, callable|null $default = null)

Apply the callback if the request is missing the given input item key.

bool
isEmptyString(string $key)

Determine if the given input key is an empty string for "filled".

array
keys()

Get the keys for all of the input and files.

array
all(array|mixed|null $keys = null)

Get all of the input and files for the request.

mixed
input(string|null $key = null, mixed $default = null)

Retrieve an input item from the request.

str(string $key, mixed $default = null)

Retrieve input from the request as a Stringable instance.

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

Retrieve input from the request as a Stringable instance.

bool
boolean(string|null $key = null, bool $default = false)

Retrieve input as a boolean value.

int
integer(string $key, int $default = 0)

Retrieve input as an integer value.

float
float(string $key, float $default = 0.0)

Retrieve input as a float value.

Carbon|null
date(string $key, string|null $format = null, string|null $tz = null)

Retrieve input from the request as a Carbon instance.

TEnum|null
enum(string $key, TEnum> $enumClass)

Retrieve input from the request as an enum.

collect(array|string|null $key = null)

Retrieve input from the request as a collection.

array
only(array|mixed $keys)

Get a subset containing the provided keys with values from the input data.

array
except(array|mixed $keys)

Get all of the input except for a specified array of items.

string|array|null
query(string|null $key = null, string|array|null $default = null)

Retrieve a query string item from the request.

string|array|null
post(string|null $key = null, string|array|null $default = null)

Retrieve a request payload item from the request.

bool
hasCookie(string $key)

Determine if a cookie is set on the request.

string|array|null
cookie(string|null $key = null, string|array|null $default = null)

Retrieve a cookie from the request.

array
allFiles()

Get an array of all of the files on the request.

array
convertUploadedFiles(array $files)

Convert the given array of Symfony UploadedFiles to custom Laravel UploadedFiles.

bool
hasFile(string $key)

Determine if the uploaded data contains a file.

bool
isValidFile(mixed $file)

Check that the given file is a valid file instance.

UploadedFile|UploadedFile[]|array|null
file(string|null $key = null, mixed $default = null)

Retrieve a file from the request.

string|array|null
retrieveItem(string $source, string|null $key, string|array|null $default)

Retrieve a parameter item from a given source.

static void
macro(string $name, object|callable $macro)

Register a custom macro.

static void
mixin(object $mixin, bool $replace = true)

Mix another object into the class.

static bool
hasMacro(string $name)

Checks if macro is registered.

static void
flushMacros()

Flush the existing macros.

static mixed
__callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

mixed
__call(string $method, array $parameters)

Dynamically handle calls to the class.

static Request
capture()

Create a new Illuminate HTTP request from server variables.

$this
instance()

Return the Request instance.

string
method()

Get the request method.

string
root()

Get the root URL for the application.

string
url()

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

string
fullUrl()

Get the full URL for the request.

string
fullUrlWithQuery(array $query)

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

string
fullUrlWithoutQuery(array|string $keys)

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

string
path()

Get the current path info for the request.

string
decodedPath()

Get the current decoded path info for the request.

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

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

array
segments()

Get all of the segments for the request path.

bool
is(mixed ...$patterns)

Determine if the current request URI matches a pattern.

bool
routeIs(mixed ...$patterns)

Determine if the route name matches a given pattern.

bool
fullUrlIs(mixed ...$patterns)

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

string
host()

Get the host name.

string
httpHost()

Get the HTTP host being requested.

string
schemeAndHttpHost()

Get the scheme and HTTP host.

bool
ajax()

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

bool
pjax()

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

bool
prefetch()

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

bool
secure()

Determine if the request is over HTTPS.

string|null
ip()

Get the client IP address.

array
ips()

Get the client IP addresses.

string|null
userAgent()

Get the client user agent.

$this
merge(array $input)

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

$this
mergeIfMissing(array $input)

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

$this
replace(array $input)

Replace the input values for the current request.

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

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

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

Get the JSON payload for the request.

InputBag
getInputSource()

Get the input source for the request.

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

Create a new request instance from the given Laravel request.

static Request
createFromBase(Request $request)

Create an Illuminate request from a Symfony instance.

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)

{@inheritdoc}

mixed
filterFiles(mixed $files)

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

bool
hasSession(bool $skipIfUninitialized = false)

{@inheritdoc}

SessionInterface
getSession()

{@inheritdoc}

session()

Get the session associated with the request.

void
setLaravelSession(Session $session)

Set the session instance on the request.

void
setRequestLocale(string $locale)

Set the locale for the request instance.

void
setDefaultRequestLocale(string $locale)

Set the default locale for the request instance.

mixed
user(string|null $guard = null)

Get the user making the request.

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

Get the route handling the request.

string
fingerprint()

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

$this
setJson(InputBag $json)

Set the JSON payload for the request.

getUserResolver()

Get the user resolver callback.

$this
setUserResolver(Closure $callback)

Set the user resolver callback.

getRouteResolver()

Get the route resolver callback.

$this
setRouteResolver(Closure $callback)

Set the route resolver callback.

toArray()

Get all of the input and files for the request.

bool
offsetExists(string $offset)

Determine if the given offset exists.

mixed
offsetGet(string $offset)

Get the value at the given offset.

void
offsetSet(string $offset, mixed $value)

Set the value at the given offset.

void
offsetUnset(string $offset)

Remove the value at the given offset.

bool
__isset(string $key)

Check if an input element is set on the request.

mixed
__get(string $key)

Get an input element from the request.

array
validate(array $rules, mixed $params)

No description

array
validateWithBag(string $errorBag, array $rules, mixed $params)

No description

bool
hasValidSignature(bool $absolute = true)

No description

Details

array filterPrecognitiveRules(array $rules)

Filter the given array of rules into an array of rules that are included in precognitive headers.

Parameters

array $rules

Return Value

array

bool isAttemptingPrecognition()

Determine if the request is attempting to be precognitive.

Return Value

bool

bool isPrecognitive()

Determine if the request is precognitive.

Return Value

bool

bool isJson()

Determine if the request is sending JSON.

Return Value

bool

bool expectsJson()

Determine if the current request probably expects a JSON response.

Return Value

bool

bool wantsJson()

Determine if the current request is asking for JSON.

Return Value

bool

bool accepts(string|array $contentTypes)

Determines whether the current requests accepts a given content type.

Parameters

string|array $contentTypes

Return Value

bool

string|null prefers(string|array $contentTypes)

Return the most suitable content type from the given array based on content negotiation.

Parameters

string|array $contentTypes

Return Value

string|null

bool acceptsAnyContentType()

Determine if the current request accepts any content type.

Return Value

bool

bool acceptsJson()

Determines whether a request accepts JSON.

Return Value

bool

bool acceptsHtml()

Determines whether a request accepts HTML.

Return Value

bool

static bool matchesType(string $actual, string $type)

Determine if the given content types match.

Parameters

string $actual
string $type

Return Value

bool

string format(string $default = 'html')

Get the data format expected in the response.

Parameters

string $default

Return Value

string

string|array|null old(string|null $key = null, Model|string|array|null $default = null)

Retrieve an old input item.

Parameters

string|null $key
Model|string|array|null $default

Return Value

string|array|null

void flash()

Flash the input for the current request to the session.

Return Value

void

void flashOnly(array|mixed $keys)

Flash only some of the input to the session.

Parameters

array|mixed $keys

Return Value

void

void flashExcept(array|mixed $keys)

Flash only some of the input to the session.

Parameters

array|mixed $keys

Return Value

void

void flush()

Flush all of the old input from the session.

Return Value

void

never dd(mixed ...$args)

Dump the given arguments and terminate execution.

Parameters

mixed ...$args

Return Value

never

$this dump(mixed ...$args)

Dump the given arguments.

Parameters

mixed ...$args

Return Value

$this

string|array|null server(string|null $key = null, string|array|null $default = null)

Retrieve a server variable from the request.

Parameters

string|null $key
string|array|null $default

Return Value

string|array|null

bool hasHeader(string $key)

Determine if a header is set on the request.

Parameters

string $key

Return Value

bool

string|array|null header(string|null $key = null, string|array|null $default = null)

Retrieve a header from the request.

Parameters

string|null $key
string|array|null $default

Return Value

string|array|null

string|null bearerToken()

Get the bearer token from the request headers.

Return Value

string|null

bool exists(string|array $key)

Determine if the request contains a given input item key.

Parameters

string|array $key

Return Value

bool

bool has(string|array $key)

Determine if the request contains a given input item key.

Parameters

string|array $key

Return Value

bool

bool hasAny(string|array $keys)

Determine if the request contains any of the given inputs.

Parameters

string|array $keys

Return Value

bool

$this|mixed whenHas(string $key, callable $callback, callable|null $default = null)

Apply the callback if the request contains the given input item key.

Parameters

string $key
callable $callback
callable|null $default

Return Value

$this|mixed

bool filled(string|array $key)

Determine if the request contains a non-empty value for an input item.

Parameters

string|array $key

Return Value

bool

bool isNotFilled(string|array $key)

Determine if the request contains an empty value for an input item.

Parameters

string|array $key

Return Value

bool

bool anyFilled(string|array $keys)

Determine if the request contains a non-empty value for any of the given inputs.

Parameters

string|array $keys

Return Value

bool

$this|mixed whenFilled(string $key, callable $callback, callable|null $default = null)

Apply the callback if the request contains a non-empty value for the given input item key.

Parameters

string $key
callable $callback
callable|null $default

Return Value

$this|mixed

bool missing(string|array $key)

Determine if the request is missing a given input item key.

Parameters

string|array $key

Return Value

bool

$this|mixed whenMissing(string $key, callable $callback, callable|null $default = null)

Apply the callback if the request is missing the given input item key.

Parameters

string $key
callable $callback
callable|null $default

Return Value

$this|mixed

protected bool isEmptyString(string $key)

Determine if the given input key is an empty string for "filled".

Parameters

string $key

Return Value

bool

array keys()

Get the keys for all of the input and files.

Return Value

array

array all(array|mixed|null $keys = null)

Get all of the input and files for the request.

Parameters

array|mixed|null $keys

Return Value

array

mixed input(string|null $key = null, mixed $default = null)

Retrieve an input item from the request.

Parameters

string|null $key
mixed $default

Return Value

mixed

Stringable str(string $key, mixed $default = null)

Retrieve input from the request as a Stringable instance.

Parameters

string $key
mixed $default

Return Value

Stringable

Stringable string(string $key, mixed $default = null)

Retrieve input from the request as a Stringable instance.

Parameters

string $key
mixed $default

Return Value

Stringable

bool boolean(string|null $key = null, bool $default = false)

Retrieve input as a boolean value.

Returns true when value is "1", "true", "on", and "yes". Otherwise, returns false.

Parameters

string|null $key
bool $default

Return Value

bool

int integer(string $key, int $default = 0)

Retrieve input as an integer value.

Parameters

string $key
int $default

Return Value

int

float float(string $key, float $default = 0.0)

Retrieve input as a float value.

Parameters

string $key
float $default

Return Value

float

Carbon|null date(string $key, string|null $format = null, string|null $tz = null)

Retrieve input from the request as a Carbon instance.

Parameters

string $key
string|null $format
string|null $tz

Return Value

Carbon|null

Exceptions

InvalidFormatException

TEnum|null enum(string $key, TEnum> $enumClass)

Retrieve input from the request as an enum.

Parameters

string $key
TEnum> $enumClass

Return Value

TEnum|null

Collection collect(array|string|null $key = null)

Retrieve input from the request as a collection.

Parameters

array|string|null $key

Return Value

Collection

array only(array|mixed $keys)

Get a subset containing the provided keys with values from the input data.

Parameters

array|mixed $keys

Return Value

array

array except(array|mixed $keys)

Get all of the input except for a specified array of items.

Parameters

array|mixed $keys

Return Value

array

string|array|null query(string|null $key = null, string|array|null $default = null)

Retrieve a query string item from the request.

Parameters

string|null $key
string|array|null $default

Return Value

string|array|null

string|array|null post(string|null $key = null, string|array|null $default = null)

Retrieve a request payload item from the request.

Parameters

string|null $key
string|array|null $default

Return Value

string|array|null

bool hasCookie(string $key)

Determine if a cookie is set on the request.

Parameters

string $key

Return Value

bool

Retrieve a cookie from the request.

Parameters

string|null $key
string|array|null $default

Return Value

string|array|null

array allFiles()

Get an array of all of the files on the request.

Return Value

array

protected array convertUploadedFiles(array $files)

Convert the given array of Symfony UploadedFiles to custom Laravel UploadedFiles.

Parameters

array $files

Return Value

array

bool hasFile(string $key)

Determine if the uploaded data contains a file.

Parameters

string $key

Return Value

bool

protected bool isValidFile(mixed $file)

Check that the given file is a valid file instance.

Parameters

mixed $file

Return Value

bool

UploadedFile|UploadedFile[]|array|null file(string|null $key = null, mixed $default = null)

Retrieve a file from the request.

Parameters

string|null $key
mixed $default

Return Value

UploadedFile|UploadedFile[]|array|null

protected string|array|null retrieveItem(string $source, string|null $key, string|array|null $default)

Retrieve a parameter item from a given source.

Parameters

string $source
string|null $key
string|array|null $default

Return Value

string|array|null

static void macro(string $name, object|callable $macro)

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

static void flushMacros()

Flush the existing macros.

Return Value

void

static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

static Request capture()

Create a new Illuminate HTTP request from server variables.

Return Value

Request

$this instance()

Return the Request instance.

Return Value

$this

string method()

Get the request method.

Return Value

string

string root()

Get the root URL for the application.

Return Value

string

string url()

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

Return Value

string

string fullUrl()

Get the full URL for the request.

Return Value

string

string fullUrlWithQuery(array $query)

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

Parameters

array $query

Return Value

string

string fullUrlWithoutQuery(array|string $keys)

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

Parameters

array|string $keys

Return Value

string

string path()

Get the current path info for the request.

Return Value

string

string decodedPath()

Get the current decoded path info for the request.

Return Value

string

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

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

Parameters

int $index
string|null $default

Return Value

string|null

array segments()

Get all of the segments for the request path.

Return Value

array

bool is(mixed ...$patterns)

Determine if the current request URI matches a pattern.

Parameters

mixed ...$patterns

Return Value

bool

bool routeIs(mixed ...$patterns)

Determine if the route name matches a given pattern.

Parameters

mixed ...$patterns

Return Value

bool

bool fullUrlIs(mixed ...$patterns)

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

Parameters

mixed ...$patterns

Return Value

bool

string host()

Get the host name.

Return Value

string

string httpHost()

Get the HTTP host being requested.

Return Value

string

string schemeAndHttpHost()

Get the scheme and HTTP host.

Return Value

string

bool ajax()

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

Return Value

bool

bool pjax()

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

Return Value

bool

bool prefetch()

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

Return Value

bool

bool secure()

Determine if the request is over HTTPS.

Return Value

bool

string|null ip()

Get the client IP address.

Return Value

string|null

array ips()

Get the client IP addresses.

Return Value

array

string|null userAgent()

Get the client user agent.

Return Value

string|null

$this merge(array $input)

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

Parameters

array $input

Return Value

$this

$this mergeIfMissing(array $input)

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

Parameters

array $input

Return Value

$this

$this replace(array $input)

Replace the input values for the current request.

Parameters

array $input

Return Value

$this

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

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

Instead, you may use the "input" method.

Parameters

string $key
mixed $default

Return Value

mixed

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

Get the JSON payload for the request.

Parameters

string|null $key
mixed $default

Return Value

InputBag|mixed

protected InputBag getInputSource()

Get the input source for the request.

Return Value

InputBag

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

Create a new request instance from the given Laravel request.

Parameters

Request $from
Request|null $to

Return Value

Request

static Request createFromBase(Request $request)

Create an Illuminate request from a Symfony instance.

Parameters

Request $request

Return Value

Request

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

{@inheritdoc}

Parameters

array|null $query
array|null $request
array|null $attributes
array|null $cookies
array|null $files
array|null $server

Return Value

Request

protected mixed filterFiles(mixed $files)

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

Parameters

mixed $files

Return Value

mixed

bool hasSession(bool $skipIfUninitialized = false)

{@inheritdoc}

Parameters

bool $skipIfUninitialized

Return Value

bool

SessionInterface getSession()

{@inheritdoc}

Return Value

SessionInterface

Session session()

Get the session associated with the request.

Return Value

Session

Exceptions

RuntimeException

void setLaravelSession(Session $session)

Set the session instance on the request.

Parameters

Session $session

Return Value

void

void setRequestLocale(string $locale)

Set the locale for the request instance.

Parameters

string $locale

Return Value

void

void setDefaultRequestLocale(string $locale)

Set the default locale for the request instance.

Parameters

string $locale

Return Value

void

mixed user(string|null $guard = null)

Get the user making the request.

Parameters

string|null $guard

Return Value

mixed

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

Get the route handling the request.

Parameters

string|null $param
mixed $default

Return Value

Route|object|string|null

string fingerprint()

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

Return Value

string

Exceptions

RuntimeException

$this setJson(InputBag $json)

Set the JSON payload for the request.

Parameters

InputBag $json

Return Value

$this

Closure getUserResolver()

Get the user resolver callback.

Return Value

Closure

$this setUserResolver(Closure $callback)

Set the user resolver callback.

Parameters

Closure $callback

Return Value

$this

Closure getRouteResolver()

Get the route resolver callback.

Return Value

Closure

$this setRouteResolver(Closure $callback)

Set the route resolver callback.

Parameters

Closure $callback

Return Value

$this

toArray()

Get all of the input and files for the request.

bool offsetExists(string $offset)

Determine if the given offset exists.

Parameters

string $offset

Return Value

bool

mixed offsetGet(string $offset)

Get the value at the given offset.

Parameters

string $offset

Return Value

mixed

void offsetSet(string $offset, mixed $value)

Set the value at the given offset.

Parameters

string $offset
mixed $value

Return Value

void

void offsetUnset(string $offset)

Remove the value at the given offset.

Parameters

string $offset

Return Value

void

bool __isset(string $key)

Check if an input element is set on the request.

Parameters

string $key

Return Value

bool

mixed __get(string $key)

Get an input element from the request.

Parameters

string $key

Return Value

mixed

array validate(array $rules, mixed $params)

No description

Parameters

array $rules
mixed $params

Return Value

array

array validateWithBag(string $errorBag, array $rules, mixed $params)

No description

Parameters

string $errorBag
array $rules
mixed $params

Return Value

array

bool hasValidSignature(bool $absolute = true)

No description

Parameters

bool $absolute

Return Value

bool