class ValidatedInput implements ValidatedData (View source)

Traits

Properties

protected array $input

The underlying input.

Methods

never
dd(mixed ...$args)

Dump the given arguments and terminate execution.

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

Dump the items.

array
all(mixed $keys = null)

Get the raw, underlying input array.

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

Retrieve data from the instance.

bool
exists(string|array $key)

Determine if the data contains a given key.

bool
has(string|array $key)

Determine if the data contains a given key.

bool
hasAny(string|array $keys)

Determine if the instance contains any of the given keys.

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

Apply the callback if the instance contains the given key.

bool
filled(string|array $key)

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

bool
isNotFilled(string|array $key)

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

bool
anyFilled(string|array $keys)

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

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

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

$this|TReturn|TReturnDefault
whenEnum(string $key, string $enumClass, callable $callback, callable|null $default = null)

Apply the callback if the instance contains a valid enum value for the given key.

bool
missing(string|array $key)

Determine if the instance is missing a given key.

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

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

bool
isEmptyString(string $key)

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

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

Retrieve data from the instance as a Stringable instance.

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

Retrieve data from the instance as a Stringable instance.

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

Retrieve data as a boolean value.

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

Retrieve data as an integer value.

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

Retrieve data as a float value.

float|int
clamp(string $key, int|float $min, int|float $max, int|float $default = 0)

Retrieve data clamped between min and max values.

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

Retrieve data from the instance as a Carbon instance.

CarbonInterval|null
interval(string $key, Unit|string|null $unit = null)

Retrieve data from the instance as a CarbonInterval instance.

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

Retrieve data from the instance as an enum.

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

Retrieve data from the instance as an array of enums.

bool
isBackedEnum(class-string $enumClass)

Determine if the given enum class is backed.

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

Retrieve data from the instance as an array.

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

Retrieve data from the instance as a collection.

array
only(mixed $keys)

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

array
except(mixed $keys)

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

__construct(array $input)

Create a new validated input container.

merge(array $items)

Merge the validated input with the given array of additional data.

array
keys()

Get the keys for all of the input.

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

Retrieve an input item from the validated inputs.

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

Retrieve a file from the validated inputs.

TReturn
toArray()

Get the instance as an array.

mixed
__get(string $name)

Dynamically access input data.

mixed
__set(string $name, mixed $value)

Dynamically set input data.

bool
__isset(string $name)

Determine if an input item is set.

void
__unset(string $name)

Remove an input item.

bool
offsetExists(mixed $offset)

Determine if an item exists at an offset.

mixed
offsetGet(mixed $offset)

Get an item at a given offset.

void
offsetSet(mixed $offset, mixed $value)

Set the item at a given offset.

void
offsetUnset(string $offset)

Unset the item at a given offset.

getIterator()

Get an iterator for the input.

Details

never dd(mixed ...$args)

Dump the given arguments and terminate execution.

Parameters

mixed ...$args

Return Value

never

$this dump(mixed ...$keys)

Dump the items.

Parameters

mixed ...$keys

Return Value

$this

array all(mixed $keys = null)

Get the raw, underlying input array.

Parameters

mixed $keys

Return Value

array

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

Retrieve data from the instance.

Parameters

string|null $key
mixed $default

Return Value

mixed

bool exists(string|array $key)

Determine if the data contains a given key.

Parameters

string|array $key

Return Value

bool

bool has(string|array $key)

Determine if the data contains a given key.

Parameters

string|array $key

Return Value

bool

bool hasAny(string|array $keys)

Determine if the instance contains any of the given keys.

Parameters

string|array $keys

Return Value

bool

$this|TReturn|TReturnDefault 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|TReturn|TReturnDefault

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

bool isNotFilled(string|array $key)

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

Parameters

string|array $key

Return Value

bool

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

$this|TReturn|TReturnDefault 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|TReturn|TReturnDefault

$this|TReturn|TReturnDefault whenEnum(string $key, string $enumClass, callable $callback, callable|null $default = null)

