1. class
  2. Illuminate
  3. \
  4. Foundation
  5. \
  6. Http
  7. \
  8. FormRequest

FormRequest

class FormRequest extends Request implements ValidatesWhenResolved

Traits

ValidatesWhenResolvedTrait

Provides default implementation of ValidatesWhenResolved contract.

InteractsWithContentTypes
InteractsWithFlashData
InteractsWithInput
Macroable

Properties

static protected array $macros

The registered string macros.

 from  Macroable
protected string $json

The decoded JSON content for the request.

 from  Request
protected array $convertedFiles

All of the converted files for the request.

 from  Request
protected Closure $userResolver

The user resolver callback.

 from  Request
protected Closure $routeResolver

The route resolver callback.

 from  Request
protected Container $container

The container instance.
protected Redirector $redirector

The redirector instance.
protected string $redirect

The URI to redirect to if validation fails.
protected string $redirectRoute

The route to redirect to if validation fails.
protected string $redirectAction

The controller action to redirect to if validation fails.
protected string $errorBag

The key to be used for the view error bag.
protected array $dontFlash

The input keys that should not be flashed on redirect.

Methods

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

Determine if the given content types match.

from  InteractsWithContentTypes
bool
isJson()

Determine if the request is sending JSON.

from  InteractsWithContentTypes
bool
expectsJson()

Determine if the current request probably expects a JSON response.

from  InteractsWithContentTypes
bool
wantsJson()

Determine if the current request is asking for JSON in return.

from  InteractsWithContentTypes
bool
accepts(string|array $contentTypes)

Determines whether the current requests accepts a given content type.

from  InteractsWithContentTypes
string|null
prefers(string|array $contentTypes)

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

from  InteractsWithContentTypes
bool
acceptsJson()

Determines whether a request accepts JSON.

from  InteractsWithContentTypes
bool
acceptsHtml()

Determines whether a request accepts HTML.

from  InteractsWithContentTypes
string
format(string $default = 'html')

Get the data format expected in the response.

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

Retrieve an old input item.

from  InteractsWithFlashData
void
flash()

Flash the input for the current request to the session.

from  InteractsWithFlashData
void
flashOnly(array|mixed $keys)

Flash only some of the input to the session.

from  InteractsWithFlashData
void
flashExcept(array|mixed $keys)

Flash only some of the input to the session.

from  InteractsWithFlashData
void
flush()

Flush all of the old input from the session.

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

Retrieve a server variable from the request.

from  InteractsWithInput
bool
hasHeader(string $key)

Determine if a header is set on the request.

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

Retrieve a header from the request.

from  InteractsWithInput
string|null
bearerToken()

Get the bearer token from the request headers.

from  InteractsWithInput
bool
exists(string|array $key)

Determine if the request contains a given input item key.

from  InteractsWithInput
bool
has(string|array $key)

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

from  InteractsWithInput
bool
isEmptyString(string $key)

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

from  InteractsWithInput
array
all()

Get all of the input and files for the request.

from  InteractsWithInput
string|array
input(string $key = null, string|array|null $default = null)

Retrieve an input item from the request.

from  InteractsWithInput
array
only(array|mixed $keys)

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

from  InteractsWithInput
array
except(array|mixed $keys)

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

from  InteractsWithInput
array
intersect(array|mixed $keys)

Intersect an array of items with the input data.

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

Retrieve a query string item from the request.

from  InteractsWithInput
bool
hasCookie(string $key)

Determine if a cookie is set on the request.

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

Retrieve a cookie from the request.

from  InteractsWithInput
array
allFiles()

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

from  InteractsWithInput
array
convertUploadedFiles(array $files)

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

from  InteractsWithInput
bool
hasFile(string $key)

Determine if the uploaded data contains a file.

from  InteractsWithInput
bool
isValidFile(mixed $file)

Check that the given file is a valid file instance.

from  InteractsWithInput
UploadedFile|array|null
file(string $key = null, mixed $default = null)

