1. trait
  2. Illuminate
  3. \
  4. Support
  5. \
  6. Traits
  7. \
  8. EnumeratesValues

EnumeratesValues

trait EnumeratesValues (View source)

Traits

Conditionable

Properties

protected bool $escapeWhenCastingToString

Indicates that the object's string representation should be escaped when __toString is invoked.
static protected array<int,string> $proxies

The methods that can be proxied.
TValue> read-only $average
TValue> read-only $avg
TValue> read-only $contains
TValue> read-only $doesntContain
TValue> read-only $each
TValue> read-only $every
TValue> read-only $filter
TValue> read-only $first
TValue> read-only $flatMap
TValue> read-only $groupBy
TValue> read-only $keyBy
TValue> read-only $last
TValue> read-only $map
TValue> read-only $max
TValue> read-only $min
TValue> read-only $partition
TValue> read-only $percentage
TValue> read-only $reject
TValue> read-only $skipUntil
TValue> read-only $skipWhile
TValue> read-only $some
TValue> read-only $sortBy
TValue> read-only $sortByDesc
TValue> read-only $sum
TValue> read-only $takeUntil
TValue> read-only $takeWhile
TValue> read-only $unique
TValue> read-only $unless
TValue> read-only $until
TValue> read-only $when

Methods

$this|TWhenReturnType
when($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) truthy.

from  Conditionable
$this|TUnlessReturnType
unless($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) falsy.

from  Conditionable
static 
make($items = [])

No description

static 
wrap($value)

No description

static 
unwrap($value)

No description

static EnumeratesValues
empty()

Create a new instance with no items.

static 
times($number, callable|null $callback = null)

No description

float|int|null
avg($callback = null)

Get the average value of a given key.

float|int|null
average($callback = null)

Alias for the "avg" method.

bool
some($key, mixed $operator = null, mixed $value = null)

Alias for the "contains" method.

never
dd(mixed ...$args)

Dump the given arguments and terminate execution.

$this
dump(mixed ...$args)

Dump the items.

$this
each(callable $callback)

Execute a callback over each item.

EnumeratesValues
eachSpread(callable $callback)

Execute a callback over each nested chunk of items.

bool
every($key, mixed $operator = null, mixed $value = null)

Determine if all items pass the given truth test.

TValue|null
firstWhere(callable|string $key, mixed $operator = null, mixed $value = null)

Get the first item by the given key value pair.

value($key, $default = null)

No description

ensure($type)

No description

bool
isNotEmpty()

Determine if the collection is not empty.

mapSpread(callable $callback)

No description

mapToGroups(callable $callback)

No description

flatMap(callable $callback)

No description

mapInto($class)

No description

mixed
min($callback = null)

Get the min value of a given key.

mixed
max($callback = null)

Get the max value of a given key.

EnumeratesValues
forPage(int $page, int $perPage)

"Paginate" the collection by slicing it into a smaller collection.

partition($key, $operator = null, $value = null)

No description

float|null
percentage(callable $callback, int $precision = 2)

Calculate the percentage of items that pass a given truth test.

sum($callback = null)

Get the sum of the given values.

$this|TWhenEmptyReturnType
whenEmpty(callable $callback, callable|null $default = null)

Apply the callback if the collection is empty.

$this|TWhenNotEmptyReturnType
whenNotEmpty(callable $callback, callable|null $default = null)

Apply the callback if the collection is not empty.

$this|TUnlessEmptyReturnType
unlessEmpty(callable $callback, callable|null $default = null)

Apply the callback unless the collection is empty.

$this|TUnlessNotEmptyReturnType
unlessNotEmpty(callable $callback, callable|null $default = null)

Apply the callback unless the collection is not empty.

EnumeratesValues
where(callable|string $key, mixed $operator = null, mixed $value = null)

Filter items by the given key value pair.

EnumeratesValues
whereNull(string|null $key = null)

Filter items where the value for the given key is null.

EnumeratesValues
whereNotNull(string|null $key = null)

Filter items where the value for the given key is not null.

EnumeratesValues
whereStrict(string $key, mixed $value)

Filter items by the given key value pair using strict comparison.

EnumeratesValues
whereIn(string $key, Arrayable|iterable $values, bool $strict = false)

Filter items by the given key value pair.

EnumeratesValues
whereInStrict(string $key, Arrayable|iterable $values)

Filter items by the given key value pair using strict comparison.

EnumeratesValues
whereBetween(string $key, Arrayable|iterable $values)

