| Methods |
public
|
__construct(Arrayable<TKey, TValue>|iterable<TKey, TValue>|null $items = [])
Create a new collection.
|
#
|
public
static
|
range(int $from, int $to, int $step = 1): static<int, int>
Create a collection with the given range.
Create a collection with the given range.
Implements
|
#
|
public
|
all(): array<TKey, TValue>
Get all of the items in the collection.
Get all of the items in the collection.
Implements
|
#
|
public
|
lazy(): LazyCollection<TKey, TValue>
Get a lazy collection for the items in this collection.
Get a lazy collection for the items in this collection.
|
#
|
public
|
median(string|array<array-key, string>|null $key = null): float|int|null
Get the median of a given key.
Get the median of a given key.
Implements
|
#
|
public
|
mode(string|array<array-key, string>|null $key = null): array<int, float|int>|null
Get the mode of a given key.
Get the mode of a given key.
Implements
|
#
|
public
|
collapse(): static<int, mixed>
Collapse the collection of items into a single array.
Collapse the collection of items into a single array.
Overriden by
Implements
|
#
|
public
|
collapseWithKeys(): static<mixed, mixed>
Collapse the collection of items into a single array while preserving its keys.
Collapse the collection of items into a single array while preserving its keys.
|
#
|
public
|
contains((callable(TValue, TKey): bool)|TValue|string $key, mixed $operator = null, mixed $value = null): bool
Determine if an item exists in the collection.
Determine if an item exists in the collection.
Overriden by
Implements
|
#
|
public
|
containsStrict((callable(TValue): bool)|TValue|array-key $key, TValue|null $value = null): bool
Determine if an item exists, using strict comparison.
Determine if an item exists, using strict comparison.
Implements
|
#
|
public
|
doesntContain(mixed $key, mixed $operator = null, mixed $value = null): bool
Determine if an item is not contained in the collection.
Determine if an item is not contained in the collection.
Overriden by
Implements
|
#
|
public
|
crossJoin<TCrossJoinKey, TCrossJoinValue>(
Arrayable<TCrossJoinKey, TCrossJoinValue>|iterable<TCrossJoinKey, TCrossJoinValue> ...$lists,
): static<int, array<int, TValue|TCrossJoinValue>>
Cross join with the given lists, returning all possible permutations.
Cross join with the given lists, returning all possible permutations.
Implements
|
#
|
public
|
diff(Arrayable<array-key, TValue>|iterable<array-key, TValue> $items): static
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.
Overriden by
Implements
|
#
|
public
|
diffUsing(
Arrayable<array-key, TValue>|iterable<array-key, TValue> $items,
callable(TValue, TValue): int $callback,
): static
Get the items in the collection that are not present in the given items, using the callback.
Get the items in the collection that are not present in the given items, using the callback.
Implements
|
#
|
public
|
diffAssoc(Arrayable<TKey, TValue>|iterable<TKey, TValue> $items): static
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.
Implements
|
#
|
public
|
diffAssocUsing(Arrayable<TKey, TValue>|iterable<TKey, TValue> $items, callable(TKey, TKey): int $callback): static
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 and values are not present in the given items, using the callback.
Implements
|
#
|
public
|
diffKeys(Arrayable<TKey, mixed>|iterable<TKey, mixed> $items): static
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.
Implements
|
#
|
public
|
diffKeysUsing(Arrayable<TKey, mixed>|iterable<TKey, mixed> $items, callable(TKey, TKey): int $callback): static
Get the items in the collection whose keys 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, using the callback.
Implements
|
#
|
public
|
duplicates<TMapValue>((callable(TValue): TMapValue)|string|null $callback = null, bool $strict = false): static
Retrieve duplicate items from the collection.
Retrieve duplicate items from the collection.
Implements
|
#
|
public
|
duplicatesStrict<TMapValue>((callable(TValue): TMapValue)|string|null $callback = null): static
Retrieve duplicate items from the collection using strict comparison.
Retrieve duplicate items from the collection using strict comparison.
Implements
|
#
|
protected
|
duplicateComparator(bool $strict): callable(TValue, TValue): bool
Get the comparison function to detect duplicates.
Get the comparison function to detect duplicates.
Overriden by
|
#
|
public
|
except(Enumerable<array-key, TKey>|array<array-key, TKey>|string $keys): static
Get all items except for those with the specified keys.
Get all items except for those with the specified keys.
Overriden by
Implements
|
#
|
public
|
filter((callable(TValue, TKey): bool)|null $callback = null): static
Run a filter over each of the items.
Run a filter over each of the items.
Implements
|
#
|
public
|
first<TFirstDefault>(
(callable(TValue, TKey): bool)|null $callback = null,
TFirstDefault|(Closure(): TFirstDefault) $default = null,
): TValue|TFirstDefault
Get the first item from the collection passing the given truth test.
Get the first item from the collection passing the given truth test.
Implements
|
#
|
public
|
flatten(int $depth = INF): static<int, mixed>
Get a flattened array of the items in the collection.
Get a flattened array of the items in the collection.
Overriden by
Implements
|
#
|
public
|
flip(): static<TValue, TKey>
Flip the items in the collection.
Flip the items in the collection.
Overriden by
Implements
|
#
|
public
|
forget($keys): $this
Remove an item from the collection by key.
Remove an item from the collection by key.
\Illuminate\Contracts\Support\Arrayable<array-key, TValue>|iterable<array-key, TKey>|TKey $keys
|
#
|
public
|
get<TGetDefault>(TKey $key, TGetDefault|(Closure(): TGetDefault) $default = null): TValue|TGetDefault
Get an item from the collection by key.
Get an item from the collection by key.
Implements
|
#
|
public
|
getOrPut<TGetOrPutValue>(mixed $key, TGetOrPutValue|(Closure(): TGetOrPutValue) $value): TValue|TGetOrPutValue
Get an item from the collection by key or add it to collection if it does not exist.
Get an item from the collection by key or add it to collection if it does not exist.
|
#
|
public
|
groupBy<TGroupKey is array-key>(
(callable(TValue, TKey): TGroupKey)|array|string $groupBy,
bool $preserveKeys = false,
): static<($groupBy is string ? array-key : ($groupBy is array ? array-key : TGroupKey)), static<($preserveKeys is true ? TKey : int), ($groupBy is array ? mixed : TValue)>>
Group an associative array by a field or using a callback.
Group an associative array by a field or using a callback.
Implements
|
#
|
public
|
keyBy<TNewKey is array-key>(
(callable(TValue, TKey): TNewKey)|array|string $keyBy,
): static<($keyBy is string ? array-key : ($keyBy is array ? array-key : TNewKey)), TValue>
Key an associative array by a field or using a callback.
Key an associative array by a field or using a callback.
Implements
|
#
|
public
|
has(TKey|array<array-key, TKey> $key): bool
Determine if an item exists in the collection by key.
Determine if an item exists in the collection by key.
Implements
|
#
|
public
|
hasAny(TKey|array<array-key, TKey> $key): bool
Determine if any of the keys exist in the collection.
Determine if any of the keys exist in the collection.
Implements
|
#
|
public
|
implode((callable(TValue, TKey): mixed)|string|null $value, string|null $glue = null): string
Concatenate values of a given key as a string.
Concatenate values of a given key as a string.
Implements
|
#
|
public
|
intersect(Arrayable<TKey, TValue>|iterable<TKey, TValue> $items): static
Intersect the collection with the given items.
Intersect the collection with the given items.
Overriden by
Implements
|
#
|
public
|
intersectUsing(
Arrayable<array-key, TValue>|iterable<array-key, TValue> $items,
callable(TValue, TValue): int $callback,
): static
Intersect the collection with the given items, using the callback.
Intersect the collection with the given items, using the callback.
Implements
|
#
|
public
|
intersectAssoc(Arrayable<TKey, TValue>|iterable<TKey, TValue> $items): static
Intersect the collection with the given items with additional index check.
Intersect the collection with the given items with additional index check.
Implements
|
#
|
public
|
intersectAssocUsing(
Arrayable<array-key, TValue>|iterable<array-key, TValue> $items,
callable(TValue, TValue): int $callback,
): static
Intersect the collection with the given items with additional index check, using the callback.
Intersect the collection with the given items with additional index check, using the callback.
Implements
|
#
|
public
|
intersectByKeys(Arrayable<TKey, mixed>|iterable<TKey, mixed> $items): static
Intersect the collection with the given items by key.
Intersect the collection with the given items by key.
Implements
|
#
|
public
|
isEmpty(): bool
Determine if the collection is empty or not.
Determine if the collection is empty or not.
Implements
|
#
|
public
|
containsOneItem((callable(TValue, TKey): bool)|null $callback = null): bool
Determine if the collection contains exactly one item. If a callback is provided, determine if exactly one item matches…
Determine if the collection contains exactly one item. If a callback is provided, determine if exactly one item matches the condition.
Implements
|
#
|
public
|
join(string $glue, string $finalGlue = ''): string
Join all items from the collection using a string. The final items can use a separate glue string.
Join all items from the collection using a string. The final items can use a separate glue string.
Implements
|
#
|
public
|
keys(): static<int, TKey>
Get the keys of the collection items.
Get the keys of the collection items.
Overriden by
Implements
|
#
|
public
|
last<TLastDefault>(
(callable(TValue, TKey): bool)|null $callback = null,
TLastDefault|(Closure(): TLastDefault) $default = null,
): TValue|TLastDefault
Get the last item from the collection.
Get the last item from the collection.
Implements
|
#
|
public
|
pluck(string|int|array<array-key, string>|null $value, string|null $key = null): static<array-key, mixed>
Get the values of a given key.
Get the values of a given key.
Overriden by
Implements
|
#
|
public
|
map<TMapValue>(callable(TValue, TKey): TMapValue $callback): static<TKey, TMapValue>
Run a map over each of the items.
Run a map over each of the items.
Overriden by
Implements
|
#
|
public
|
mapToDictionary<TMapToDictionaryKey is array-key, TMapToDictionaryValue>(
callable(TValue, TKey): array<TMapToDictionaryKey, TMapToDictionaryValue> $callback,
): static<TMapToDictionaryKey, array<int, TMapToDictionaryValue>>
Run a dictionary map over the items.
Run a dictionary map over the items.
The callback should return an associative array with a single key/value pair.
Implements
|
#
|
public
|
mapWithKeys<TMapWithKeysKey is array-key, TMapWithKeysValue>(
callable(TValue, TKey): array<TMapWithKeysKey, TMapWithKeysValue> $callback,
): static<TMapWithKeysKey, TMapWithKeysValue>
Run an associative map over each of the items.
Run an associative map over each of the items.
The callback should return an associative array with a single key/value pair.
Overriden by
Implements
|
#
|
public
|
merge(Arrayable<TKey, TValue>|iterable<TKey, TValue> $items): static
Merge the collection with the given items.
Merge the collection with the given items.
Overriden by
Implements
|
#
|
public
|
mergeRecursive<TMergeRecursiveValue>(
Arrayable<TKey, TMergeRecursiveValue>|iterable<TKey, TMergeRecursiveValue> $items,
): static<TKey, TValue|TMergeRecursiveValue>
Recursively merge the collection with the given items.
Recursively merge the collection with the given items.
Implements
|
#
|
public
|
multiply(int $multiplier): static
Multiply the items in the collection by the multiplier.
Multiply the items in the collection by the multiplier.
|
#
|
public
|
combine<TCombineValue>(
Arrayable<array-key, TCombineValue>|iterable<array-key, TCombineValue> $values,
): static<TValue, TCombineValue>
Create a collection by using this collection for keys and another for its values.
Create a collection by using this collection for keys and another for its values.
Implements
|
#
|
public
|
union(Arrayable<TKey, TValue>|iterable<TKey, TValue> $items): static
Union the collection with the given items.
Union the collection with the given items.
Implements
|
#
|
public
|
nth(int $step, int $offset = 0): static
Create a new collection consisting of every n-th element.
Create a new collection consisting of every n-th element.
Implements
|
#
|
public
|
only(Enumerable<array-key, TKey>|array<array-key, TKey>|string|null $keys): static
Get the items with the specified keys.
Get the items with the specified keys.
Overriden by
Implements
|
#
|
public
|
select(Enumerable<array-key, TKey>|array<array-key, TKey>|string|null $keys): static
Select specific values from the items within the collection.
Select specific values from the items within the collection.
|
#
|
public
|
pop(int $count = 1): static<int, TValue>|TValue|null
Get and remove the last N items from the collection.
Get and remove the last N items from the collection.
|
#
|
public
|
prepend(TValue $value, TKey $key = null): $this
Push an item onto the beginning of the collection.
Push an item onto the beginning of the collection.
|
#
|
public
|
push(TValue ...$values): $this
Push one or more items onto the end of the collection.
Push one or more items onto the end of the collection.
|
#
|
public
|
unshift(TValue ...$values): $this
Prepend one or more items to the beginning of the collection.
Prepend one or more items to the beginning of the collection.
|
#
|
public
|
concat<TConcatKey is array-key, TConcatValue>(
iterable<TConcatKey, TConcatValue> $source,
): static<TKey|TConcatKey, TValue|TConcatValue>
Push all of the given items onto the collection.
Push all of the given items onto the collection.
Implements
|
#
|
public
|
pull<TPullDefault>(TKey $key, TPullDefault|(Closure(): TPullDefault) $default = null): TValue|TPullDefault
Get and remove an item from the collection.
Get and remove an item from the collection.
|
#
|
public
|
put(TKey $key, TValue $value): $this
Put an item in the collection by key.
Put an item in the collection by key.
|
#
|
public
|
random(
(callable(self<TKey, TValue>): int)|int|null $number = null,
bool $preserveKeys = false,
): static<int, TValue>|TValue
Get one or a specified number of items randomly from the collection.
Get one or a specified number of items randomly from the collection.
Throws
Implements
|
#
|
public
|
replace(Arrayable<TKey, TValue>|iterable<TKey, TValue> $items): static
Replace the collection items with the given items.
Replace the collection items with the given items.
Implements
|
#
|
public
|
replaceRecursive(Arrayable<TKey, TValue>|iterable<TKey, TValue> $items): static
Recursively replace the collection items with the given items.
Recursively replace the collection items with the given items.
Implements
|
#
|
public
|
reverse(): static
Reverse items order.
|
#
|
public
|
search(TValue|(callable(TValue, TKey): bool) $value, bool $strict = false): TKey|false
Search the collection for a given value and return the corresponding key if successful.
Search the collection for a given value and return the corresponding key if successful.
Implements
|
#
|
public
|
before(TValue|(callable(TValue, TKey): bool) $value, bool $strict = false): TValue|null
Get the item before the given item.
Get the item before the given item.
Implements
|
#
|
public
|
after(TValue|(callable(TValue, TKey): bool) $value, bool $strict = false): TValue|null
Get the item after the given item.
Get the item after the given item.
Implements
|
#
|
public
|
shift(int $count = 1): static<int, TValue>|TValue|null
Get and remove the first N items from the collection.
Get and remove the first N items from the collection.
Throws
|
#
|
public
|
shuffle(): static
Shuffle the items in the collection.
Shuffle the items in the collection.
Implements
|
#
|
public
|
sliding(int $size = 2, int $step = 1): static<int, static>
Create chunks representing a "sliding window" view of the items in the collection.
Create chunks representing a "sliding window" view of the items in the collection.
Implements
|
#
|
public
|
skip(int $count): static
Skip the first {$count} items.
Skip the first {$count} items.
Implements
|
#
|
public
|
skipUntil(TValue|(callable(TValue, TKey): bool) $value): static
Skip items in the collection until the given condition is met.
Skip items in the collection until the given condition is met.
Implements
|
#
|
public
|
skipWhile(TValue|(callable(TValue, TKey): bool) $value): static
Skip items in the collection while the given condition is met.
Skip items in the collection while the given condition is met.
Implements
|
#
|
public
|
slice(int $offset, int|null $length = null): static
Slice the underlying collection array.
Slice the underlying collection array.
Implements
|
#
|
public
|
split(int $numberOfGroups): static<int, static>
Split a collection into a certain number of groups.
Split a collection into a certain number of groups.
Implements
|
#
|
public
|
splitIn(int $numberOfGroups): static<int, static>
Split a collection into a certain number of groups, and fill the first groups completely.
Split a collection into a certain number of groups, and fill the first groups completely.
Implements
|
#
|
public
|
sole((callable(TValue, TKey): bool)|string $key = null, mixed $operator = null, mixed $value = null): TValue
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 only if exactly one item exists. Otherwise, throw an exception.
Throws
Implements
|
#
|
public
|
firstOrFail((callable(TValue, TKey): bool)|string $key = null, mixed $operator = null, mixed $value = null): TValue
Get the first item in the collection but throw an exception if no matching items exist.
Get the first item in the collection but throw an exception if no matching items exist.
Throws
Implements
|
#
|
public
|
chunk(
int $size,
bool $preserveKeys = true,
): ($preserveKeys is true ? static<int, static> : static<int, static<int, TValue>>)
Chunk the collection into chunks of the given size.
Chunk the collection into chunks of the given size.
Implements
|
#
|
public
|
chunkWhile(callable(TValue, TKey, static<TKey, TValue>): bool $callback): static<int, static<TKey, TValue>>
Chunk the collection into chunks with a callback.
Chunk the collection into chunks with a callback.
Implements
|
#
|
public
|
sort((callable(TValue, TValue): int)|null|int $callback = null): static
Sort through each item with a callback.
Sort through each item with a callback.
Implements
|
#
|
public
|
sortDesc(int $options = SORT_REGULAR): static
Sort items in descending order.
Sort items in descending order.
Implements
|
#
|
public
|
sortBy(
array<array-key, (callable(TValue, TValue): mixed)|(callable(TValue, TKey): mixed)|string|array{string, string}>|(callable(TValue, TKey): mixed)|string $callback,
int $options = SORT_REGULAR,
bool $descending = false,
): static
Sort the collection using the given callback.
Sort the collection using the given callback.
Implements
|
#
|
protected
|
sortByMany(
array<array-key, (callable(TValue, TValue): mixed)|(callable(TValue, TKey): mixed)|string|array{string, string}> $comparisons = [],
int $options = SORT_REGULAR,
): static
Sort the collection using multiple comparisons.
Sort the collection using multiple comparisons.
|
#
|
public
|
sortByDesc(
array<array-key, (callable(TValue, TValue): mixed)|(callable(TValue, TKey): mixed)|string|array{string, string}>|(callable(TValue, TKey): mixed)|string $callback,
int $options = SORT_REGULAR,
): static
Sort the collection in descending order using the given callback.
Sort the collection in descending order using the given callback.
Implements
|
#
|
public
|
sortKeys(int $options = SORT_REGULAR, bool $descending = false): static
Sort the collection keys.
Sort the collection keys.
Implements
|
#
|
public
|
sortKeysDesc(int $options = SORT_REGULAR): static
Sort the collection keys in descending order.
Sort the collection keys in descending order.
Implements
|
#
|
public
|
sortKeysUsing(callable(TKey, TKey): int $callback): static
Sort the collection keys using a callback.
Sort the collection keys using a callback.
Implements
|
#
|
public
|
splice(int $offset, int|null $length = null, array<array-key, TValue> $replacement = []): static
Splice a portion of the underlying collection array.
Splice a portion of the underlying collection array.
|
#
|
public
|
take(int $limit): static
Take the first or last {$limit} items.
Take the first or last {$limit} items.
Implements
|
#
|
public
|
takeUntil(TValue|(callable(TValue, TKey): bool) $value): static
Take items in the collection until the given condition is met.
Take items in the collection until the given condition is met.
Implements
|
#
|
public
|
takeWhile(TValue|(callable(TValue, TKey): bool) $value): static
Take items in the collection while the given condition is met.
Take items in the collection while the given condition is met.
Implements
|
#
|
public
|
transform(callable(TValue, TKey): TValue $callback): $this
Transform each item in the collection using a callback.
Transform each item in the collection using a callback.
|
#
|
public
|
dot(): static
Flatten a multi-dimensional associative array with dots.
Flatten a multi-dimensional associative array with dots.
|
#
|
public
|
undot(): static
Convert a flatten "dot" notation array into an expanded array.
Convert a flatten "dot" notation array into an expanded array.
Implements
|
#
|
public
|
unique((callable(TValue, TKey): mixed)|string|null $key = null, bool $strict = false): static
Return only unique items from the collection array.
Return only unique items from the collection array.
Overriden by
Implements
|
#
|
public
|
values(): static<int, TValue>
Reset the keys on the underlying array.
Reset the keys on the underlying array.
Implements
|
#
|
public
|
zip<TZipValue>(
Arrayable<array-key, TZipValue>|iterable<array-key, TZipValue> ...$items,
): static<int, static<int, TValue|TZipValue>>
Zip the collection together with one or more arrays.
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]]
Overriden by
Implements
|
#
|
public
|
pad<TPadValue>(int $size, TPadValue $value): static<int, TValue|TPadValue>
Pad collection to the specified length with a value.
Pad collection to the specified length with a value.
Overriden by
Implements
|
#
|
public
|
getIterator(): ArrayIterator<TKey, TValue>
Get an iterator for the items.
Get an iterator for the items.
Implements
|
#
|
public
|
count(): int
Count the number of items in the collection.
Count the number of items in the collection.
Implements
|
#
|
public
|
countBy((callable(TValue, TKey): array-key)|string|null $countBy = null): static<array-key, int>
Count the number of items in the collection by a field or using a callback.
Count the number of items in the collection by a field or using a callback.
Overriden by
Implements
|
#
|
public
|
add(TValue $item): $this
Add an item to the collection.
Add an item to the collection.
|
#
|
public
|
toBase(): Collection<TKey, TValue>
Get a base Support collection instance from this collection.
Get a base Support collection instance from this collection.
|
#
|
public
|
offsetExists(TKey $key): bool
Determine if an item exists at an offset.
Determine if an item exists at an offset.
Implements
|
#
|
public
|
offsetGet(TKey $key): TValue
Get an item at a given offset.
Get an item at a given offset.
Implements
|
#
|
public
|
offsetSet(TKey|null $key, TValue $value): void
Set the item at a given offset.
Set the item at a given offset.
Implements
|
#
|
public
|
offsetUnset(TKey $key): void
Unset the item at a given offset.
Unset the item at a given offset.
Implements
|
#
|