1. class
  2. Illuminate
  3. \
  4. Foundation
  5. \
  6. Auth
  7. \
  8. EmailVerificationRequest

EmailVerificationRequest

class EmailVerificationRequest extends FormRequest (View source)

Traits

ValidatesWhenResolvedTrait

Provides default implementation of ValidatesWhenResolved contract.

CanBePrecognitive
InteractsWithContentTypes
InteractsWithFlashData
InteractsWithInput
Conditionable
Macroable
Dumpable
InteractsWithData

Properties

static protected array $macros

The registered string macros.

 from  Macroable
protected InputBag|null $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.

 from  FormRequest
protected Redirector $redirector

The redirector instance.

 from  FormRequest
protected string $redirect

The URI to redirect to if validation fails.

 from  FormRequest
protected string $redirectRoute

The route to redirect to if validation fails.

 from  FormRequest
protected string $redirectAction

The controller action to redirect to if validation fails.

 from  FormRequest
protected string $errorBag

The key to be used for the view error bag.

 from  FormRequest
protected bool $stopOnFirstFailure

Indicates whether validation should stop after the first rule failure.

 from  FormRequest
protected Validator $validator

The validator instance.

 from  FormRequest

Methods

array
filterPrecognitiveRules(array $rules)

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

from  CanBePrecognitive
bool
isAttemptingPrecognition()

Determine if the request is attempting to be precognitive.

from  CanBePrecognitive
bool
isPrecognitive()

Determine if the request is precognitive.

from  CanBePrecognitive
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.

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

Determine if the current request accepts any content type.

from  InteractsWithContentTypes
bool
acceptsJson()

Determines whether a request accepts JSON.

from  InteractsWithContentTypes
bool
acceptsHtml()

Determines whether a request accepts HTML.

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

Determine if the given content types match.

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

Get the data format expected in the response.