Filter items such that the value of the given key is between the given values.

EnumeratesValues
whereNotBetween(string $key, Arrayable|iterable $values)

Filter items such that the value of the given key is not between the given values.

EnumeratesValues
whereNotIn(string $key, Arrayable|iterable $values, bool $strict = false)

Filter items by the given key value pair.

EnumeratesValues
whereNotInStrict(string $key, Arrayable|iterable $values)

Filter items by the given key value pair using strict comparison.

whereInstanceOf($type)

No description

TPipeReturnType
pipe(callable $callback)

Pass the collection to the given callback and return the result.

TPipeIntoValue
pipeInto(TPipeIntoValue> $class)

Pass the collection into a new class.

mixed
pipeThrough(callable[] $callbacks)

Pass the collection through a series of callable pipes and return the result.

TReduceReturnType
reduce(callable $callback, TReduceInitial $initial = null)

Reduce the collection to a single value.

array
reduceSpread(callable $callback, mixed ...$initial)

Reduce the collection to multiple aggregate values.

TReduceWithKeysReturnType
reduceWithKeys(callable $callback, TReduceWithKeysInitial $initial = null)

Reduce an associative collection to a single value.

EnumeratesValues
reject($callback = true)

Create a collection of all elements that do not pass a given truth test.

$this
tap(callable $callback)

Pass the collection to the given callback and then return it.

EnumeratesValues
unique($key = null, bool $strict = false)

Return only unique items from the collection array.

EnumeratesValues
uniqueStrict($key = null)

Return only unique items from the collection array using strict comparison.

TValue>
collect()

Collect the values into a collection.

toArray()

No description

array
jsonSerialize()

No description

string
toJson(int $options = 0)

Get the collection of items as JSON.

CachingIterator
getCachingIterator(int $flags = CachingIterator::CALL_TOSTRING)

Get a CachingIterator instance.

string
__toString()

Convert the collection to its string representation.

$this
escapeWhenCastingToString(bool $escape = true)

Indicate that the model's string representation should be escaped when __toString is invoked.

static void
proxy(string $method)

Add a method to the list of proxied methods.

mixed
__get(string $key)

Dynamically access collection proxies.

getArrayableItems($items)

No description

Closure
operatorForWhere(callable|string $key, string|null $operator = null, mixed $value = null)

Get an operator checker callback.

bool
useAsCallable(mixed $value)

Determine if the given value is callable, but not a string.

callable
valueRetriever(callable|string|null $value)

Get a value retrieving callback.

equality(mixed $value)

Make a function to check an item's equality.

Closure
negate(Closure $callback)

Make a function using another function, by negating its result.

identity()

Make a function that returns what's passed to it.

Details

in Conditionable at line 21
$this|TWhenReturnType when($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) truthy.

Parameters

$value
callable|null $callback
callable|null $default

Return Value

$this|TWhenReturnType

in Conditionable at line 53
$this|TUnlessReturnType unless($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) falsy.

Parameters

$value
callable|null $callback
callable|null $default

Return Value

$this|TUnlessReturnType

at line 118
static make($items = [])

No description

Parameters

$items

at line 131
static wrap($value)

No description

Parameters

$value

at line 147
static unwrap($value)

No description

Parameters

$value

at line 157
static EnumeratesValues empty()

Create a new instance with no items.

Return Value

EnumeratesValues

at line 171
static times($number, callable|null $callback = null)

No description

Parameters

$number
callable|null $callback

at line 188
float|int|null avg($callback = null)

Get the average value of a given key.

Parameters

$callback

Return Value

float|int|null

at line 210
float|int|null average($callback = null)

Alias for the "avg" method.

Parameters

$callback

Return Value

float|int|null

at line 223
bool some($key, mixed $operator = null, mixed $value = null)

Alias for the "contains" method.

Parameters

$key
mixed $operator
mixed $value

Return Value

bool

at line 234
never dd(mixed ...$args)

Dump the given arguments and terminate execution.

Parameters

mixed ...$args

Return Value

never

at line 245
$this dump(mixed ...$args)

Dump the items.

Parameters

mixed ...$args

Return Value

$this

at line 258
$this each(callable $callback)

Execute a callback over each item.

Parameters

callable $callback

Return Value

$this

at line 275
EnumeratesValues eachSpread(callable $callback)

Execute a callback over each nested chunk of items.

Parameters

callable $callback

Return Value

EnumeratesValues

