class ValidatedInput implements ValidatedData (View source)

Properties

protected array $input

The underlying input.

Methods

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 $default = null)

Apply the callback if the validated input is missing the given input item key.

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

Retrieve input from the validated input as a Stringable instance.

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.

merge(array $items)

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

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 $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 $default = null)

Apply the callback if the validated inputs contains a non-empty value for the given input item key.

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.

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.

getIterator()

Get an iterator for the input.

Details

void __construct(array $input)

Create a new validated input container.

Parameters

array $input

Return Value

void

bool exists(string|array $key)

Determine if the validated input has one or more keys.

Parameters

string|array $key

Return Value

bool

bool has(mixed $keys)

Determine if the validated input has one or more keys.

Parameters

mixed $keys

Return Value

bool

bool hasAny(string|array $keys)

Determine if the validated input contains any of the given keys.

Parameters

string|array $keys

Return Value

bool

bool missing(mixed $keys)

Determine if the validated input is missing one or more keys.

Parameters

mixed $keys

Return Value

bool

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

Apply the callback if the validated input is missing the given input item key.

Parameters

string $key
callable $callback
callable $default

Return Value

$this|mixed

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

Retrieve input from the validated input as a Stringable instance.

Parameters

string $key
mixed $default

Return Value

Stringable

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

Retrieve input from the validated input as a Stringable instance.

Parameters

string $key
mixed $default

Return Value

Stringable

array only(mixed $keys)

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

Parameters

mixed $keys

Return Value

array

array except(mixed $keys)

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

Parameters

mixed $keys

Return Value

array

ValidatedInput merge(array $items)

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

Parameters

array $items

Return Value

ValidatedInput

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

Get the input as a collection.

Parameters

array|string|null $key

Return Value

Collection

array all()

Get the raw, underlying input array.

Return Value

array

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

Apply the callback if the validated inputs contains the given input item key.

Parameters

string $key
callable $callback
callable $default

Return Value

$this|mixed

bool filled(string|array $key)

Determine if the validated inputs contains a non-empty value for an input item.

Parameters

string|array $key

Return Value

bool

bool isNotFilled(string|array $key)

Determine if the validated inputs contains an empty value for an input item.

Parameters

string|array $key

Return Value

bool

bool anyFilled(string|array $keys)

Determine if the validated inputs contains a non-empty value for any of the given inputs.

Parameters

string|array $keys

Return Value

bool

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

Apply the callback if the validated inputs contains a non-empty value for the given input item key.

Parameters

string $key
callable $callback
callable $default

Return Value

$this|mixed

protected bool isEmptyString(string $key)

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

Parameters

string $key

Return Value

bool

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

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.

Parameters

string|null $key
bool $default

Return Value

bool

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

Retrieve input as an integer value.

Parameters

string $key
int $default

Return Value

int

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

Retrieve input as a float value.

Parameters

string $key
float $default

Return Value

float

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

Retrieve input from the validated inputs as a Carbon instance.

Parameters

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

Return Value

Carbon|null

Exceptions

InvalidFormatException

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

Retrieve input from the validated inputs as an enum.

Parameters

string $key
TEnum> $enumClass

Return Value

TEnum|null

never dd(mixed ...$keys)

Dump the validated inputs items and end the script.

Parameters

mixed ...$keys

Return Value

never

$this dump(mixed $keys = [])

Dump the items.

Parameters

mixed $keys

Return Value

$this

toArray()

Get the instance as an array.

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($name)

Determine if an input item is set.

Parameters

$name

Return Value

bool

void __unset(string $name)

Remove an input item.

Parameters

string $name

Return Value

void

bool offsetExists(mixed $key)

Determine if an item exists at an offset.

Parameters

mixed $key

Return Value

bool

mixed offsetGet(mixed $key)

Get an item at a given offset.

Parameters

mixed $key

Return Value

mixed

void offsetSet(mixed $key, mixed $value)

Set the item at a given offset.

Parameters

mixed $key
mixed $value

Return Value

void

void offsetUnset(string $key)

Unset the item at a given offset.

Parameters

string $key

Return Value

void

Traversable getIterator()

Get an iterator for the input.

Return Value

Traversable