from  InteractsWithContentTypes
string|array|null
old(string|null $key = null, Model|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
never
dd(mixed ...$args)

Dump the given arguments and terminate execution.

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

Dump the given arguments.

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

Retrieve all data from the instance.

from  InteractsWithData
mixed
data(string|null $key = null, mixed $default = null)

Retrieve data from the instance.

from  InteractsWithData
bool
exists(string|array $key)

Determine if the data contains a given key.

from  InteractsWithData
bool
has(string|array $key)

Determine if the data contains a given key.

from  InteractsWithData
bool
hasAny(string|array $keys)

Determine if the instance contains any of the given keys.

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

Apply the callback if the instance contains the given key.

from  InteractsWithData
bool
filled(string|array $key)

Determine if the instance contains a non-empty value for the given key.

from  InteractsWithData
bool
isNotFilled(string|array $key)

Determine if the instance contains an empty value for the given key.

from  InteractsWithData
bool
anyFilled(string|array $keys)

Determine if the instance contains a non-empty value for any of the given keys.

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

Apply the callback if the instance contains a non-empty value for the given key.

from  InteractsWithData
bool
missing(string|array $key)

Determine if the instance is missing a given key.

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

Apply the callback if the instance is missing the given key.

from  InteractsWithData
bool
isEmptyString(string $key)

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

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

Retrieve data from the instance as a Stringable instance.

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

Retrieve data from the instance as a Stringable instance.

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

Retrieve data as a boolean value.

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

Retrieve data as an integer value.

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

Retrieve data as a float value.

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

Retrieve data from the instance as a Carbon instance.

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

Retrieve data from the instance as an enum.

from  InteractsWithData
TEnum[]
enums(string $key, TEnum> $enumClass)

Retrieve data from the instance as an array of enums.

from  InteractsWithData
bool
isBackedEnum(class-string $enumClass)

Determine if the given enum class is backed.

from  InteractsWithData
array
array(array|string|null $key = null)

Retrieve data from the instance as an array.

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

Retrieve data from the instance as a collection.

from  InteractsWithData
array
only(array|mixed $keys)

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

from  InteractsWithData
array
except(array|mixed $keys)

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

from  InteractsWithData
string|array|null
server(string|null $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|null
header(string|null $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
array
keys()

Get the keys for all of the input and files.

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

Retrieve an input item from the request.

from  InteractsWithInput
Fluent
fluent(array|string|null $key = null)

Retrieve input from the request as a Fluent object instance.

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

Retrieve a query string item from the request.

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

Retrieve a request payload item from the request.

from  InteractsWithInput
bool
hasCookie(string $key)

Determine if a cookie is set on the request.

from  InteractsWithInput
string|array|null
cookie(string|null $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|UploadedFile[]|array|null
file(string|null $key = null, mixed $default = null)

Retrieve a file from the request.

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

Retrieve a parameter item from a given source.

from  InteractsWithInput
$this|TWhenReturnType
when($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) truthy.

from  Conditionable
$this|TUnlessReturnType
unless($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) falsy.

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

Register a custom macro.

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

Mix another object into the class.

from  Macroable
static bool
hasMacro(string $name)

Checks if macro is registered.

from  Macroable
static void
flushMacros()

Flush the existing macros.

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
Uri
uri()

Get a URI instance for the request.

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
fullUrlWithoutQuery(array|string $keys)

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

from  Request
string
path()

Get the current path info for the request.

from  Request
string
decodedPath()

Get the current decoded 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(mixed ...$patterns)

Determine if the current request URI matches a pattern.

from  Request
bool
routeIs(mixed ...$patterns)

Determine if the route name matches a given pattern.

from  Request
bool
fullUrlIs(mixed ...$patterns)

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

from  Request
string
host()

Get the host name.

from  Request
string
httpHost()

Get the HTTP host being requested.

from  Request
string
schemeAndHttpHost()

Get the scheme and HTTP host.

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

from  Request
bool
prefetch()

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

from  Request
bool
secure()

Determine if the request is over HTTPS.

from  Request
string|null
ip()

Get the client IP address.

from  Request
array
ips()

Get the client IP addresses.

from  Request
string|null
userAgent()

Get the client user agent.

from  Request
$this
merge(array $input)

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

from  Request
$this
mergeIfMissing(array $input)

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

from  Request
$this
replace(array $input)

Replace the input values for the current request.

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

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

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

Get the JSON payload for the request.

from  Request
InputBag
getInputSource()

Get the input source for the request.

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

Create a new request instance from the given Laravel request.

from  Request
static Request
createFromBase(Request $request)

Create an Illuminate request from a Symfony instance.

from  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}

from  Request
mixed
filterFiles(mixed $files)

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

from  Request
bool
hasSession(bool $skipIfUninitialized = false)

{@inheritdoc}

from  Request
SessionInterface
getSession()

{@inheritdoc}

from  Request
Session
session()

Get the session associated with the request.

from  Request
void
setLaravelSession(Session $session)

Set the session instance on the request.

from  Request
void
setRequestLocale(string $locale)

Set the locale for the request instance.

from  Request
void
setDefaultRequestLocale(string $locale)

Set the default locale for the request instance.

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

Get the user making the request.

from  Request
Route|object|string|null
route(string|null $param = null, mixed $default = 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(InputBag $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
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
array
validate(array $rules, mixed $params)

No description

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

No description

from  Request
bool
hasValidSignature(bool $absolute = true)

No description

from  Request
void
validateResolved()

Validate the class instance.

from  ValidatesWhenResolvedTrait
void
prepareForValidation()

Prepare the data for validation.

from  ValidatesWhenResolvedTrait
Validator
getValidatorInstance()

Get the validator instance for the request.

from  ValidatesWhenResolvedTrait
void
passedValidation()

Handle a passed validation attempt.

from  ValidatesWhenResolvedTrait
void
failedValidation(Validator $validator)

Handle a failed validation attempt.

from  ValidatesWhenResolvedTrait
bool
passesAuthorization()

Determine if the request passes the authorization check.

from  ValidatesWhenResolvedTrait
void
failedAuthorization()

Handle a failed authorization attempt.

from  ValidatesWhenResolvedTrait
Validator
createDefaultValidator(Factory $factory)

Create the default validator instance.

from  FormRequest
array
validationData()

Get data to be validated from the request.

from  FormRequest
array
validationRules()

Get the validation rules for this form request.

from  FormRequest
string
getRedirectUrl()

Get the URL to redirect to on a validation error.

from  FormRequest
ValidatedInput|array
safe(array|null $keys = null)

Get a validated input container for the validated input.

from  FormRequest
mixed
validated(array|int|string|null $key = null, mixed $default = null)

Get the validated data from the request.

from  FormRequest
array
messages()

Get custom messages for validator errors.

from  FormRequest
array
attributes()

Get custom attributes for validator errors.

from  FormRequest
$this
setValidator(Validator $validator)

Set the Validator instance.

from  FormRequest
$this
setRedirector(Redirector $redirector)

Set the Redirector instance.

from  FormRequest
$this
setContainer(Container $container)

Set the container implementation.

from  FormRequest
bool
authorize()

Determine if the user is authorized to make this request.

array
rules()

Get the validation rules that apply to the request.

void
fulfill()

Fulfill the email verification request.

Validator
withValidator(Validator $validator)

Configure the validator instance.

Details

in CanBePrecognitive at line 15
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

in CanBePrecognitive at line 31
bool isAttemptingPrecognition()

Determine if the request is attempting to be precognitive.

Return Value

bool

in CanBePrecognitive at line 41
bool isPrecognitive()

Determine if the request is precognitive.

Return Value

bool

in InteractsWithContentTypes at line 14
bool isJson()

Determine if the request is sending JSON.

Return Value

bool

in InteractsWithContentTypes at line 24
bool expectsJson()

Determine if the current request probably expects a JSON response.

Return Value

bool

in InteractsWithContentTypes at line 34
bool wantsJson()

Determine if the current request is asking for JSON.

Return Value

bool

in InteractsWithContentTypes at line 47
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 82
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 116
bool acceptsAnyContentType()

Determine if the current request accepts any content type.

Return Value

bool

in InteractsWithContentTypes at line 130
bool acceptsJson()

Determines whether a request accepts JSON.

Return Value

bool

in InteractsWithContentTypes at line 140
bool acceptsHtml()

Determines whether a request accepts HTML.

Return Value

bool

in InteractsWithContentTypes at line 152
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 169
string format(string $default = 'html')

Get the data format expected in the response.

Parameters

string $default

Return Value

string

in InteractsWithFlashData at line 16
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

in InteractsWithFlashData at line 28
void flash()

Flash the input for the current request to the session.

Return Value

void

in InteractsWithFlashData at line 39
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 52
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 64
void flush()

Flush all of the old input from the session.

Return Value

void

in Dumpable at line 13
never dd(mixed ...$args)

Dump the given arguments and terminate execution.

Parameters

mixed ...$args

Return Value

never

in Dumpable at line 24
$this dump(mixed ...$args)

Dump the given arguments.

Parameters

mixed ...$args

Return Value

$this

in InteractsWithData at line 19
abstract array all(array|mixed|null $keys = null)

Retrieve all data from the instance.

Parameters

array|mixed|null $keys

Return Value

array

in InteractsWithData at line 28
abstract protected mixed data(string|null $key = null, mixed $default = null)

Retrieve data from the instance.

Parameters

string|null $key
mixed $default

Return Value

mixed

in InteractsWithData at line 36
bool exists(string|array $key)

Determine if the data contains a given key.

Parameters

string|array $key

Return Value

bool

in InteractsWithData at line 47
bool has(string|array $key)

Determine if the data contains a given key.

Parameters

string|array $key

Return Value

bool

in InteractsWithData at line 68
bool hasAny(string|array $keys)

Determine if the instance contains any of the given keys.

Parameters

string|array $keys

Return Value

bool

in InteractsWithData at line 85
$this|mixed whenHas(string $key, callable $callback, callable|null $default = null)

Apply the callback if the instance contains the given key.

Parameters

string $key
callable $callback
callable|null $default

Return Value

$this|mixed

in InteractsWithData at line 104
bool filled(string|array $key)

Determine if the instance contains a non-empty value for the given key.

Parameters

string|array $key

Return Value

bool

in InteractsWithData at line 123
bool isNotFilled(string|array $key)

Determine if the instance contains an empty value for the given key.

Parameters

string|array $key

Return Value

bool

in InteractsWithData at line 142
bool anyFilled(string|array $keys)

Determine if the instance contains a non-empty value for any of the given keys.

Parameters

string|array $keys

Return Value

bool

in InteractsWithData at line 163
$this|mixed whenFilled(string $key, callable $callback, callable|null $default = null)

Apply the callback if the instance contains a non-empty value for the given key.

Parameters

string $key
callable $callback
callable|null $default

Return Value

$this|mixed

in InteractsWithData at line 182
bool missing(string|array $key)

Determine if the instance is missing a given key.

Parameters

string|array $key

Return Value

bool

in InteractsWithData at line 197
$this|mixed whenMissing(string $key, callable $callback, callable|null $default = null)

Apply the callback if the instance is missing the given key.

Parameters

string $key
callable $callback
callable|null $default

Return Value

$this|mixed

in InteractsWithData at line 216
protected bool isEmptyString(string $key)

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

Parameters

string $key

Return Value

bool

in InteractsWithData at line 230
Stringable str(string $key, mixed $default = null)

Retrieve data from the instance as a Stringable instance.

Parameters

string $key
mixed $default

Return Value

Stringable

in InteractsWithData at line 242
Stringable string(string $key, mixed $default = null)

Retrieve data from the instance as a Stringable instance.

Parameters

string $key
mixed $default

Return Value

Stringable

in InteractsWithData at line 256
bool boolean(string|null $key = null, bool $default = false)

Retrieve data 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

in InteractsWithData at line 268
int integer(string $key, int $default = 0)

Retrieve data as an integer value.

Parameters

string $key
int $default

Return Value

int

in InteractsWithData at line 280
float float(string $key, float $default = 0.0)

Retrieve data as a float value.

Parameters

string $key
float $default

Return Value

float

in InteractsWithData at line 295
Carbon|null date(string $key, string|null $format = null, string|null $tz = null)

Retrieve data from the instance as a Carbon instance.

Parameters

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

Return Value

Carbon|null

Exceptions

InvalidFormatException

in InteractsWithData at line 317
TEnum|null enum(string $key, TEnum> $enumClass)

Retrieve data from the instance as an enum.

Parameters

string $key
TEnum> $enumClass

Return Value

TEnum|null

in InteractsWithData at line 335
TEnum[] enums(string $key, TEnum> $enumClass)

Retrieve data from the instance as an array of enums.

Parameters

string $key
TEnum> $enumClass

Return Value

TEnum[]

in InteractsWithData at line 353
protected bool isBackedEnum(class-string $enumClass)

Determine if the given enum class is backed.

Parameters

class-string $enumClass

Return Value

bool

in InteractsWithData at line 364
array array(array|string|null $key = null)

Retrieve data from the instance as an array.

Parameters

array|string|null $key

Return Value

array

in InteractsWithData at line 375
Collection collect(array|string|null $key = null)

Retrieve data from the instance as a collection.

Parameters

array|string|null $key

Return Value

Collection

in InteractsWithData at line 386
array only(array|mixed $keys)

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

Parameters

array|mixed $keys

Return Value

array

in InteractsWithData at line 411
array except(array|mixed $keys)

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

Parameters

array|mixed $keys

Return Value

array

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

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

Determine if a header is set on the request.

Parameters

string $key

Return Value

bool

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

in InteractsWithInput at line 57
string|null bearerToken()

Get the bearer token from the request headers.

Return Value

string|null

in InteractsWithInput at line 75
array keys()

Get the keys for all of the input and files.

Return Value

array

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

in InteractsWithInput at line 123
Fluent fluent(array|string|null $key = null)

Retrieve input from the request as a Fluent object instance.

Parameters

array|string|null $key

Return Value

Fluent

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

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

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

in InteractsWithInput at line 180
array allFiles()

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

Return Value

array

in InteractsWithInput at line 193
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 212
bool hasFile(string $key)

Determine if the uploaded data contains a file.

Parameters

string $key

Return Value

bool

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

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

in Conditionable at line 21
$this|TWhenReturnType when($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) truthy.

Parameters

$value
callable|null $callback
callable|null $default

Return Value

$this|TWhenReturnType

in Conditionable at line 53
$this|TUnlessReturnType unless($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) falsy.

Parameters

$value
callable|null $callback
callable|null $default

Return Value

$this|TUnlessReturnType

in Macroable at line 29
static void macro(string $name, object|callable $macro)

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

in Macroable at line 43
static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

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

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 72
static void flushMacros()

Flush the existing macros.

Return Value

void

in Macroable at line 86
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 112
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 68
static Request capture()

Create a new Illuminate HTTP request from server variables.

Return Value

Request

in Request at line 80
$this instance()

Return the Request instance.

Return Value

$this

in Request at line 90
string method()

Get the request method.

Return Value

string

in Request at line 100
Uri uri()

Get a URI instance for the request.

Return Value

Uri

in Request at line 110
string root()

Get the root URL for the application.

Return Value

string

in Request at line 120
string url()

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

Return Value

string

in Request at line 130
string fullUrl()

Get the full URL for the request.

Return Value

string

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

in Request at line 176
string path()

Get the current path info for the request.

Return Value

string

in Request at line 188
string decodedPath()

Get the current decoded path info for the request.

Return Value

string

in Request at line 200
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 210
array segments()

Get all of the segments for the request path.

Return Value

array

in Request at line 225
bool is(mixed ...$patterns)

Determine if the current request URI matches a pattern.

Parameters

mixed ...$patterns

Return Value

bool

in Request at line 237
bool routeIs(mixed ...$patterns)

Determine if the route name matches a given pattern.

Parameters

mixed ...$patterns

Return Value

bool

in Request at line 248
bool fullUrlIs(mixed ...$patterns)

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

Parameters

mixed ...$patterns

Return Value

bool

in Request at line 259
string host()

Get the host name.

Return Value

string

in Request at line 269
string httpHost()

Get the HTTP host being requested.

Return Value

string

in Request at line 279
string schemeAndHttpHost()

Get the scheme and HTTP host.

Return Value

string

in Request at line 289
bool ajax()

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

Return Value

bool

in Request at line 299
bool pjax()

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

Return Value

bool

in Request at line 309
bool prefetch()

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

Return Value

bool

in Request at line 321
bool secure()

Determine if the request is over HTTPS.

Return Value

bool

in Request at line 331
string|null ip()

Get the client IP address.

Return Value

string|null

in Request at line 341
array ips()

Get the client IP addresses.

Return Value

array

in Request at line 351
string|null userAgent()

Get the client user agent.

Return Value

string|null

in Request at line 362
$this merge(array $input)

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

Parameters

array $input

Return Value

$this

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

in Request at line 393
$this replace(array $input)

Replace the input values for the current request.

Parameters

array $input

Return Value

$this

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

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

in Request at line 440
protected InputBag getInputSource()

Get the input source for the request.

Return Value

InputBag

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

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

Create an Illuminate request from a Symfony instance.

Parameters

Request $request

Return Value

Request

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

in Request at line 532
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 554
bool hasSession(bool $skipIfUninitialized = false)

{@inheritdoc}

Parameters

bool $skipIfUninitialized

Return Value

bool

in Request at line 563
SessionInterface getSession()

{@inheritdoc}

Return Value

SessionInterface

in Request at line 578
Session session()

Get the session associated with the request.

Return Value

Session

Exceptions

RuntimeException

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

Set the session instance on the request.

Parameters

Session $session

Return Value

void

in Request at line 604
void setRequestLocale(string $locale)

Set the locale for the request instance.

Parameters

string $locale

Return Value

void

in Request at line 615
void setDefaultRequestLocale(string $locale)

Set the default locale for the request instance.

Parameters

string $locale

Return Value

void

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

Get the user making the request.

Parameters

string|null $guard

Return Value

mixed

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

in Request at line 656
string fingerprint()

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

Return Value

string

Exceptions

RuntimeException

in Request at line 674
$this setJson(InputBag $json)

Set the JSON payload for the request.

Parameters

InputBag $json

Return Value

$this

in Request at line 686
Closure getUserResolver()

Get the user resolver callback.

Return Value

Closure

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

Set the user resolver callback.

Parameters

Closure $callback

Return Value

$this

in Request at line 711
Closure getRouteResolver()

Get the route resolver callback.

Return Value

Closure

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

Set the route resolver callback.

Parameters

Closure $callback

Return Value

$this

in Request at line 736
toArray()

Get all of the input and files for the request.

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

Determine if the given offset exists.

Parameters

string $offset

Return Value

bool

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

Get the value at the given offset.

Parameters

string $offset

Return Value

mixed

in Request at line 775
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 786
void offsetUnset(string $offset)

Remove the value at the given offset.

Parameters

string $offset

Return Value

void

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

Check if an input element is set on the request.

Parameters

string $key

Return Value

bool

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

Get an input element from the request.

Parameters

string $key

Return Value

mixed

in Request at line 26
array validate(array $rules, mixed $params)

No description

Parameters

array $rules
mixed $params

Return Value

array

in Request at line 26
array validateWithBag(string $errorBag, array $rules, mixed $params)

No description

Parameters

string $errorBag
array $rules
mixed $params

Return Value

array

in Request at line 26
bool hasValidSignature(bool $absolute = true)

No description

Parameters

bool $absolute

Return Value

bool

in ValidatesWhenResolvedTrait at line 17
void validateResolved()

Validate the class instance.

Return Value

void

in ValidatesWhenResolvedTrait at line 43
protected void prepareForValidation()

Prepare the data for validation.

Return Value

void

in ValidatesWhenResolvedTrait at line 53
protected Validator getValidatorInstance()

Get the validator instance for the request.

Return Value

Validator

in ValidatesWhenResolvedTrait at line 63
protected void passedValidation()

Handle a passed validation attempt.

Return Value

void

in ValidatesWhenResolvedTrait at line 76
protected void failedValidation(Validator $validator)

Handle a failed validation attempt.

Parameters

Validator $validator

Return Value

void

Exceptions

ValidationException

in ValidatesWhenResolvedTrait at line 88
protected bool passesAuthorization()

Determine if the request passes the authorization check.

Return Value

bool

in ValidatesWhenResolvedTrait at line 104
protected void failedAuthorization()

Handle a failed authorization attempt.

Return Value

void

Exceptions

UnauthorizedException

in FormRequest at line 116
protected Validator createDefaultValidator(Factory $factory)

Create the default validator instance.

Parameters

Factory $factory

Return Value

Validator

in FormRequest at line 141
array validationData()

Get data to be validated from the request.

Return Value

array

in FormRequest at line 151
protected array validationRules()

Get the validation rules for this form request.

Return Value

array

in FormRequest at line 178
protected string getRedirectUrl()

Get the URL to redirect to on a validation error.

Return Value

string

in FormRequest at line 229
ValidatedInput|array safe(array|null $keys = null)

Get a validated input container for the validated input.

Parameters

array|null $keys

Return Value

ValidatedInput|array

in FormRequest at line 243
mixed validated(array|int|string|null $key = null, mixed $default = null)

Get the validated data from the request.

Parameters

array|int|string|null $key
mixed $default

Return Value

mixed

in FormRequest at line 253
array messages()

Get custom messages for validator errors.

Return Value

array

in FormRequest at line 263
array attributes()

Get custom attributes for validator errors.

Return Value

array

in FormRequest at line 274
$this setValidator(Validator $validator)

Set the Validator instance.

Parameters

Validator $validator

Return Value

$this

in FormRequest at line 287
$this setRedirector(Redirector $redirector)

Set the Redirector instance.

Parameters

Redirector $redirector

Return Value

$this

in FormRequest at line 300
$this setContainer(Container $container)

Set the container implementation.

Parameters

Container $container

Return Value

$this

at line 16
bool authorize()

Determine if the user is authorized to make this request.

Return Value

bool

at line 34
array rules()

Get the validation rules that apply to the request.

Return Value

array

at line 46
void fulfill()

Fulfill the email verification request.

Return Value

void

at line 61
Validator withValidator(Validator $validator)

Configure the validator instance.

Parameters

Validator $validator

Return Value

Validator