at line 292
bool every($key, mixed $operator = null, mixed $value = null)

Determine if all items pass the given truth test.

Parameters

$key
mixed $operator
mixed $value

Return Value

bool

at line 317
TValue|null firstWhere(callable|string $key, mixed $operator = null, mixed $value = null)

Get the first item by the given key value pair.

Parameters

callable|string $key
mixed $operator
mixed $value

Return Value

TValue|null

at line 331
value($key, $default = null)

No description

Parameters

$key
$default

at line 350
ensure($type)

No description

Parameters

$type

at line 380
bool isNotEmpty()

Determine if the collection is not empty.

Return Value

bool

at line 393
mapSpread(callable $callback)

No description

Parameters

callable $callback

at line 413
mapToGroups(callable $callback)

No description

Parameters

callable $callback

at line 429
flatMap(callable $callback)

No description

Parameters

callable $callback

at line 442
mapInto($class)

No description

Parameters

$class

at line 457
mixed min($callback = null)

Get the min value of a given key.

Parameters

$callback

Return Value

mixed

at line 472
mixed max($callback = null)

Get the max value of a given key.

Parameters

$callback

Return Value

mixed

at line 490
EnumeratesValues forPage(int $page, int $perPage)

"Paginate" the collection by slicing it into a smaller collection.

Parameters

int $page
int $perPage

Return Value

EnumeratesValues

at line 505
partition($key, $operator = null, $value = null)

No description

Parameters

$key
$operator
$value

at line 523
float|null percentage(callable $callback, int $precision = 2)

Calculate the percentage of items that pass a given truth test.

Parameters

callable $callback
int $precision

Return Value

float|null

at line 543
sum($callback = null)

Get the sum of the given values.

Parameters

$callback

at line 561
$this|TWhenEmptyReturnType whenEmpty(callable $callback, callable|null $default = null)

Apply the callback if the collection is empty.

Parameters

callable $callback
callable|null $default

Return Value

$this|TWhenEmptyReturnType

at line 575
$this|TWhenNotEmptyReturnType whenNotEmpty(callable $callback, callable|null $default = null)

Apply the callback if the collection is not empty.

Parameters

callable $callback
callable|null $default

Return Value

$this|TWhenNotEmptyReturnType

at line 589
$this|TUnlessEmptyReturnType unlessEmpty(callable $callback, callable|null $default = null)

Apply the callback unless the collection is empty.

Parameters

callable $callback
callable|null $default

Return Value

$this|TUnlessEmptyReturnType

at line 603
$this|TUnlessNotEmptyReturnType unlessNotEmpty(callable $callback, callable|null $default = null)

Apply the callback unless the collection is not empty.

Parameters

callable $callback
callable|null $default

Return Value

$this|TUnlessNotEmptyReturnType

at line 616
EnumeratesValues where(callable|string $key, mixed $operator = null, mixed $value = null)

Filter items by the given key value pair.

Parameters

callable|string $key
mixed $operator
mixed $value

Return Value

EnumeratesValues

at line 627
EnumeratesValues whereNull(string|null $key = null)

Filter items where the value for the given key is null.

Parameters

string|null $key

Return Value

EnumeratesValues

at line 638
EnumeratesValues whereNotNull(string|null $key = null)

Filter items where the value for the given key is not null.

Parameters

string|null $key

Return Value

EnumeratesValues

at line 650
EnumeratesValues whereStrict(string $key, mixed $value)

Filter items by the given key value pair using strict comparison.

Parameters

string $key
mixed $value

Return Value

EnumeratesValues

at line 663
EnumeratesValues whereIn(string $key, Arrayable|iterable $values, bool $strict = false)

Filter items by the given key value pair.

Parameters

string $key
Arrayable|iterable $values
bool $strict

Return Value

EnumeratesValues

at line 677
EnumeratesValues whereInStrict(string $key, Arrayable|iterable $values)

Filter items by the given key value pair using strict comparison.

Parameters

string $key
Arrayable|iterable $values

Return Value

EnumeratesValues

at line 689
EnumeratesValues whereBetween(string $key, Arrayable|iterable $values)

Filter items such that the value of the given key is between the given values.

Parameters

string $key
Arrayable|iterable $values

Return Value

EnumeratesValues

at line 701
EnumeratesValues whereNotBetween(string $key, Arrayable|iterable $values)

Filter items such that the value of the given key is not between the given values.

Parameters

string $key
Arrayable|iterable $values

Return Value

