Collection
class Collection implements ArrayAccess, CanBeEscapedWhenCastToString, Enumerable (View source)
Traits
Properties
Methods
Apply the callback if the given "value" is (or resolves to) truthy.
Apply the callback if the given "value" is (or resolves to) falsy.
Create a new collection instance if the value isn't one already.
Wrap the given value in a collection if applicable.
Get the underlying items from the given collection if applicable.
Create a new collection by invoking the callback a given amount of times.
Alias for the "avg" method.
Alias for the "contains" method.
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.
Get a single key's value from the first matching item in the collection.
Run a map over each nested chunk of items.
Run a grouping map over the items.
Map a collection and flatten the result by a single level.
Map the values into a new class.
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.
Partition the collection into two arrays using the given callback or key.
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.
Filter the items, removing any items that don't match the given type(s).
Pass the collection to the given callback and return the result.
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.
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.
Get a CachingIterator instance.
Indicate that the model's string representation should be escaped when __toString is invoked.
Add a method to the list of proxied methods.
Results array of items from Collection or Arrayable.
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.
Mix another object into the class.
Dynamically handle calls to the class.
Dynamically handle calls to the class.
Create a new collection.
Create a collection with the given range.
Get all of the items in the collection.
Get a lazy collection for the items in this collection.
Get the average value of a given key.
Get the median of a given key.
Get the mode of a given key.
Collapse the collection of items into a single array.
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.
Cross join with the given lists, returning all possible permutations.
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.
Get the first item from the collection passing the given truth test.
Get a flattened array of the items in the collection.
Flip the items in the collection.
Remove an item from the collection by key.
Get an item from the collection by key.
Get an item from the collection by key or add it to collection if it does not exist.
Group an associative array by a field or using a callback.
Key an associative array by a field or using a callback.
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.
Get the keys of the collection items.
Get the last item from the collection.
Get the values of a given key.
Run a map over each of the items.
Run a dictionary map over the items.
Run an associative map over each of the items.
Merge the collection with the given items.
Recursively merge the collection with the given items.
Create a collection by using this collection for keys and another for its values.
Union the collection with the given items.
Create a new collection consisting of every n-th element.
Get the items with the specified keys.
Get and remove the last N items from the collection.
Push an item onto the beginning of the collection.
Push one or more items onto the end of the collection.
Push all of the given items onto the collection.
Get and remove an item from the collection.
Put an item in the collection by key.
Get one or a specified number of items randomly from the collection.
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 and remove the first N items from the collection.
Shuffle the items in the collection.
Create chunks representing a "sliding window" view of the items in the collection.
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.
Split a collection into a certain number of groups.
Split a collection into a certain number of groups, and fill the first groups completely.
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.
Chunk the collection into chunks of the given size.
Chunk the collection into chunks with a callback.
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.
Convert a flatten "dot" notation array into an expanded array.
Reset the keys on the underlying array.
Zip the collection together with one or more arrays.
Pad collection to the specified length with a value.
Get an iterator for the items.
Count the number of items in the collection.
Count the number of items in the collection by a field or using a callback.
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.
Details
$this|TWhenReturnType
when(TWhenParameter|TWhenParameter|null $value = null, callable|null $callback = null, callable|null $default = null)
Apply the callback if the given "value" is (or resolves to) truthy.
$this|TUnlessReturnType
unless(TUnlessParameter|TUnlessParameter|null $value = null, callable|null $callback = null, callable|null $default = null)
Apply the callback if the given "value" is (or resolves to) falsy.
static TMakeValue>
make(TMakeValue>|TMakeValue>|null $items = [])
Create a new collection instance if the value isn't one already.
static TWrapValue>
wrap(TWrapValue>|TWrapValue $value)
Wrap the given value in a collection if applicable.
static TUnwrapValue>
unwrap(TUnwrapValue>|TUnwrapValue> $value)
Get the underlying items from the given collection if applicable.
static EnumeratesValues
empty()
Create a new instance with no items.
static TTimesValue>
times(int $number, callable|null $callback = null)
Create a new collection by invoking the callback a given amount of times.
float|int|null
average(TValue): float|int)|string|null $callback = null)
Alias for the "avg" method.
bool
some(TKey): bool|TValue|string $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.
eachSpread(callable $callback)
Execute a callback over each nested chunk of items.
bool
every(TKey): bool|TValue|string $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.
mixed
value(string $key, mixed $default = null)
Get a single key's value from the first matching item in the collection.
bool
isNotEmpty()
Determine if the collection is not empty.
TMapSpreadValue>
mapSpread(callable $callback)
Run a map over each nested chunk of items.
TMapToGroupsValue>>
mapToGroups(callable $callback)
Run a grouping map over the items.
The callback should return an associative array with a single key/value pair.
TFlatMapValue>
flatMap(callable $callback)
Map a collection and flatten the result by a single level.
TMapIntoValue>
mapInto(TMapIntoValue> $class)
Map the values into a new class.
mixed
min(TValue): mixed|string|null $callback = null)
Get the min value of a given key.
mixed
max(TValue): mixed|string|null $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.
TValue>>
partition(TKey): bool|TValue|string $key, TValue|string|null $operator = null, TValue|null $value = null)
Partition the collection into two arrays using the given callback or key.
mixed
sum(TValue): mixed|string|null $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.
TWhereInstanceOf>
whereInstanceOf(TWhereInstanceOf>|TWhereInstanceOf>> $type)
Filter the items, removing any items that don't match the given type(s).
TPipeReturnType
pipe(callable $callback)
Pass the collection to the given callback and return the result.
mixed
pipeInto(class-string $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.
EnumeratesValues
reject(TKey): bool|bool|TValue $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(TKey): mixed|string|null $key = null, bool $strict = false)
Return only unique items from the collection array.
EnumeratesValues
uniqueStrict(TKey): mixed|string|null $key = null)
Return only unique items from the collection array using strict comparison.
TValue>
collect()
Collect the values into a collection.
TKey, mixed>
toArray()
Get the collection of items as a plain array.
array
jsonSerialize()
Convert the object into something JSON serializable.
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 TValue>
getArrayableItems(mixed $items)
Results array of items from Collection or Arrayable.
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 Closure(mixed): bool
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 TValue
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)
Create a collection with the given range.
array
all()
Get all of the items in the collection.
TValue>
lazy()
Get a lazy collection for the items in this collection.
float|int|null
avg(TValue): float|int)|string|null $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.
static<int, mixed>
collapse()
Collapse the collection of items into a single array.
bool
contains(TKey): bool|TValue|string $key, mixed $operator = null, mixed $value = null)
Determine if an item exists in the collection.
bool
containsStrict(TValue): bool|TValue|(array-key) $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.
TValue|TCrossJoinValue>>
crossJoin(TCrossJoinValue>|TCrossJoinValue> ...$lists)
Cross join with the given lists, returning all possible permutations.
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(TValue): bool|string|null $callback = null, bool $strict = false)
Retrieve duplicate items from the collection.
Enumerable
duplicatesStrict(TValue): bool|string|null $callback = null)
Retrieve duplicate items from the collection using strict comparison.
protected TValue): bool
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.
TValue|TFirstDefault
first(callable|null $callback = null, TFirstDefault|TFirstDefault $default = null)
Get the first item from the collection passing the given truth test.
Enumerable
flatten(int $depth = INF)
Get a flattened array of the items in the collection.
TKey>
flip()
Flip the items in the collection.
$this
forget(TKey|TKey> $keys)
Remove an item from the collection by key.
TValue|TGetDefault
get(TKey $key, TGetDefault|TGetDefault $default = null)
Get an item from the collection by key.
mixed
getOrPut(mixed $key, mixed $value)
Get an item from the collection by key or add it to collection if it does not exist.
TValue>>
groupBy(TKey): array-key|array|string $groupBy, bool $preserveKeys = false)
Group an associative array by a field or using a callback.
TValue>
keyBy(TKey): array-key|array|string $keyBy)
Key an associative array by a field or using a callback.
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(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.
TKey>
keys()
Get the keys of the collection items.
TValue|TLastDefault
last(callable|null $callback = null, TLastDefault|TLastDefault $default = null)
Get the last item from the collection.
static<int, mixed>
pluck(string|array<array-key, string> $value, string|null $key = null)
Get the values of a given key.
TMapValue>
map(callable $callback)
Run a map over each of the items.
TMapToDictionaryValue>>
mapToDictionary(callable $callback)
Run a dictionary map over the items.
The callback should return an associative array with a single key/value pair.
TMapWithKeysValue>
mapWithKeys(callable $callback)
Run an associative map over each of the items.
The callback should return an associative array with a single key/value pair.
Enumerable
merge(TValue>|TValue> $items)
Merge the collection with the given items.
TValue|TMergeRecursiveValue>
mergeRecursive(TMergeRecursiveValue>|TMergeRecursiveValue> $items)
Recursively merge the collection with the given items.
TCombineValue>
combine(TCombineValue>|TCombineValue> $values)
Create a collection by using this collection for keys and another for its values.
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.
TValue>|TValue|null
pop(int $count = 1)
Get and remove the last N items from the collection.
$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.
TValue|TPullDefault
pull(TKey $key, TPullDefault|TPullDefault $default = null)
Get and remove an item from the collection.
$this
put(TKey $key, TValue $value)
Put an item in the collection by key.
TValue>|TValue
random(int|null $number = null)
Get one or a specified number of items randomly from the collection.
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(TValue|TKey): bool $value, bool $strict = false)
Search the collection for a given value and return the corresponding key if successful.
TValue>|TValue|null
shift(int $count = 1)
Get and remove the first N items from the collection.
Enumerable
shuffle(int|null $seed = null)
Shuffle the items in the collection.
static<int, static>
sliding(int $size = 2, int $step = 1)
Create chunks representing a "sliding window" view of the items in the collection.
Enumerable
skip(int $count)
Skip the first {$count} items.
Enumerable
skipUntil(TValue|TKey): bool $value)
Skip items in the collection until the given condition is met.
Enumerable
skipWhile(TValue|TKey): bool $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.
static<int, static>
split(int $numberOfGroups)
Split a collection into a certain number of groups.
static<int, static>
splitIn(int $numberOfGroups)
Split a collection into a certain number of groups, and fill the first groups completely.
TValue
sole(TKey): bool|string $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(TKey): bool|string $key = null, mixed $operator = null, mixed $value = null)
Get the first item in the collection but throw an exception if no matching items exist.
static<int, static>
chunk(int $size)
Chunk the collection into chunks of the given size.
TValue>>
chunkWhile(callable $callback)
Chunk the collection into chunks with a callback.
Enumerable
sort(TValue): int|null|int $callback = null)
Sort through each item with a callback.
Enumerable
sortDesc(int $options = SORT_REGULAR)
Sort items in descending order.
Enumerable
sortBy(TValue): mixed|TKey): mixed|string|array{string, string}>|TKey): mixed|string $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(TValue): mixed|TKey): mixed|string|array{string, string}>|TKey): mixed|string $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(TValue|TKey): bool $value)
Take items in the collection until the given condition is met.
Enumerable
takeWhile(TValue|TKey): bool $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.
Enumerable
undot()
Convert a flatten "dot" notation array into an expanded array.
TValue>
values()
Reset the keys on the underlying array.
TValue|TZipValue>>
zip(TZipValue>|TZipValue> $items)
Zip the collection together with one or more arrays.
e.g. new Collection([1, 2, 3])->zip([4, 5, 6]); => [[1, 4], [2, 5], [3, 6]]
TValue|TPadValue>
pad(int $size, TPadValue $value)
Pad collection to the specified length with a value.
Traversable
getIterator()
Get an iterator for the items.
int
count()
Count the number of items in the collection.
static<array-key, int>
countBy(TKey): array-key|string|null $countBy = null)
Count the number of items in the collection by a field or using a callback.
$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.