| Methods |
abstract
public
|
all(array|mixed|null $keys = null): array
Retrieve all data from the instance.
Retrieve all data from the instance.
|
#
|
abstract
protected
|
data(string|null $key = null, mixed $default = null): mixed
Retrieve data from the instance.
Retrieve data from the instance.
|
#
|
public
|
exists(string|array $key): bool
Determine if the data contains a given key.
Determine if the data contains a given key.
|
#
|
public
|
has(string|array $key): bool
Determine if the data contains a given key.
Determine if the data contains a given key.
|
#
|
public
|
hasAny(string|array $keys): bool
Determine if the instance contains any of the given keys.
Determine if the instance contains any of the given keys.
|
#
|
public
|
whenHas(string $key, callable $callback, callable|null $default = null): $this|mixed
Apply the callback if the instance contains the given key.
Apply the callback if the instance contains the given key.
|
#
|
public
|
filled(string|array $key): bool
Determine if the instance contains a non-empty value for the given key.
Determine if the instance contains a non-empty value for the given key.
|
#
|
public
|
isNotFilled(string|array $key): bool
Determine if the instance contains an empty value for the given key.
Determine if the instance contains an empty value for the given key.
|
#
|
public
|
anyFilled(string|array $keys): bool
Determine if the instance contains a non-empty value for any of the given keys.
Determine if the instance contains a non-empty value for any of the given keys.
|
#
|
public
|
whenFilled(string $key, callable $callback, callable|null $default = null): $this|mixed
Apply the callback if the instance contains a non-empty value for the given key.
Apply the callback if the instance contains a non-empty value for the given key.
|
#
|
public
|
missing(string|array $key): bool
Determine if the instance is missing a given key.
Determine if the instance is missing a given key.
|
#
|
public
|
whenMissing(string $key, callable $callback, callable|null $default = null): $this|mixed
Apply the callback if the instance is missing the given key.
Apply the callback if the instance is missing the given key.
|
#
|
protected
|
isEmptyString(string $key): bool
Determine if the given key is an empty string for "filled".
Determine if the given key is an empty string for "filled".
|
#
|
public
|
str(string $key, mixed $default = null): Stringable
Retrieve data from the instance as a Stringable instance.
Retrieve data from the instance as a Stringable instance.
|
#
|
public
|
string(string $key, mixed $default = null): Stringable
Retrieve data from the instance as a Stringable instance.
Retrieve data from the instance as a Stringable instance.
|
#
|
public
|
boolean(string|null $key = null, bool $default = false): bool
Retrieve data as a boolean value.
Retrieve data as a boolean value.
Returns true when value is "1", "true", "on", and "yes". Otherwise, returns false.
|
#
|
public
|
integer(string $key, int $default = 0): int
Retrieve data as an integer value.
Retrieve data as an integer value.
|
#
|
public
|
float(string $key, float $default = 0.0): float
Retrieve data as a float value.
Retrieve data as a float value.
|
#
|
public
|
date(string $key, string|null $format = null, string|null $tz = null): Carbon|null
Retrieve data from the instance as a Carbon instance.
Retrieve data from the instance as a Carbon instance.
Throws
|
#
|
public
|
enum<TEnum is BackedEnum>(string $key, class-string<TEnum> $enumClass): TEnum|null
Retrieve data from the instance as an enum.
Retrieve data from the instance as an enum.
|
#
|
public
|
enums<TEnum is BackedEnum>(string $key, class-string<TEnum> $enumClass): TEnum[]
Retrieve data from the instance as an array of enums.
Retrieve data from the instance as an array of enums.
|
#
|
protected
|
isBackedEnum(class-string $enumClass): bool
Determine if the given enum class is backed.
Determine if the given enum class is backed.
|
#
|
public
|
array(array|string|null $key = null): array
Retrieve data from the instance as an array.
Retrieve data from the instance as an array.
|
#
|
public
|
collect(array|string|null $key = null): Collection
Retrieve data from the instance as a collection.
Retrieve data from the instance as a collection.
|
#
|
public
|
only(array|mixed $keys): array
Get a subset containing the provided keys with values from the instance data.
Get a subset containing the provided keys with values from the instance data.
|
#
|
public
|
except(array|mixed $keys): array
Get all of the data except for a specified array of items.
Get all of the data except for a specified array of items.
|
#
|