Retrieve a file from the request.

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

Retrieve a parameter item from a given source.

from  InteractsWithInput
static void
macro(string $name, callable $macro)

Register a custom macro.

from  Macroable
static bool
hasMacro(string $name)

Checks if macro is registered.

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

Dynamically handle calls to the class.

from  Macroable
mixed
__call(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
static Request
capture()

Create a new Illuminate HTTP request from server variables.

from  Request
$this
instance()

Return the Request instance.

from  Request
string
method()

Get the request method.

from  Request
string
root()

Get the root URL for the application.

from  Request
string
url()

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

from  Request
string
fullUrl()

Get the full URL for the request.

from  Request
string
fullUrlWithQuery(array $query)

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

from  Request
string
path()

Get the current path info for the request.

from  Request
string
decodedPath()

Get the current encoded path info for the request.

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

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

from  Request
array
segments()

Get all of the segments for the request path.

from  Request
bool
is()

Determine if the current request URI matches a pattern.

from  Request
bool
routeIs(string $name)

Check if the route name matches the given string.

from  Request
bool
fullUrlIs()

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

from  Request
bool
ajax()

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

from  Request
bool
pjax()

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

from  Request
bool
secure()

Determine if the request is over HTTPS.

from  Request
string
ip()

Get the client IP address.

from  Request
array
ips()

Get the client IP addresses.

from  Request
string
userAgent()

Get the client user agent.

from  Request
void
merge(array $input)

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

from  Request
void
replace(array $input)

Replace the input for the current request.

from  Request
mixed
json(string $key = null, mixed $default = null)

Get the JSON payload for the request.

from  Request
ParameterBag
getInputSource()

Get the input source for the request.

from  Request
static Request
createFromBase(Request $request)

Create an Illuminate request from a Symfony instance.

from  Request
duplicate(array $query = null, array $request = null, array $attributes = null, array $cookies = null, array $files = null, array $server = null)

{@inheritdoc}

from  Request
mixed
filterFiles(mixed $files)

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

from  Request
Store
session()

Get the session associated with the request.

from  Request
void
setLaravelSession(Session $session)

Set the session instance on the request.

from  Request
mixed
user(string|null $guard = null)

Get the user making the request.

from  Request
Route|object|string
route(string|null $param = null)

Get the route handling the request.

from  Request
string
fingerprint()

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

from  Request
$this
setJson(array $json)

Set the JSON payload for the request.

from  Request
Closure
getUserResolver()

Get the user resolver callback.

from  Request
$this
setUserResolver(Closure $callback)

Set the user resolver callback.

from  Request
Closure
getRouteResolver()

Get the route resolver callback.

from  Request
$this
setRouteResolver(Closure $callback)

Set the route resolver callback.

from  Request
array
toArray()

Get all of the input and files for the request.

from  Request
bool
offsetExists(string $offset)

Determine if the given offset exists.

from  Request
mixed
offsetGet(string $offset)

Get the value at the given offset.

from  Request
void
offsetSet(string $offset, mixed $value)

Set the value at the given offset.

from  Request
void
offsetUnset(string $offset)

Remove the value at the given offset.

from  Request
bool
__isset(string $key)

Check if an input element is set on the request.

from  Request
mixed
__get(string $key)

Get an input element from the request.

from  Request
void
validate()

Validate the class instance.

from  ValidatesWhenResolvedTrait
void
prepareForValidation()

Prepare the data for validation.

from  ValidatesWhenResolvedTrait
Validator
getValidatorInstance()

Get the validator instance for the request.

void
failedValidation(Validator $validator)

Handle a failed validation attempt.

bool
passesAuthorization()

Determine if the request passes the authorization check.

void
failedAuthorization()

Handle a failed authorization attempt.

Validator
createDefaultValidator(Factory $factory)

Create the default validator instance.

array
validationData()

Get data to be validated from the request.

Response
response(array $errors)

Get the proper failed validation response for the request.

array
formatErrors(Validator $validator)

Format the errors from the given Validator instance.

string
getRedirectUrl()

Get the URL to redirect to on a validation error.

array
messages()

Get custom messages for validator errors.

array
attributes()

Get custom attributes for validator errors.

$this
setRedirector(Redirector $redirector)

Set the Redirector instance.

$this
setContainer(Container $container)

Set the container implementation.

Details

in InteractsWithContentTypes at line 16
static bool matchesType(string $actual, string $type)

Determine if the given content types match.

Parameters

string $actual
string $type

Return Value

bool

in InteractsWithContentTypes at line 32
bool isJson()

Determine if the request is sending JSON.

Return Value

bool

in InteractsWithContentTypes at line 42
bool expectsJson()

Determine if the current request probably expects a JSON response.

Return Value

bool

in InteractsWithContentTypes at line 52
bool wantsJson()

Determine if the current request is asking for JSON in return.

Return Value

bool

in InteractsWithContentTypes at line 65
bool accepts(string|array $contentTypes)

Determines whether the current requests accepts a given content type.

Parameters

string|array $contentTypes

Return Value

bool

in InteractsWithContentTypes at line 96
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

in InteractsWithContentTypes at line 126
bool acceptsJson()

Determines whether a request accepts JSON.

Return Value

bool

in InteractsWithContentTypes at line 136
bool acceptsHtml()

Determines whether a request accepts HTML.

Return Value

bool

in InteractsWithContentTypes at line 147
string format(string $default = 'html')

Get the data format expected in the response.

Parameters

string $default

Return Value

string

in InteractsWithFlashData at line 14
string|array old(string $key = null, string|array|null $default = null)

Retrieve an old input item.

Parameters

string $key
string|array|null $default

Return Value

string|array

in InteractsWithFlashData at line 24
void flash()

Flash the input for the current request to the session.

Return Value

void

in InteractsWithFlashData at line 35
void flashOnly(array|mixed $keys)

Flash only some of the input to the session.

Parameters

array|mixed $keys

Return Value

void

in InteractsWithFlashData at line 48
void flashExcept(array|mixed $keys)

Flash only some of the input to the session.

Parameters

array|mixed $keys

Return Value

void

in InteractsWithFlashData at line 60
void flush()

Flush all of the old input from the session.

Return Value

void

in InteractsWithInput at line 19
string|array server(string $key = null, string|array|null $default = null)

Retrieve a server variable from the request.

Parameters

string $key
string|array|null $default

Return Value

string|array

in InteractsWithInput at line 30
bool hasHeader(string $key)

Determine if a header is set on the request.

Parameters

string $key

Return Value

bool

in InteractsWithInput at line 42
string|array header(string $key = null, string|array|null $default = null)

Retrieve a header from the request.

Parameters

string $key
string|array|null $default

Return Value

string|array

in InteractsWithInput at line 52
string|null bearerToken()

Get the bearer token from the request headers.

Return Value

string|null

in InteractsWithInput at line 67
bool exists(string|array $key)

Determine if the request contains a given input item key.

Parameters

string|array $key

Return Value

bool

in InteractsWithInput at line 88
bool has(string|array $key)

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

Parameters

string|array $key

Return Value

bool

in InteractsWithInput at line 107
protected bool isEmptyString(string $key)

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

Parameters

string $key

Return Value

bool

in InteractsWithInput at line 119
array all()

Get all of the input and files for the request.

Return Value

array

in InteractsWithInput at line 131
string|array input(string $key = null, string|array|null $default = null)

Retrieve an input item from the request.

Parameters

string $key
string|array|null $default

Return Value

string|array

in InteractsWithInput at line 144
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

in InteractsWithInput at line 165
array except(array|mixed $keys)

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

Parameters

array|mixed $keys

Return Value

array

in InteractsWithInput at line 182
array intersect(array|mixed $keys)

Intersect an array of items with the input data.

Parameters

array|mixed $keys

Return Value

array

in InteractsWithInput at line 194
string|array query(string $key = null, string|array|null $default = null)

Retrieve a query string item from the request.

Parameters

string $key
string|array|null $default

Return Value

string|array

in InteractsWithInput at line 205
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 $key
string|array|null $default

Return Value

string|array

in InteractsWithInput at line 227
array allFiles()

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

Return Value

array

in InteractsWithInput at line 242
protected array convertUploadedFiles(array $files)

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

Parameters

array $files

Return Value

array

in InteractsWithInput at line 261
bool hasFile(string $key)

Determine if the uploaded data contains a file.

Parameters

string $key

Return Value

bool

in InteractsWithInput at line 282
protected bool isValidFile(mixed $file)

Check that the given file is a valid file instance.

Parameters

mixed $file

Return Value

bool

in InteractsWithInput at line 294
UploadedFile|array|null file(string $key = null, mixed $default = null)

Retrieve a file from the request.

Parameters

string $key
mixed $default

Return Value

UploadedFile|array|null

in InteractsWithInput at line 307
protected string|array retrieveItem(string $source, string $key, string|array|null $default)

Retrieve a parameter item from a given source.

Parameters

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

Return Value

string|array

in Macroable at line 24
static void macro(string $name, callable $macro)

Register a custom macro.

Parameters

string $name
callable $macro

Return Value

void

in Macroable at line 35
static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 49
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Macroable at line 71
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Request at line 55
static Request capture()

Create a new Illuminate HTTP request from server variables.

Return Value

Request

in Request at line 67
$this instance()

Return the Request instance.

Return Value

$this

in Request at line 77
string method()

Get the request method.

Return Value

string

in Request at line 87
string root()

Get the root URL for the application.

Return Value

string

in Request at line 97
string url()

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

Return Value

string

in Request at line 107
string fullUrl()

Get the full URL for the request.

Return Value

string

in Request at line 122
string fullUrlWithQuery(array $query)

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

Parameters

array $query

Return Value

string

in Request at line 136
string path()

Get the current path info for the request.

Return Value

string

in Request at line 148
string decodedPath()

Get the current encoded path info for the request.

Return Value

string

in Request at line 160
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

in Request at line 170
array segments()

Get all of the segments for the request path.

Return Value

array

in Request at line 184
bool is()

Determine if the current request URI matches a pattern.

Return Value

bool

in Request at line 201
bool routeIs(string $name)

Check if the route name matches the given string.

Parameters

string $name

Return Value

bool

in Request at line 211
bool fullUrlIs()

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

Return Value

bool

in Request at line 229
bool ajax()

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

Return Value

bool

in Request at line 239
bool pjax()

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

Return Value

bool

in Request at line 249
bool secure()

Determine if the request is over HTTPS.

Return Value

bool

in Request at line 259
string ip()

Get the client IP address.

Return Value

string

in Request at line 269
array ips()

Get the client IP addresses.

Return Value

array

in Request at line 279
string userAgent()

Get the client user agent.

Return Value

string

in Request at line 290
void merge(array $input)

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

Parameters

array $input

Return Value

void

in Request at line 301
void replace(array $input)

Replace the input for the current request.

Parameters

array $input

Return Value

void

in Request at line 313
mixed json(string $key = null, mixed $default = null)

Get the JSON payload for the request.

Parameters

string $key
mixed $default

Return Value

mixed

in Request at line 331
protected ParameterBag getInputSource()

Get the input source for the request.

Return Value

ParameterBag

in Request at line 346
static Request createFromBase(Request $request)

Create an Illuminate request from a Symfony instance.

Parameters

Request $request

Return Value

Request

in Request at line 369
duplicate(array $query = null, array $request = null, array $attributes = null, array $cookies = null, array $files = null, array $server = null)

{@inheritdoc}

Parameters

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

in Request at line 380
protected mixed filterFiles(mixed $files)

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

Parameters

mixed $files

Return Value

mixed

in Request at line 406
Store session()

Get the session associated with the request.

Return Value

Store

Exceptions

RuntimeException

in Request at line 421
void setLaravelSession(Session $session)

Set the session instance on the request.

Parameters

Session $session

Return Value

void

in Request at line 432
mixed user(string|null $guard = null)

Get the user making the request.

Parameters

string|null $guard

Return Value

mixed

in Request at line 444
Route|object|string route(string|null $param = null)

Get the route handling the request.

Parameters

string|null $param

Return Value

Route|object|string

in Request at line 462
string fingerprint()

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

Return Value

string

Exceptions

RuntimeException

in Request at line 479
$this setJson(array $json)

Set the JSON payload for the request.

Parameters

array $json

Return Value

$this

in Request at line 491
Closure getUserResolver()

Get the user resolver callback.

Return Value

Closure

in Request at line 504
$this setUserResolver(Closure $callback)

Set the user resolver callback.

Parameters

Closure $callback

Return Value

$this

in Request at line 516
Closure getRouteResolver()

Get the route resolver callback.

Return Value

Closure

in Request at line 529
$this setRouteResolver(Closure $callback)

Set the route resolver callback.

Parameters

Closure $callback

Return Value

$this

in Request at line 541
array toArray()

Get all of the input and files for the request.

Return Value

array

in Request at line 552
bool offsetExists(string $offset)

Determine if the given offset exists.

Parameters

string $offset

Return Value

bool

in Request at line 563
mixed offsetGet(string $offset)

Get the value at the given offset.

Parameters

string $offset

Return Value

mixed

in Request at line 575
void offsetSet(string $offset, mixed $value)

Set the value at the given offset.

Parameters

string $offset
mixed $value

Return Value

void

in Request at line 586
void offsetUnset(string $offset)

Remove the value at the given offset.

Parameters

string $offset

Return Value

void

in Request at line 597
bool __isset(string $key)

Check if an input element is set on the request.

Parameters

string $key

Return Value

bool

in Request at line 608
mixed __get(string $key)

Get an input element from the request.

Parameters

string $key

Return Value

mixed

in ValidatesWhenResolvedTrait at line 15
void validate()

Validate the class instance.

Return Value

void

in ValidatesWhenResolvedTrait at line 33
protected void prepareForValidation()

Prepare the data for validation.

Return Value

void

at line 74
protected Validator getValidatorInstance()

Get the validator instance for the request.

Return Value

Validator

at line 123
protected void failedValidation(Validator $validator)

Handle a failed validation attempt.

Parameters

Validator $validator

Return Value

void

Exceptions

ValidationException

at line 183
protected bool passesAuthorization()

Determine if the request passes the authorization check.

Return Value

bool

at line 199
protected void failedAuthorization()

Handle a failed authorization attempt.

Return Value

void

Exceptions

AuthorizationException

at line 97
protected Validator createDefaultValidator(Factory $factory)

Create the default validator instance.

Parameters

Factory $factory

Return Value

Validator

at line 110
protected array validationData()

Get data to be validated from the request.

Return Value

array

at line 136
Response response(array $errors)

Get the proper failed validation response for the request.

Parameters

array $errors

Return Value

Response

at line 153
protected array formatErrors(Validator $validator)

Format the errors from the given Validator instance.

Parameters

Validator $validator

Return Value

array

at line 163
protected string getRedirectUrl()

Get the URL to redirect to on a validation error.

Return Value

string

at line 209
array messages()

Get custom messages for validator errors.

Return Value

array

at line 219
array attributes()

Get custom attributes for validator errors.

Return Value

array

at line 230
$this setRedirector(Redirector $redirector)

Set the Redirector instance.

Parameters

Redirector $redirector

Return Value

$this

at line 243
$this setContainer(Container $container)

Set the container implementation.

Parameters

Container $container

Return Value

$this