EnumeratesValues

at line 716
EnumeratesValues whereNotIn(string $key, Arrayable|iterable $values, bool $strict = false)

Filter items by the given key value pair.

Parameters

string $key
Arrayable|iterable $values
bool $strict

Return Value

EnumeratesValues

at line 730
EnumeratesValues whereNotInStrict(string $key, Arrayable|iterable $values)

Filter items by the given key value pair using strict comparison.

Parameters

string $key
Arrayable|iterable $values

Return Value

EnumeratesValues

at line 743
whereInstanceOf($type)

No description

Parameters

$type

at line 768
TPipeReturnType pipe(callable $callback)

Pass the collection to the given callback and return the result.

Parameters

callable $callback

Return Value

TPipeReturnType

at line 781
TPipeIntoValue pipeInto(TPipeIntoValue> $class)

Pass the collection into a new class.

Parameters

TPipeIntoValue> $class

Return Value

TPipeIntoValue

at line 792
mixed pipeThrough(callable[] $callbacks)

Pass the collection through a series of callable pipes and return the result.

Parameters

callable[] $callbacks

Return Value

mixed

at line 810
TReduceReturnType reduce(callable $callback, TReduceInitial $initial = null)

Reduce the collection to a single value.

Parameters

callable $callback
TReduceInitial $initial

Return Value

TReduceReturnType

at line 830
array reduceSpread(callable $callback, mixed ...$initial)

Reduce the collection to multiple aggregate values.

Parameters

callable $callback
mixed ...$initial

Return Value

array

Exceptions

UnexpectedValueException

at line 858
TReduceWithKeysReturnType reduceWithKeys(callable $callback, TReduceWithKeysInitial $initial = null)

Reduce an associative collection to a single value.

Parameters

callable $callback
TReduceWithKeysInitial $initial

Return Value

TReduceWithKeysReturnType

at line 869
EnumeratesValues reject($callback = true)

Create a collection of all elements that do not pass a given truth test.

Parameters

$callback

Return Value

EnumeratesValues

at line 886
$this tap(callable $callback)

Pass the collection to the given callback and then return it.

Parameters

callable $callback

Return Value

$this

at line 900
EnumeratesValues unique($key = null, bool $strict = false)

Return only unique items from the collection array.

Parameters

$key
bool $strict

Return Value

EnumeratesValues

at line 921
EnumeratesValues uniqueStrict($key = null)

Return only unique items from the collection array using strict comparison.

Parameters

$key

Return Value

EnumeratesValues

at line 931
TValue> collect()

Collect the values into a collection.

Return Value

TValue>

at line 941
toArray()

No description

at line 951
array jsonSerialize()

No description

Return Value

array

at line 972
string toJson(int $options = 0)

Get the collection of items as JSON.

Parameters

int $options

Return Value

string

at line 983
CachingIterator getCachingIterator(int $flags = CachingIterator::CALL_TOSTRING)

Get a CachingIterator instance.

Parameters

int $flags

Return Value

CachingIterator

at line 993
string __toString()

Convert the collection to its string representation.

Return Value

string

at line 1006
$this escapeWhenCastingToString(bool $escape = true)

Indicate that the model's string representation should be escaped when __toString is invoked.

Parameters

bool $escape

Return Value

$this

at line 1019
static void proxy(string $method)

Add a method to the list of proxied methods.

Parameters

string $method

Return Value

void

at line 1032
mixed __get(string $key)

Dynamically access collection proxies.

Parameters

string $key

Return Value

mixed

Exceptions

Exception

at line 1047
protected getArrayableItems($items)

No description

Parameters

$items

at line 1073
protected Closure operatorForWhere(callable|string $key, string|null $operator = null, mixed $value = null)

Get an operator checker callback.

Parameters

callable|string $key
string|null $operator
mixed $value

Return Value

Closure

at line 1130
protected bool useAsCallable(mixed $value)

Determine if the given value is callable, but not a string.

Parameters

mixed $value

Return Value

bool

at line 1141
protected callable valueRetriever(callable|string|null $value)

Get a value retrieving callback.

Parameters

callable|string|null $value

Return Value

callable

at line 1156
protected equality(mixed $value)

Make a function to check an item's equality.

Parameters

mixed $value

at line 1167
protected Closure negate(Closure $callback)

Make a function using another function, by negating its result.

Parameters

Closure $callback

Return Value

Closure

at line 1177
protected identity()

Make a function that returns what's passed to it.