FormRequest

class FormRequest extends Request implements ValidatesWhenResolved (View source)

Traits

ValidatesWhenResolvedTrait Provides default implementation of ValidatesWhenResolved contract.

Properties

protected string $json The decoded JSON content 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 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 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 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()

Returns the client IP address.

 from Request
array ips()

Returns the client IP addresses.

 from Request
bool exists(string|array $key)

Determine if the request contains a given input item key.

 from Request
bool has(string|array $key)

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

 from Request
bool isEmptyString(string $key)

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

 from Request
array all()

Get all of the input and files for the request.

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

Retrieve an input item from the request.

 from Request
array only(array $keys)

Get a subset of the items from the input data.

 from Request
array except(array|mixed $keys)

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

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

Retrieve a query string item from the request.

 from Request
bool hasCookie(string $key)

Determine if a cookie is set on the request.

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

Retrieve a cookie from the request.

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

Retrieve a file from the request.

 from Request
bool hasFile(string $key)

Determine if the uploaded data contains a file.

 from Request
bool isValidFile(mixed $file)

Check that the given file is a valid file instance.

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

Retrieve a header from the request.

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

Retrieve a server variable from the request.

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

Retrieve an old input item.

 from Request
void flash(string $filter = null, array $keys = [])

Flash the input for the current request to the session.

 from Request
void flashOnly(array|mixed $keys)

Flash only some of the input to the session.

 from Request
void flashExcept(array|mixed $keys)

Flash only some of the input to the session.

 from Request
void flush()

Flush all of the old input from the session.

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

Retrieve a parameter item from a given source.

 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 bool matchesType(string $actual, string $type)

Determine if the given content types match.

 from Request
bool isJson()

Determine if the request is sending JSON.

 from Request
bool wantsJson()

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

 from Request
bool accepts(string|array $contentTypes)

Determines whether the current requests accepts a given content type.

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

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

 from Request
bool acceptsJson()

Determines whether a request accepts JSON.

 from Request
bool acceptsHtml()

Determines whether a request accepts HTML.

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

Get the data format expected in the response.

 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
Store session()

Get the session associated with the request.

 from Request
mixed user()

Get the user making the request.

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

Get the route handling 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
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
Validator getValidatorInstance()

Get the validator instance for the request.
mixed failedValidation(Validator $validator)

Handle a failed validation attempt.
bool passesAuthorization()

Determine if the request passes the authorization check.
mixed failedAuthorization()

Handle a failed authorization attempt.
Response response(array $errors)

Get the proper failed validation response for the request.
Response forbiddenResponse()

Get the response for a forbidden operation.
array formatErrors(Validator $validator)

Format the errors from the given Validator instance.
string getRedirectUrl()

Get the URL to redirect to on a validation error.
FormRequest setRedirector(Redirector $redirector)

Set the Redirector instance.
$this setContainer(Container $container)

Set the container implementation.
array messages()

Set custom messages for validator errors.
array attributes()

Set custom attributes for validator errors.

Details

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 path()

Get the current path info for the request.

Return Value

string

string decodedPath()

Get the current encoded 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()

Determine if the current request URI matches a pattern.

Return Value

bool

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 an PJAX call.

Return Value

bool

bool secure()

Determine if the request is over HTTPS.

Return Value

bool

string ip()

Returns the client IP address.

Return Value

string

array ips()

Returns the client IP addresses.

Return Value

array

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 non-empty value for an input item.

Parameters

string|array $key

Return Value

bool

protected bool isEmptyString(string $key)

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

Parameters

string $key

Return Value

bool

array all()

Get all of the input and files for the request.

Return Value

array

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

array only(array $keys)

Get a subset of the items from the input data.

Parameters

array $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 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

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

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

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

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

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

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

void flash(string $filter = null, array $keys = [])

Flash the input for the current request to the session.

Parameters

string $filter
array $keys

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

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

void merge(array $input)

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

Parameters

array $input

Return Value

void

void replace(array $input)

Replace the input for the current request.

Parameters

array $input

Return Value

void

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

Get the JSON payload for the request.

Parameters

string $key
mixed $default

Return Value

mixed

protected ParameterBag getInputSource()

Get the input source for the request.

Return Value

ParameterBag

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

Determine if the given content types match.

Parameters

string $actual
string $type

Return Value

bool

bool isJson()

Determine if the request is sending JSON.

Return Value

bool

bool wantsJson()

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

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 acceptsJson()

Determines whether a request accepts JSON.

Return Value

bool

bool acceptsHtml()

Determines whether a request accepts HTML.

Return Value

bool

string format(string $default = 'html')

Get the data format expected in the response.

Parameters

string $default

Return Value

string

static Request createFromBase(Request $request)

Create an Illuminate request from a Symfony instance.

Parameters

Request $request

Return Value

Request

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

Store session()

Get the session associated with the request.

Return Value

Store

Exceptions

RuntimeException

mixed user()

Get the user making the request.

Return Value

mixed

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

Get the route handling the request.

Parameters

string|null $param

Return Value

Route|object|string

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

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

void validate()

Validate the class instance.

Return Value

void

protected Validator getValidatorInstance()

Get the validator instance for the request.

Return Value

Validator

protected mixed failedValidation(Validator $validator)

Handle a failed validation attempt.

Parameters

Validator $validator

Return Value

mixed

protected bool passesAuthorization()

Determine if the request passes the authorization check.

Return Value

bool

protected mixed failedAuthorization()

Handle a failed authorization attempt.

Return Value

mixed

Response response(array $errors)

Get the proper failed validation response for the request.

Parameters

array $errors

Return Value

Response

Response forbiddenResponse()

Get the response for a forbidden operation.

Return Value

Response

protected array formatErrors(Validator $validator)

Format the errors from the given Validator instance.

Parameters

Validator $validator

Return Value

array

protected string getRedirectUrl()

Get the URL to redirect to on a validation error.

Return Value

string

FormRequest setRedirector(Redirector $redirector)

Set the Redirector instance.

Parameters

Redirector $redirector

Return Value

FormRequest

$this setContainer(Container $container)

Set the container implementation.

Parameters

Container $container

Return Value

$this

array messages()

Set custom messages for validator errors.

Return Value

array

array attributes()

Set custom attributes for validator errors.

Return Value

array

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.1/Illuminate/Foundation/Http/FormRequest.html