Apply the callback if the instance contains a valid enum value for the given key.

Parameters

string $key
string $enumClass
callable $callback
callable|null $default

Return Value

$this|TReturn|TReturnDefault

bool missing(string|array $key)

Determine if the instance is missing a given key.

Parameters

string|array $key

Return Value

bool

$this|TReturn|TReturnDefault 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|TReturn|TReturnDefault

protected bool isEmptyString(string $key)

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

Parameters

string $key

Return Value

bool

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

Retrieve data from the instance as a Stringable instance.

Parameters

string $key
mixed $default

Return Value

Stringable

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

Retrieve data from the instance as a Stringable instance.

Parameters

string $key
mixed $default

Return Value

Stringable

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

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

Retrieve data as an integer value.

Parameters

string $key
int $default

Return Value

int

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

Retrieve data as a float value.

Parameters

string $key
float $default

Return Value

float

float|int clamp(string $key, int|float $min, int|float $max, int|float $default = 0)

Retrieve data clamped between min and max values.

Parameters

string $key
int|float $min
int|float $max
int|float $default

Return Value

float|int

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

Retrieve data from the instance as a Carbon instance.

Parameters

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

Return Value

Carbon|null

Exceptions

InvalidFormatException

CarbonInterval|null interval(string $key, Unit|string|null $unit = null)

Retrieve data from the instance as a CarbonInterval instance.

Parameters

string $key
Unit|string|null $unit

Return Value

CarbonInterval|null

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

Retrieve data from the instance as an enum.

Parameters

string $key
TEnum> $enumClass
TDefault $default

Return Value

TEnum|TDefault

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

Retrieve data from the instance as an array of enums.

Parameters

string $key
TEnum> $enumClass

Return Value

TEnum[]

protected bool isBackedEnum(class-string $enumClass)

Determine if the given enum class is backed.

Parameters

class-string $enumClass

Return Value

bool

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

Retrieve data from the instance as an array.

Parameters

array|string|null $key

Return Value

array

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

Retrieve data from the instance as a collection.

Parameters

array|string|null $key

Return Value

Collection

array only(mixed $keys)

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

Parameters

mixed $keys

Return Value

array

array except(mixed $keys)

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

Parameters

mixed $keys

Return Value

array

__construct(array $input)

Create a new validated input container.

Parameters

array $input

ValidatedInput merge(array $items)

Merge the validated input with the given array of additional data.

Parameters

array $items

Return Value

ValidatedInput

array keys()

Get the keys for all of the input.

Return Value

array

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

Retrieve an input item from the validated inputs.

Parameters

string|null $key
mixed $default

Return Value

mixed

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

Retrieve a file from the validated inputs.

Parameters

string $key
mixed $default

Return Value

UploadedFile|null

TReturn toArray()

Get the instance as an array.

Return Value

TReturn

mixed __get(string $name)

Dynamically access input data.

Parameters

string $name

Return Value

mixed

mixed __set(string $name, mixed $value)

Dynamically set input data.

Parameters

string $name
mixed $value

Return Value

mixed

bool __isset(string $name)

Determine if an input item is set.

Parameters

string $name

Return Value

bool

void __unset(string $name)

Remove an input item.

Parameters

string $name

Return Value

void

bool offsetExists(mixed $offset)

Determine if an item exists at an offset.

Parameters

mixed $offset

Return Value

bool

mixed offsetGet(mixed $offset)

Get an item at a given offset.

Parameters

mixed $offset

Return Value

mixed

void offsetSet(mixed $offset, mixed $value)

Set the item at a given offset.

Parameters

mixed $offset
mixed $value

Return Value

void

void offsetUnset(string $offset)

Unset the item at a given offset.

Parameters

string $offset

Return Value

void

Traversable getIterator()

Get an iterator for the input.

Return Value

Traversable

Laravel Cloud is the best place to deploy Laravel, Nuxt, Express, Hono, Node.js, Bun, Go, Flask, Python, and more, with dedicated infrastructure available on AWS through Laravel Private Cloud.