Collection
class Collection implements ArrayAccess, CanBeEscapedWhenCastToString, Enumerable (View source)
Traits
Properties
Methods
| $this|TWhenReturnType | when($value = null, callable $callback = null, callable $default = null) Apply the callback if the given "value" is (or resolves to) truthy. |
from Conditionable |
| $this|TUnlessReturnType | unless($value = null, callable $callback = null, callable $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 $callback = null) No description |
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 items and end the script. |
from EnumeratesValues |
| $this | dump() 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 | |
| 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 | |
| mixed | sum($callback = null) Get the sum of the given values. |
from EnumeratesValues |
| $this|TWhenEmptyReturnType | whenEmpty(callable $callback, callable $default = null) Apply the callback if the collection is empty. |
from EnumeratesValues |
| $this|TWhenNotEmptyReturnType | whenNotEmpty(callable $callback, callable $default = null) Apply the callback if the collection is not empty. |
from EnumeratesValues |
| $this|TUnlessEmptyReturnType | unlessEmpty(callable $callback, callable $default = null) Apply the callback unless the collection is empty. |
from EnumeratesValues |
| $this|TUnlessNotEmptyReturnType | unlessNotEmpty(callable $callback, callable $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 | avg($callback = null) Get the average value of a given key. |
|
| 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 $callback = null) Run a filter over each of the items. |
|
| first(callable $callback = null, $default = null) No description |
||
| Enumerable | flatten(int $depth = INF) No description |
|
| flip() No description |
||
| $this | forget(TKey|TKey> $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. |
|
| Collection | intersectUsing(TValue>|TValue> $items, callable $callback) Intersect the collection with the given items, using the callback. |
|
| Collection | intersectAssoc(TValue>|TValue> $items) Intersect the collection with the given items with additional index check. |
|
| Collection | 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 $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 |
||
| 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. |
|
| 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. |
|
| Enumerable | concat(TValue> $source) Push all of the given items onto the collection. |
|
| 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. |
|
| shift($count = 1) No description |
||
| Enumerable | shuffle(int|null $seed = null) 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 = []) 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. |
Details
$this|TWhenReturnType when($value = null, callable $callback = null, callable $default = null)
Apply the callback if the given "value" is (or resolves to) truthy.
$this|TUnlessReturnType unless($value = null, callable $callback = null, callable $default = null)
Apply the callback if the given "value" is (or resolves to) falsy.
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 $callback = null)
No description
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 items and end the script.
$this dump()
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
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
mixed sum($callback = null)
Get the sum of the given values.
$this|TWhenEmptyReturnType whenEmpty(callable $callback, callable $default = null)
Apply the callback if the collection is empty.
$this|TWhenNotEmptyReturnType whenNotEmpty(callable $callback, callable $default = null)
Apply the callback if the collection is not empty.
$this|TUnlessEmptyReturnType unlessEmpty(callable $callback, callable $default = null)
Apply the callback unless the collection is empty.
$this|TUnlessNotEmptyReturnType unlessNotEmpty(callable $callback, callable $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.
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.
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.
protected getArrayableItems($items)
No description
protected Closure operatorForWhere(callable|string $key, string|null $operator = null, mixed $value = null)
Get an operator checker callback.
protected bool useAsCallable(mixed $value)
Determine if the given value is callable, but not a string.
protected callable valueRetriever(callable|string|null $value)
Get a value retrieving callback.
protected equality(mixed $value)
Make a function to check an item's equality.
protected Closure negate(Closure $callback)
Make a function using another function, by negating its result.
protected identity()
Make a function that returns what's passed to it.
static void macro(string $name, object|callable $macro)
Register a custom macro.
static void mixin(object $mixin, bool $replace = true)
Mix another object into the class.
static bool hasMacro(string $name)
Checks if macro is registered.
static void flushMacros()
Flush the existing macros.
static mixed __callStatic(string $method, array $parameters)
Dynamically handle calls to the class.
mixed __call(string $method, array $parameters)
Dynamically handle calls to the class.
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 avg($callback = null)
Get the average value of a given key.
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.
protected 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 $callback = null)
Run a filter over each of the items.
first(callable $callback = null, $default = null)
No description
Enumerable flatten(int $depth = INF)
No description
flip()
No description
$this forget(TKey|TKey> $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.
Collection intersectUsing(TValue>|TValue> $items, callable $callback)
Intersect the collection with the given items, using the callback.
Collection intersectAssoc(TValue>|TValue> $items)
Intersect the collection with the given items with additional index check.
Collection 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 $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
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.
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.
Enumerable concat(TValue> $source)
Push all of the given items onto the collection.
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.
shift($count = 1)
No description
Enumerable shuffle(int|null $seed = null)
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.
protected Collection sortByMany(array $comparisons = [])
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.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Support/Collection.html