interface Enumerable implements Arrayable, Countable, IteratorAggregate, Jsonable, JsonSerializable (View source)
| toArray() No description | ||
| string | toJson(int $options = 0)
Get the collection of items as JSON. | |
| static | make($items = []) No description | |
| static Enumerable | times(int $number, callable|null $callback = null)
Create a new instance by invoking the callback a given amount of times. | |
| static Enumerable | range(int $from, int $to)
Create a collection with the given range. | |
| static | wrap($value) No description | |
| static | unwrap($value) No description | |
| static Enumerable | empty()
Create a new instance with no items. | |
| array | all()
Get all items in the enumerable. | |
| float|int|null | average($callback = null)
Alias for the "avg" method. | |
| float|int|null | median(string|array<array-key,string>|null $key = null)
Get the median of a given key. | |
| array<int,float|int>|null | mode(string|array<array-key,string>|null $key = null)
Get the mode of a given key. | |
| collapse() No description | ||
| bool | some($key, mixed $operator = null, mixed $value = null)
Alias for the "contains" method. | |
| bool | containsStrict($key, TValue|null $value = null)
Determine if an item exists, using strict comparison. | |
| float|int|null | avg($callback = null)
Get the average value of a given key. | |
| bool | contains($key, mixed $operator = null, mixed $value = null)
Determine if an item exists in the enumerable. | |
| bool | doesntContain(mixed $key, mixed $operator = null, mixed $value = null)
Determine if an item is not contained in the collection. | |
| crossJoin(...$lists) No description | ||
| never | dd(mixed ...$args)
Dump the collection and end the script. | |
| $this | dump(mixed ...$args)
Dump the collection. | |
| Enumerable | diff(TValue>|TValue> $items)
Get the items that are not present in the given items. | |
| Enumerable | diffUsing(TValue>|TValue> $items, callable $callback)
Get the items that are not present in the given items, using the callback. | |
| Enumerable | diffAssoc(TValue>|TValue> $items)
Get the items whose keys and values are not present in the given items. | |
| Enumerable | diffAssocUsing(TValue>|TValue> $items, callable $callback)
Get the items whose keys and values are not present in the given items, using the callback. | |
| Enumerable | diffKeys(TValue>|TValue> $items)
Get the items whose keys are not present in the given items. | |
| Enumerable | diffKeysUsing(TValue>|TValue> $items, callable $callback)
Get the items whose keys are not present in the given items, using the callback. | |
| Enumerable | duplicates($callback = null, bool $strict = false)
Retrieve duplicate items. | |
| Enumerable | duplicatesStrict($callback = null)
Retrieve duplicate items using strict comparison. | |
| $this | each(callable $callback)
Execute a callback over each item. | |
| Enumerable | 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. | |
| Enumerable | except(TKey>|TKey> $keys)
Get all items except for those with the specified keys. | |
| Enumerable | filter(callable|null $callback = null)
Run a filter over each of the items. | |
| $this|TWhenReturnType | when(bool $value, callable|null $callback = null, callable|null $default = null)
Apply the callback if the given "value" is (or resolves to) truthy. | |
| $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|TUnlessReturnType | unless(bool $value, callable $callback, callable|null $default = null)
Apply the callback if the given "value" is (or resolves to) truthy. | |
| $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. | |
| Enumerable | where(string $key, mixed $operator = null, mixed $value = null)
Filter items by the given key value pair. | |
| Enumerable | whereNull(string|null $key = null)
Filter items where the value for the given key is null. | |
| Enumerable | whereNotNull(string|null $key = null)
Filter items where the value for the given key is not null. | |
| Enumerable | whereStrict(string $key, mixed $value)
Filter items by the given key value pair using strict comparison. | |
| Enumerable | whereIn(string $key, Arrayable|iterable $values, bool $strict = false)
Filter items by the given key value pair. | |
| Enumerable | whereInStrict(string $key, Arrayable|iterable $values)
Filter items by the given key value pair using strict comparison. | |
| Enumerable | whereBetween(string $key, Arrayable|iterable $values)
Filter items such that the value of the given key is between the given values. | |
| Enumerable | whereNotBetween(string $key, Arrayable|iterable $values)
Filter items such that the value of the given key is not between the given values. | |
| Enumerable | whereNotIn(string $key, Arrayable|iterable $values, bool $strict = false)
Filter items by the given key value pair. | |
| Enumerable | whereNotInStrict(string $key, Arrayable|iterable $values)
Filter items by the given key value pair using strict comparison. | |
| whereInstanceOf($type) No description | ||
| first(callable|null $callback = null, $default = null) No description | ||
| TValue|null | firstWhere(string $key, mixed $operator = null, mixed $value = null)
Get the first item by the given key value pair. | |
| Enumerable | flatten(int $depth = INF)
Get a flattened array of the items in the collection. | |
| flip() No description | ||
| get($key, $default = null) No description | ||
| groupBy($groupBy, $preserveKeys = false) No description | ||
| keyBy($keyBy) No description | ||
| bool | has(TKey|TKey> $key)
Determine if an item exists in the collection by key. | |
| bool | hasAny(mixed $key)
Determine if any of the keys exist in the collection. | |
| string | implode(callable|string $value, string|null $glue = null)
Concatenate values of a given key as a string. | |
| Enumerable | intersect(TValue>|TValue> $items)
Intersect the collection with the given items. | |
| Enumerable | intersectUsing(TValue>|TValue> $items, callable $callback)
Intersect the collection with the given items, using the callback. | |
| Enumerable | intersectAssoc(TValue>|TValue> $items)
Intersect the collection with the given items with additional index check. | |
| Enumerable | intersectAssocUsing(TValue>|TValue> $items, callable $callback)
Intersect the collection with the given items with additional index check, using the callback. | |
| Enumerable | intersectByKeys(TValue>|TValue> $items)
Intersect the collection with the given items by key. | |
| bool | isEmpty()
Determine if the collection is empty or not. | |
| bool | isNotEmpty()
Determine if the collection is not empty. | |
| bool | containsOneItem()
Determine if the collection contains a single item. | |
| string | join(string $glue, string $finalGlue = '')
Join all items from the collection using a string. The final items can use a separate glue string. | |
| keys() No description | ||
| last(callable|null $callback = null, $default = null) No description | ||
| map(callable $callback) No description | ||
| Enumerable | mapSpread(callable $callback)
Run a map over each nested chunk of items. | |
| mapToDictionary(callable $callback) No description | ||
| mapToGroups(callable $callback) No description | ||
| mapWithKeys(callable $callback) No description | ||
| flatMap(callable $callback) No description | ||
| mapInto($class) No description | ||
| Enumerable | merge(TValue>|TValue> $items)
Merge the collection with the given items. | |
| mergeRecursive($items) No description | ||
| combine($values) No description | ||
| Enumerable | union(TValue>|TValue> $items)
Union the collection with the given items. | |
| mixed | min($callback = null)
Get the min value of a given key. | |
| mixed | max($callback = null)
Get the max value of a given key. | |
| Enumerable | nth(int $step, int $offset = 0)
Create a new collection consisting of every n-th element. | |
| Enumerable | only(TKey>|TKey>|string $keys)
Get the items with the specified keys. | |
| Enumerable | forPage(int $page, int $perPage)
"Paginate" the collection by slicing it into a smaller collection. | |
| partition($key, $operator = null, $value = null) No description | ||
| concat($source) No description | ||
| random($number = null) No description | ||
| 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. | |
| Enumerable | replace(TValue>|TValue> $items)
Replace the collection items with the given items. | |
| Enumerable | replaceRecursive(TValue>|TValue> $items)
Recursively replace the collection items with the given items. | |
| Enumerable | reverse()
Reverse items order. | |
| TKey|bool | search($value, bool $strict = false)
Search the collection for a given value and return the corresponding key if successful. | |
| TValue|null | before($value, bool $strict = false)
Get the item before the given item. | |
| TValue|null | after($value, bool $strict = false)
Get the item after the given item. | |
| Enumerable | shuffle()
Shuffle the items in the collection. | |
| sliding($size = 2, $step = 1) No description | ||
| Enumerable | skip(int $count)
Skip the first {$count} items. | |
| Enumerable | skipUntil($value)
Skip items in the collection until the given condition is met. | |
| Enumerable | skipWhile($value)
Skip items in the collection while the given condition is met. | |
| Enumerable | slice(int $offset, int|null $length = null)
Get a slice of items from the enumerable. | |
| split($numberOfGroups) No description | ||
| TValue | sole($key = null, mixed $operator = null, mixed $value = null)
Get the first item in the collection, but only if exactly one item exists. Otherwise, throw an exception. | |
| TValue | firstOrFail($key = null, mixed $operator = null, mixed $value = null)
Get the first item in the collection but throw an exception if no matching items exist. | |
| chunk($size) No description | ||
| chunkWhile(callable $callback) No description | ||
| splitIn($numberOfGroups) No description | ||
| Enumerable | sort($callback = null)
Sort through each item with a callback. | |
| Enumerable | sortDesc(int $options = SORT_REGULAR)
Sort items in descending order. | |
| Enumerable | sortBy($callback, int $options = SORT_REGULAR, bool $descending = false)
Sort the collection using the given callback. | |
| Enumerable | sortByDesc($callback, int $options = SORT_REGULAR)
Sort the collection in descending order using the given callback. | |
| Enumerable | sortKeys(int $options = SORT_REGULAR, bool $descending = false)
Sort the collection keys. | |
| Enumerable | sortKeysDesc(int $options = SORT_REGULAR)
Sort the collection keys in descending order. | |
| Enumerable | sortKeysUsing(callable $callback)
Sort the collection keys using a callback. | |
| mixed | sum($callback = null)
Get the sum of the given values. | |
| Enumerable | take(int $limit)
Take the first or last {$limit} items. | |
| Enumerable | takeUntil($value)
Take items in the collection until the given condition is met. | |
| Enumerable | takeWhile($value)
Take items in the collection while the given condition is met. | |
| $this | tap(callable $callback)
Pass the collection to the given callback and then return it. | |
| TPipeReturnType | pipe(callable $callback)
Pass the enumerable to the given callback and return the result. | |
| TPipeIntoValue | pipeInto(TPipeIntoValue> $class)
Pass the collection into a new class. | |
| mixed | pipeThrough(callable[] $pipes)
Pass the collection through a series of callable pipes and return the result. | |
| pluck($value, $key = null) No description | ||
| Enumerable | reject($callback = true)
Create a collection of all elements that do not pass a given truth test. | |
| Enumerable | undot()
Convert a flatten "dot" notation array into an expanded array. | |
| Enumerable | unique($key = null, bool $strict = false)
Return only unique items from the collection array. | |
| Enumerable | uniqueStrict($key = null)
Return only unique items from the collection array using strict comparison. | |
| values() No description | ||
| pad($size, $value) No description | ||
| Traversable | getIterator()
Get the values iterator. | |
| int | count()
Count the number of items in the collection. | |
| countBy($countBy = null) No description | ||
| zip($items) No description | ||
| TValue> | collect()
Collect the values into a collection. | |
| mixed | jsonSerialize()
Convert the object into something JSON serializable. | |
| 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. |
No description
Get the collection of items as JSON.
No description
Create a new instance by invoking the callback a given amount of times.
Create a collection with the given range.
No description
No description
Create a new instance with no items.
Get all items in the enumerable.
Alias for the "avg" method.
Get the median of a given key.
Get the mode of a given key.
No description
Alias for the "contains" method.
Determine if an item exists, using strict comparison.
Get the average value of a given key.
Determine if an item exists in the enumerable.
Determine if an item is not contained in the collection.
No description
Dump the collection and end the script.
Dump the collection.
Get the items that are not present in the given items.
Get the items that are not present in the given items, using the callback.
Get the items whose keys and values are not present in the given items.
Get the items whose keys and values are not present in the given items, using the callback.
Get the items whose keys are not present in the given items.
Get the items whose keys are not present in the given items, using the callback.
Retrieve duplicate items.
Retrieve duplicate items using strict comparison.
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 all items except for those with the specified keys.
Run a filter over each of the items.
Apply the callback if the given "value" is (or resolves to) truthy.
Apply the callback if the collection is empty.
Apply the callback if the collection is not empty.
Apply the callback if the given "value" is (or resolves to) truthy.
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
No description
Get the first item by the given key value pair.
Get a flattened array of the items in the collection.
No description
No description
No description
No description
Determine if an item exists in the collection by key.
Determine if any of the keys exist in the collection.
Concatenate values of a given key as a string.
Intersect the collection with the given items.
Intersect the collection with the given items, using the callback.
Intersect the collection with the given items with additional index check.
Intersect the collection with the given items with additional index check, using the callback.
Intersect the collection with the given items by key.
Determine if the collection is empty or not.
Determine if the collection is not empty.
Determine if the collection contains a single item.
Join all items from the collection using a string. The final items can use a separate glue string.
No description
No description
No description
Run a map over each nested chunk of items.
No description
No description
No description
No description
No description
Merge the collection with the given items.
No description
No description
Union the collection with the given items.
Get the min value of a given key.
Get the max value of a given key.
Create a new collection consisting of every n-th element.
Get the items with the specified keys.
"Paginate" the collection by slicing it into a smaller collection.
No description
No description
No description
Reduce the collection to a single value.
Reduce the collection to multiple aggregate values.
Replace the collection items with the given items.
Recursively replace the collection items with the given items.
Reverse items order.
Search the collection for a given value and return the corresponding key if successful.
Get the item before the given item.
Get the item after the given item.
Shuffle the items in the collection.
No description
Skip the first {$count} items.
Skip items in the collection until the given condition is met.
Skip items in the collection while the given condition is met.
Get a slice of items from the enumerable.
No description
Get the first item in the collection, but only if exactly one item exists. Otherwise, throw an exception.
Get the first item in the collection but throw an exception if no matching items exist.
No description
No description
No description
Sort through each item with a callback.
Sort items in descending order.
Sort the collection using the given callback.
Sort the collection in descending order using the given callback.
Sort the collection keys.
Sort the collection keys in descending order.
Sort the collection keys using a callback.
Get the sum of the given values.
Take the first or last {$limit} items.
Take items in the collection until the given condition is met.
Take items in the collection while the given condition is met.
Pass the collection to the given callback and then return it.
Pass the enumerable 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.
No description
Create a collection of all elements that do not pass a given truth test.
Convert a flatten "dot" notation array into an expanded array.
Return only unique items from the collection array.
Return only unique items from the collection array using strict comparison.
No description
No description
Get the values iterator.
Count the number of items in the collection.
No description
No description
Collect the values into a collection.
Convert the object into something JSON serializable.
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.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Support/Enumerable.html