ValidatedInput
class ValidatedInput implements ValidatedData (View source)
Properties
protected array | $input | The underlying input. |
Methods
Create a new validated input container.
Determine if the validated input has one or more keys.
Determine if the validated input has one or more keys.
Determine if the validated input contains any of the given keys.
Determine if the validated input is missing one or more keys.
Apply the callback if the validated input is missing the given input item key.
Retrieve input from the validated input as a Stringable instance.
Retrieve input from the validated input as a Stringable instance.
Get a subset containing the provided keys with values from the input data.
Get all of the input except for a specified array of items.
Merge the validated input with the given array of additional data.
Get the input as a collection.
Get the raw, underlying input array.
Apply the callback if the validated inputs contains the given input item key.
Determine if the validated inputs contains a non-empty value for an input item.
Determine if the validated inputs contains an empty value for an input item.
Determine if the validated inputs contains a non-empty value for any of the given inputs.
Apply the callback if the validated inputs contains a non-empty value for the given input item key.
Determine if the given input key is an empty string for "filled".
Get the keys for all of the input.
Retrieve an input item from the validated inputs.
Retrieve input as a boolean value.
Retrieve input as an integer value.
Retrieve input as a float value.
Retrieve input from the validated inputs as a Carbon instance.
Retrieve input from the validated inputs as an enum.
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
void
__construct(array $input)
Create a new validated input container.
bool
exists(string|array $key)
Determine if the validated input has one or more keys.
bool
has(mixed $keys)
Determine if the validated input has one or more keys.
bool
hasAny(string|array $keys)
Determine if the validated input contains any of the given keys.
bool
missing(mixed $keys)
Determine if the validated input is missing one or more keys.
$this|mixed
whenMissing(string $key, callable $callback, callable|null $default = null)
Apply the callback if the validated input is missing the given input item key.
Stringable
str(string $key, mixed $default = null)
Retrieve input from the validated input as a Stringable instance.
Stringable
string(string $key, mixed $default = null)
Retrieve input from the validated input as a Stringable instance.
array
only(mixed $keys)
Get a subset containing the provided keys with values from the input data.
array
except(mixed $keys)
Get all of the input except for a specified array of items.
ValidatedInput
merge(array $items)
Merge the validated input with the given array of additional data.
Collection
collect(array|string|null $key = null)
Get the input as a collection.
array
all()
Get the raw, underlying input array.
$this|mixed
whenHas(string $key, callable $callback, callable|null $default = null)
Apply the callback if the validated inputs contains the given input item key.
bool
filled(string|array $key)
Determine if the validated inputs contains a non-empty value for an input item.
bool
isNotFilled(string|array $key)
Determine if the validated inputs contains an empty value for an input item.
bool
anyFilled(string|array $keys)
Determine if the validated inputs contains a non-empty value for any of the given inputs.
$this|mixed
whenFilled(string $key, callable $callback, callable|null $default = null)
Apply the callback if the validated inputs contains a non-empty value for the given input item key.
protected bool
isEmptyString(string $key)
Determine if the given input key is an empty string for "filled".
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.
bool
boolean(string|null $key = null, bool $default = false)
Retrieve input 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 input as an integer value.
float
float(string $key, float $default = 0.0)
Retrieve input as a float value.
Carbon|null
date(string $key, string|null $format = null, string|null $tz = null)
Retrieve input from the validated inputs as a Carbon instance.
TEnum|null
enum(string $key, TEnum> $enumClass)
Retrieve input from the validated inputs as an enum.
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.