class Collection implements ArrayAccess, CanBeEscapedWhenCastToString, Enumerable (View source)
| EnumeratesValues | |
| Macroable | |
| Conditionable |
| $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 | from EnumeratesValues |
| static | wrap($value) No description | from EnumeratesValues |
| static | unwrap($value) No description | from EnumeratesValues |
| static EnumeratesValues | empty()
Create a new instance with no items. | from EnumeratesValues |
| static | times($number, callable|null $callback = null) No description | from EnumeratesValues |
| float|int|null | avg($callback = null)
Get the average value of a given key. | from EnumeratesValues |
| float|int|null | average($callback = null)
Alias for the "avg" method. | from EnumeratesValues |
| bool | some($key, mixed $operator = null, mixed $value = null)
Alias for the "contains" method. | from EnumeratesValues |
| never | dd(mixed ...$args)
Dump the given arguments and terminate execution. | from EnumeratesValues |
| $this | dump(mixed ...$args)
Dump the items. | from EnumeratesValues |
| $this | each(callable $callback)
Execute a callback over each item. | from EnumeratesValues |
| EnumeratesValues | eachSpread(callable $callback)
Execute a callback over each nested chunk of items. | from EnumeratesValues |
| bool | every($key, mixed $operator = null, mixed $value = null)
Determine if all items pass the given truth test. | from EnumeratesValues |
| TValue|null | firstWhere(callable|string $key, mixed $operator = null, mixed $value = null)
Get the first item by the given key value pair. | from EnumeratesValues |
| value($key, $default = null) No description | from EnumeratesValues | |
| ensure($type) No description | from EnumeratesValues | |
| bool | isNotEmpty()
Determine if the collection is not empty. | from EnumeratesValues |
| mapSpread(callable $callback) No description | from EnumeratesValues | |
| mapToGroups(callable $callback) No description | from EnumeratesValues | |
| flatMap(callable $callback) No description | from EnumeratesValues | |
| mapInto($class) No description | from EnumeratesValues | |
| mixed | min($callback = null)
Get the min value of a given key. | from EnumeratesValues |
| mixed | max($callback = null)
Get the max value of a given key. | from EnumeratesValues |
| EnumeratesValues | forPage(int $page, int $perPage)
"Paginate" the collection by slicing it into a smaller collection. | from EnumeratesValues |
| partition($key, $operator = null, $value = null) No description | from EnumeratesValues | |
| float|null | percentage(callable $callback, int $precision = 2)
Calculate the percentage of items that pass a given truth test. | from EnumeratesValues |
| mixed | sum($callback = null)
Get the sum of the given values. | from EnumeratesValues |
| $this|TWhenEmptyReturnType | whenEmpty(callable $callback, callable|null $default = null)
Apply the callback if the collection is empty. | from EnumeratesValues |
| $this|TWhenNotEmptyReturnType | whenNotEmpty(callable $callback, callable|null $default = null)
Apply the callback if the collection is not empty. | from EnumeratesValues |
| $this|TUnlessEmptyReturnType | unlessEmpty(callable $callback, callable|null $default = null)
Apply the callback unless the collection is empty. | from EnumeratesValues |
| $this|TUnlessNotEmptyReturnType | unlessNotEmpty(callable $callback, callable|null $default = null)
Apply the callback unless the collection is not empty. | from EnumeratesValues |
| EnumeratesValues | where(callable|string $key, mixed $operator = null, mixed $value = null)
Filter items by the given key value pair. | from EnumeratesValues |
| EnumeratesValues | whereNull(string|null $key = null)
Filter items where the value for the given key is null. | from EnumeratesValues |
| EnumeratesValues | whereNotNull(string|null $key = null)
Filter items where the value for the given key is not null. | from EnumeratesValues |
| EnumeratesValues | whereStrict(string $key, mixed $value)
Filter items by the given key value pair using strict comparison. | from EnumeratesValues |
| EnumeratesValues | whereIn(string $key, Arrayable|iterable $values, bool $strict = false)
Filter items by the given key value pair. | from EnumeratesValues |
| EnumeratesValues | whereInStrict(string $key, Arrayable|iterable $values)
Filter items by the given key value pair using strict comparison. | from EnumeratesValues |
| EnumeratesValues | whereBetween(string $key, Arrayable|iterable $values)
Filter items such that the value of the given key is between the given values. | from EnumeratesValues |
| EnumeratesValues | whereNotBetween(string $key, Arrayable|iterable $values)
Filter items such that the value of the given key is not between the given values. | from EnumeratesValues |
| EnumeratesValues | whereNotIn(string $key, Arrayable|iterable $values, bool $strict = false)
Filter items by the given key value pair. | from EnumeratesValues |
| EnumeratesValues | whereNotInStrict(string $key, Arrayable|iterable $values)
Filter items by the given key value pair using strict comparison. | from EnumeratesValues |
| whereInstanceOf($type) No description | from EnumeratesValues | |
| TPipeReturnType | pipe(callable $callback)
Pass the collection to the given callback and return the result. | from EnumeratesValues |
| TPipeIntoValue | pipeInto(TPipeIntoValue> $class)
Pass the collection into a new class. | from EnumeratesValues |
| mixed | pipeThrough(callable[] $callbacks)
Pass the collection through a series of callable pipes and return the result. | from EnumeratesValues |
| TReduceReturnType | reduce(callable $callback, TReduceInitial $initial = null)
Reduce the collection to a single value. | from EnumeratesValues |
| array | reduceSpread(callable $callback, mixed ...$initial)
Reduce the collection to multiple aggregate values. | from EnumeratesValues |
| TReduceWithKeysReturnType | reduceWithKeys(callable $callback, TReduceWithKeysInitial $initial = null)
Reduce an associative collection to a single value. | from EnumeratesValues |
| EnumeratesValues | reject($callback = true)
Create a collection of all elements that do not pass a given truth test. | from EnumeratesValues |
| $this | tap(callable $callback)
Pass the collection to the given callback and then return it. | from EnumeratesValues |
| Enumerable | 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. | from EnumeratesValues |
| TValue> | collect()
Collect the values into a collection. | from EnumeratesValues |
| toArray() No description | from EnumeratesValues | |
| array | jsonSerialize() No description | from EnumeratesValues |
| string | toJson(int $options = 0)
Get the collection of items as JSON. | from EnumeratesValues |
| CachingIterator | getCachingIterator(int $flags = CachingIterator::CALL_TOSTRING)
Get a CachingIterator instance. | from EnumeratesValues |
| string | __toString()
Convert the collection to its string representation. | from EnumeratesValues |
| $this | escapeWhenCastingToString(bool $escape = true)
Indicate that the model's string representation should be escaped when __toString is invoked. | from EnumeratesValues |
| static void | proxy(string $method)
Add a method to the list of proxied methods. | from EnumeratesValues |
| mixed | __get(string $key)
Dynamically access collection proxies. | from EnumeratesValues |
| getArrayableItems($items) No description | from EnumeratesValues | |
| Closure | operatorForWhere(callable|string $key, string|null $operator = null, mixed $value = null)
Get an operator checker callback. | from EnumeratesValues |
| bool | useAsCallable(mixed $value)
Determine if the given value is callable, but not a string. | from EnumeratesValues |
| callable | valueRetriever(callable|string|null $value)
Get a value retrieving callback. | from EnumeratesValues |
| equality(mixed $value)
Make a function to check an item's equality. | from EnumeratesValues | |
| Closure | negate(Closure $callback)
Make a function using another function, by negating its result. | from EnumeratesValues |
| identity()
Make a function that returns what's passed to it. | from EnumeratesValues | |
| static void | macro(string $name, object|callable $macro)
Register a custom macro. | from Macroable |
| static void | mixin(object $mixin, bool $replace = true)
Mix another object into the class. | from Macroable |
| static bool | hasMacro(string $name)
Checks if macro is registered. | from Macroable |
| static void | flushMacros()
Flush the existing macros. | from Macroable |
| static mixed | __callStatic(string $method, array $parameters)
Dynamically handle calls to the class. | from Macroable |
| mixed | __call(string $method, array $parameters)
Dynamically handle calls to the class. | from Macroable |
| void | __construct(TValue>|TValue>|null $items = [])
Create a new collection. | |
| static Enumerable | range(int $from, int $to) No description | |
| array | all() No description | |
| TValue> | lazy()
Get a lazy collection for the items in this collection. | |
| 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 | contains($key, mixed $operator = null, mixed $value = null)
Determine if an item exists in the collection. | |
| bool | containsStrict($key, TValue|null $value = null)
Determine if an item exists, using strict comparison. | |
| bool | doesntContain(mixed $key, mixed $operator = null, mixed $value = null)
Determine if an item is not contained in the collection. | |
| crossJoin(...$lists) No description | ||
| Enumerable | diff(TValue>|TValue> $items)
Get the items in the collection that are not present in the given items. | |
| Enumerable | diffUsing(TValue>|TValue> $items, callable $callback)
Get the items in the collection that are not present in the given items, using the callback. | |
| Enumerable | diffAssoc(TValue>|TValue> $items)
Get the items in the collection whose keys and values are not present in the given items. | |
| Enumerable | diffAssocUsing(TValue>|TValue> $items, callable $callback)
Get the items in the collection whose keys and values are not present in the given items, using the callback. | |
| Enumerable | diffKeys(TValue>|TValue> $items)
Get the items in the collection whose keys are not present in the given items. | |
| Enumerable | diffKeysUsing(TValue>|TValue> $items, callable $callback)
Get the items in the collection whose keys are not present in the given items, using the callback. | |
| Enumerable | duplicates($callback = null, bool $strict = false)
Retrieve duplicate items from the collection. | |
| Enumerable | duplicatesStrict($callback = null)
Retrieve duplicate items from the collection using strict comparison. | |
| duplicateComparator(bool $strict)
Get the comparison function to detect duplicates. | ||
| 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. | |
| first(callable|null $callback = null, $default = null) No description | ||
| Enumerable | flatten(int $depth = INF) No description | |
| flip() No description | ||
| $this | forget($keys)
Remove an item from the collection by key. | |
| get($key, $default = null) No description | ||
| getOrPut($key, $value) 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 | 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 | ||
| pluck($value, $key = null) No description | ||
| map(callable $callback) No description | ||
| mapToDictionary(callable $callback) No description | ||
| mapWithKeys(callable $callback) No description | ||
| Enumerable | merge(TValue>|TValue> $items)
Merge the collection with the given items. | |
| mergeRecursive($items) No description | ||
| Collection | multiply(int $multiplier)
Multiply the items in the collection by the multiplier. | |
| combine($values) No description | ||
| Enumerable | union(TValue>|TValue> $items)
Union the collection with the given items. | |
| 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. | |
| Collection | select(TKey>|TKey>|string|null $keys)
Select specific values from the items within the collection. | |
| pop($count = 1) No description | ||
| $this | prepend(TValue $value, TKey $key = null)
Push an item onto the beginning of the collection. | |
| $this | push(TValue ...$values)
Push one or more items onto the end of the collection. | |
| $this | unshift(TValue ...$values)
Prepend one or more items to the beginning of the collection. | |
| concat($source) No description | ||
| pull($key, $default = null) No description | ||
| $this | put(TKey $key, TValue $value)
Put an item in the collection by key. | |
| random($number = null, $preserveKeys = false) No description | ||
| 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. | |
| shift($count = 1) No description | ||
| 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)
Slice the underlying collection array. | |
| split($numberOfGroups) No description | ||
| splitIn($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 | ||
| 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. | |
| Collection | sortByMany(array $comparisons = [], int $options = SORT_REGULAR)
Sort the collection using multiple comparisons. | |
| 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. | |
| Collection | splice(int $offset, int|null $length = null, TValue> $replacement = [])
Splice a portion of the underlying collection array. | |
| 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 | transform(callable $callback)
Transform each item in the collection using a callback. | |
| Collection | dot()
Flatten a multi-dimensional associative array with dots. | |
| Enumerable | undot()
Convert a flatten "dot" notation array into an expanded array. | |
| values() No description | ||
| zip($items) No description | ||
| pad($size, $value) No description | ||
| Traversable | getIterator()
Get an iterator for the items. | |
| int | count()
Count the number of items in the collection. | |
| countBy($countBy = null) No description | ||
| $this | add(TValue $item)
Add an item to the collection. | |
| TValue> | toBase()
Get a base Support collection instance from this collection. | |
| bool | offsetExists(TKey $key)
Determine if an item exists at an offset. | |
| mixed | offsetGet(TKey $key)
Get an item at a given offset. | |
| void | offsetSet(TKey|null $key, TValue $value)
Set the item at a given offset. | |
| void | offsetUnset(TKey $key)
Unset the item at a given offset. |
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.
Register a custom macro.
Mix another object into the class.
Checks if macro is registered.
Flush the existing macros.
Dynamically handle calls to the class.
Dynamically handle calls to the class.
Create a new collection.
No description
No description
Get a lazy collection for the items in this collection.
Get the median of a given key.
Get the mode of a given key.
No description
Determine if an item exists in the collection.
Determine if an item exists, using strict comparison.
Determine if an item is not contained in the collection.
No description
Get the items in the collection that are not present in the given items.
Get the items in the collection that are not present in the given items, using the callback.
Get the items in the collection whose keys and values are not present in the given items.
Get the items in the collection whose keys and values are not present in the given items, using the callback.
Get the items in the collection whose keys are not present in the given items.
Get the items in the collection whose keys are not present in the given items, using the callback.
Retrieve duplicate items from the collection.
Retrieve duplicate items from the collection using strict comparison.
Get the comparison function to detect duplicates.
Get all items except for those with the specified keys.
Run a filter over each of the items.
No description
No description
No description
Remove an item from the collection by key.
\Illuminate\Contracts\Support\Arrayable<array-key, TValue>|iterable<array-key, TKey>|TKey $keys
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 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
No description
No description
No description
Merge the collection with the given items.
No description
Multiply the items in the collection by the multiplier.
No description
Union the collection with the given items.
Create a new collection consisting of every n-th element.
Get the items with the specified keys.
Select specific values from the items within the collection.
No description
Push an item onto the beginning of the collection.
Push one or more items onto the end of the collection.
Prepend one or more items to the beginning of the collection.
No description
No description
Put an item in the collection by key.
No description
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.
No description
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.
Slice the underlying collection array.
No description
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
Sort through each item with a callback.
Sort items in descending order.
Sort the collection using the given callback.
Sort the collection using multiple comparisons.
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.
Splice a portion of the underlying collection array.
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.
Transform each item in the collection using a callback.
Flatten a multi-dimensional associative array with dots.
Convert a flatten "dot" notation array into an expanded array.
No description
No description
No description
Get an iterator for the items.
Count the number of items in the collection.
No description
Add an item to the collection.
Get a base Support collection instance from this collection.
Determine if an item exists at an offset.
Get an item at a given offset.
Set the item at a given offset.
Unset the item at a given offset.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Support/Collection.html