trait EnumeratesValues (View source)
| Conditionable |
| 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. | |
| HigherOrderCollectionProxy read-only | $average | ||
| HigherOrderCollectionProxy read-only | $avg | ||
| HigherOrderCollectionProxy read-only | $contains | ||
| HigherOrderCollectionProxy read-only | $doesntContain | ||
| HigherOrderCollectionProxy read-only | $each | ||
| HigherOrderCollectionProxy read-only | $every | ||
| HigherOrderCollectionProxy read-only | $filter | ||
| HigherOrderCollectionProxy read-only | $first | ||
| HigherOrderCollectionProxy read-only | $flatMap | ||
| HigherOrderCollectionProxy read-only | $groupBy | ||
| HigherOrderCollectionProxy read-only | $keyBy | ||
| HigherOrderCollectionProxy read-only | $map | ||
| HigherOrderCollectionProxy read-only | $max | ||
| HigherOrderCollectionProxy read-only | $min | ||
| HigherOrderCollectionProxy read-only | $partition | ||
| HigherOrderCollectionProxy read-only | $percentage | ||
| HigherOrderCollectionProxy read-only | $reject | ||
| HigherOrderCollectionProxy read-only | $skipUntil | ||
| HigherOrderCollectionProxy read-only | $skipWhile | ||
| HigherOrderCollectionProxy read-only | $some | ||
| HigherOrderCollectionProxy read-only | $sortBy | ||
| HigherOrderCollectionProxy read-only | $sortByDesc | ||
| HigherOrderCollectionProxy read-only | $sum | ||
| HigherOrderCollectionProxy read-only | $takeUntil | ||
| HigherOrderCollectionProxy read-only | $takeWhile | ||
| HigherOrderCollectionProxy read-only | $unique | ||
| HigherOrderCollectionProxy read-only | $unless | ||
| HigherOrderCollectionProxy read-only | $until | ||
| HigherOrderCollectionProxy read-only | $when |
| $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. | |
| mixed | 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. |
Apply the callback if the given "value" is (or resolves to) truthy.
Apply the callback if the given "value" is (or resolves to) falsy.
No description
No description
No description
Create a new instance with no items.
No description
Get the average value of a given key.
Alias for the "avg" method.
Alias for the "contains" method.
Dump the given arguments and terminate execution.
Dump the items.
Execute a callback over each item.
Execute a callback over each nested chunk of items.
Determine if all items pass the given truth test.
Get the first item by the given key value pair.
No description
No description
Determine if the collection is not empty.
No description
No description
No description
No description
Get the min value of a given key.
Get the max value of a given key.
"Paginate" the collection by slicing it into a smaller collection.
No description
Calculate the percentage of items that pass a given truth test.
Get the sum of the given values.
Apply the callback if the collection is empty.
Apply the callback if the collection is not empty.
Apply the callback unless the collection is empty.
Apply the callback unless the collection is not empty.
Filter items by the given key value pair.
Filter items where the value for the given key is null.
Filter items where the value for the given key is not null.
Filter items by the given key value pair using strict comparison.
Filter items by the given key value pair.
Filter items by the given key value pair using strict comparison.
Filter items such that the value of the given key is between the given values.
Filter items such that the value of the given key is not between the given values.
Filter items by the given key value pair.
Filter items by the given key value pair using strict comparison.
No description
Pass the collection to the given callback and return the result.
Pass the collection into a new class.
Pass the collection through a series of callable pipes and return the result.
Reduce the collection to a single value.
Reduce the collection to multiple aggregate values.
Reduce an associative collection to a single value.
Create a collection of all elements that do not pass a given truth test.
Pass the collection to the given callback and then return it.
Return only unique items from the collection array.
Return only unique items from the collection array using strict comparison.
Collect the values into a collection.
No description
No description
Get the collection of items as JSON.
Get a CachingIterator instance.
Convert the collection to its string representation.
Indicate that the model's string representation should be escaped when __toString is invoked.
Add a method to the list of proxied methods.
Dynamically access collection proxies.
No description
Get an operator checker callback.
Determine if the given value is callable, but not a string.
Get a value retrieving callback.
Make a function to check an item's equality.
Make a function using another function, by negating its result.
Make a function that returns what's passed to it.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Support/Traits/EnumeratesValues.html