FormRequest (Foundation\Http)
FormRequest
class FormRequest extends Request implements ValidatesWhenResolved (View source)
Traits
ValidatesWhenResolvedTrait | Provides default implementation of ValidatesWhenResolved contract. |
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 |
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 |
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 = array()) 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 |
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 |
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) | 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 |
Response | response( array $errors) Get the proper failed validation response for the request. | |
Response | forbiddenResponse() Get the response for a forbidden operation. | |
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.
$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 path()
Get the current path info for the request.
string decodedPath()
Get the current encoded 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()
Determine if the current request URI matches a pattern.
bool ajax()
Determine if the request is the result of an AJAX call.
bool pjax()
Determine if the request is the result of an PJAX call.
bool secure()
Determine if the request is over HTTPS.
string ip()
Returns the client IP address.
array ips()
Returns the client IP addresses.
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 non-empty value for an input item.
array all()
Get all of the input and files for the request.
string|array input( string $key = null, string|array|null $default = null)
Retrieve an input item from the request.
array only( array $keys)
Get a subset of the items from the input data.
array except( array|mixed $keys)
Get all of the input except for a specified array of items.
string|array query( string $key = null, string|array|null $default = null)
Retrieve a query string item from the request.
bool hasCookie( string $key)
Determine if a cookie is set on the request.
string|array cookie( string $key = null, string|array|null $default = null)
Retrieve a cookie from the request.
UploadedFile|array|null file( string $key = null, mixed $default = null)
Retrieve a file from the request.
bool hasFile( string $key)
Determine if the uploaded data contains a file.
string|array header( string $key = null, string|array|null $default = null)
Retrieve a header from the request.
string|array server( string $key = null, string|array|null $default = null)
Retrieve a server variable from the request.
string|array old( string $key = null, string|array|null $default = null)
Retrieve an old input item.
void flash( string $filter = null, array $keys = array())
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.
void merge( array $input)
Merge new input into the current request's input array.
void replace( array $input)
Replace the input for the current request.
mixed json( string $key = null, mixed $default = null)
Get the JSON payload for the request.
static bool matchesType( string $actual, string $type)
Determine if the given content types match.
bool isJson()
Determine if the request is sending JSON.
bool wantsJson()
Determine if the current request is asking for JSON in return.
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 acceptsJson()
Determines whether a request accepts JSON.
bool acceptsHtml()
Determines whether a request accepts HTML.
string format( string $default = 'html')
Get the data format expected in the response.
static Request createFromBase( Request $request)
Create an Illuminate request from a Symfony instance.
duplicate( array $query = null, array $request = null, array $attributes = null, array $cookies = null, array $files = null, array $server = null)
Store session()
Get the session associated with the request.
mixed user()
Get the user making the request.
Route|object|string route( string|null $param = null)
Get the route handling the request.
Closure getUserResolver()
Get the user resolver callback.
$this setUserResolver( Closure $callback)
Set the user resolver callback.
Closure getRouteResolver()
Get the route resolver callback.
$this setRouteResolver( Closure $callback)
Set the route resolver callback.
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.
void validate()
Validate the class instance.
Response response( array $errors)
Get the proper failed validation response for the request.
Response forbiddenResponse()
Get the response for a forbidden operation.
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.
© 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