ValidatedInput
class ValidatedInput implements ValidatedData (View source)
Traits
Properties
| protected array | $input | The underlying input. |
Methods
Get the raw, underlying input array.
Retrieve data from the instance.
Determine if the instance contains any of the given keys.
Apply the callback if the instance contains the given key.
Determine if the instance contains a non-empty value for the given key.
Determine if the instance contains an empty value for the given key.
Determine if the instance contains a non-empty value for any of the given keys.
Apply the callback if the instance contains a non-empty value for the given key.
Determine if the instance is missing a given key.
Apply the callback if the instance is missing the given key.
Determine if the given key is an empty string for "filled".
Retrieve data from the instance as a Stringable instance.
Retrieve data from the instance as a Stringable instance.
Retrieve data as a boolean value.
Retrieve data as an integer value.
Retrieve data as a float value.
Retrieve data from the instance as a Carbon instance.
Retrieve data from the instance as an enum.
Retrieve data from the instance as an array of enums.
Determine if the given enum class is backed.
Retrieve data from the instance as an array.
Retrieve data from the instance as a collection.
Get a subset containing the provided keys with values from the instance data.
Get all of the data except for a specified array of items.
Create a new validated input container.
Merge the validated input with the given array of additional data.
Get the keys for all of the input.
Retrieve an input item from the validated inputs.
Dump the validated inputs items and end the script.
Dump the items.
Get the instance as an array.
Dynamically access input data.
Dynamically set input data.
Determine if an input item is set.
Remove an input item.
Determine if an item exists at an offset.
Get an item at a given offset.
Set the item at a given offset.
Unset the item at a given offset.
Get an iterator for the input.
Details
array
all(mixed $keys = null)
Get the raw, underlying input array.
protected 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|mixed
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|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.
bool
missing(string|array $key)
Determine if the instance is missing a given key.
$this|mixed
whenMissing(string $key, callable $callback, callable|null $default = null)
Apply the callback if the instance is missing the given key.
protected bool
isEmptyString(string $key)
Determine if the given key is an empty string for "filled".
Stringable
str(string $key, mixed $default = null)
Retrieve data from the instance as a Stringable instance.
Stringable
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.
Returns true when value is "1", "true", "on", and "yes". Otherwise, returns false.
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.
Carbon|null
date(string $key, string|null $format = null, UnitEnum|string|null $tz = null)
Retrieve data from the instance as a Carbon instance.
TEnum|null
enum(string $key, TEnum> $enumClass, TEnum|null $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.
protected 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.
Collection
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.
ValidatedInput
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.
never
dd(mixed ...$keys)
Dump the validated inputs items and end the script.
$this
dump(mixed $keys = [])
Dump the items.
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($name)
Determine if an input item is set.
void
__unset(string $name)
Remove an input item.
bool
offsetExists(mixed $key)
Determine if an item exists at an offset.
mixed
offsetGet(mixed $key)
Get an item at a given offset.
void
offsetSet(mixed $key, mixed $value)
Set the item at a given offset.
void
offsetUnset(string $key)
Unset the item at a given offset.
Traversable
getIterator()
Get an iterator for the input.