class Collection implements ArrayAccess, Enumerable (View source)

Traits

Properties

static protected array<int,string> $proxies

The methods that can be proxied.

from  EnumeratesValues
HigherOrderCollectionProxy read-only $average from  EnumeratesValues
HigherOrderCollectionProxy read-only $avg from  EnumeratesValues
HigherOrderCollectionProxy read-only $contains from  EnumeratesValues
HigherOrderCollectionProxy read-only $each from  EnumeratesValues
HigherOrderCollectionProxy read-only $every from  EnumeratesValues
HigherOrderCollectionProxy read-only $filter from  EnumeratesValues
HigherOrderCollectionProxy read-only $first from  EnumeratesValues
HigherOrderCollectionProxy read-only $flatMap from  EnumeratesValues
HigherOrderCollectionProxy read-only $groupBy from  EnumeratesValues
HigherOrderCollectionProxy read-only $keyBy from  EnumeratesValues
HigherOrderCollectionProxy read-only $map from  EnumeratesValues
HigherOrderCollectionProxy read-only $max from  EnumeratesValues
HigherOrderCollectionProxy read-only $min from  EnumeratesValues
HigherOrderCollectionProxy read-only $partition from  EnumeratesValues
HigherOrderCollectionProxy read-only $reject from  EnumeratesValues
HigherOrderCollectionProxy read-only $skipUntil from  EnumeratesValues
HigherOrderCollectionProxy read-only $skipWhile from  EnumeratesValues
HigherOrderCollectionProxy read-only $some from  EnumeratesValues
HigherOrderCollectionProxy read-only $sortBy from  EnumeratesValues
HigherOrderCollectionProxy read-only $sortByDesc from  EnumeratesValues
HigherOrderCollectionProxy read-only $sum from  EnumeratesValues
HigherOrderCollectionProxy read-only $takeUntil from  EnumeratesValues
HigherOrderCollectionProxy read-only $takeWhile from  EnumeratesValues
HigherOrderCollectionProxy read-only $unique from  EnumeratesValues
HigherOrderCollectionProxy read-only $unless from  EnumeratesValues
HigherOrderCollectionProxy read-only $until from  EnumeratesValues
HigherOrderCollectionProxy read-only $when from  EnumeratesValues
static protected array $macros

The registered string macros.

from  Macroable
protected $items

Methods

$this|TWhenReturnType
when(bool $value, callable $callback = null, callable $default = null)

Apply the callback if the given "value" is (or resolves to) truthy.

$this|TUnlessReturnType
unless(bool $value, 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 
empty()

No description

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.

bool
containsStrict($key, TValue|null $value = null)

Determine if an item exists, using strict comparison.

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)

No description

bool
every($key, mixed $operator = null, mixed $value = null)

Determine if all items pass the given truth test.

TValue|null
firstWhere(string $key, mixed $operator = null, mixed $value = null)

Get the first item by the given key value pair.

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

TValue
min($callback = null)

Get the min value of a given key.

TValue
max($callback = null)

Get the max value of a given key.

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.

where($key, $operator = null, $value = null)

No description

whereNull($key = null)

No description

whereNotNull($key = null)

No description

whereStrict($key, $value)

No description

whereIn($key, $values, $strict = false)

No description

whereInStrict($key, $values)

No description

whereBetween($key, $values)

No description

whereNotBetween($key, $values)

No description

whereNotIn($key, $values, $strict = false)

No description

whereNotInStrict($key, $values)

No description

whereInstanceOf($type)

No description

TPipeReturnType
pipe(callable $callback)

Pass the collection to the given callback and return the result.

mixed
pipeInto($class)

Pass the collection into a new class.

TReduceReturnType
reduce(callable $callback, TReduceInitial $initial = null)

Reduce the collection to a single value.

TReduceWithKeysReturnType
reduceWithKeys(callable $callback, TReduceWithKeysInitial $initial = null)

Reduce an associative collection to a single value.

reject($callback = true)

No description

$this
tap(callable $callback)

Pass the collection to the given callback and then return it.

unique($key = null, $strict = false)

No description

uniqueStrict($key = null)

No description

TValue>
collect()

Collect the values into a collection.

toArray()

No description

jsonSerialize()

No description

string
toJson(int $options = 0)

Get the collection of items as JSON.

getCachingIterator(int $flags = CachingIterator::CALL_TOSTRING)

Get a CachingIterator instance.

string
__toString()

Convert the collection to its string representation.

static void
proxy(string $method)

Add a method to the list of proxied methods.

mixed
__get(string $key)

Dynamically access collection proxies.

array
getArrayableItems(mixed $items)

Results array of items from Collection or Arrayable.

operatorForWhere(string $key, string|null $operator = null, mixed $value = null)

Get an operator checker callback.

bool
useAsCallable(mixed $value)

Determine if the given value is callable, but not a string.

callable
valueRetriever(callable|string|null $value)

Get a value retrieving callback.

equality(mixed $value)

Make a function to check an item's equality.

negate(Closure $callback)

Make a function using another function, by negating its result.

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 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

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($key = null)

Get the median of a given key.

array<int,float|int>|null
mode($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.

crossJoin(...$lists)

No description

diff($items)

No description

diffUsing($items, callable $callback)

No description

diffAssoc($items)

No description

diffAssocUsing($items, callable $callback)

No description

diffKeys($items)

No description

diffKeysUsing($items, callable $callback)

No description

duplicates($callback = null, $strict = false)

No description

duplicatesStrict($callback = null)

No description

duplicateComparator(bool $strict)

Get the comparison function to detect duplicates.

except($keys)

No description

filter(callable $callback = null)

No description

TValue|TFirstDefault
first(callable $callback = null, TFirstDefault $default = null)

Get the first item from the collection passing the given truth test.

flatten($depth = INF)

No description

flip()

No description

$this
forget($keys)

Remove an item from the collection by key.

TValue|TGetDefault
get(TKey $key, TGetDefault $default = null)

Get an item from the collection by key.

groupBy($groupBy, $preserveKeys = false)

No description

keyBy($keyBy)

No description

bool
has($key)

Determine if an item exists in the collection by key.

string
implode(string $value, string|null $glue = null)

Concatenate values of a given key as a string.

intersect($items)

No description

intersectByKeys($items)

No description

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

TValue|TLastDefault
last(callable $callback = null, TLastDefault $default = null)

Get the last item from the collection.

pluck($value, $key = null)

No description

map(callable $callback)

No description

mapToDictionary(callable $callback)

No description

mapWithKeys(callable $callback)

No description

merge($items)

No description

mergeRecursive($items)

No description

combine($values)

No description

union($items)

No description

nth($step, $offset = 0)

No description

only($keys)

No description

pop($count = 1)

No description

$this
prepend(TValue $value, TKey $key = null)

Push an item onto the beginning of the collection.

$this
push(...$values)

Push one or more items onto the end of the collection.

concat($source)

No description

TValue|TPullDefault
pull(TKey $key, 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.

random($number = null)

No description

replace($items)

No description

replaceRecursive($items)

No description

reverse()

No description

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

shuffle($seed = null)

No description

sliding($size = 2, $step = 1)

No description

skip($count)

No description

skipUntil($value)

No description

skipWhile($value)

No description

slice($offset, $length = null)

No description

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.

mixed
firstOrFail(mixed $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

sort($callback = null)

No description

sortDesc($options = SORT_REGULAR)

No description

sortBy($callback, $options = SORT_REGULAR, $descending = false)

No description

sortByMany(array $comparisons = [])

Sort the collection using multiple comparisons.

sortByDesc($callback, $options = SORT_REGULAR)

No description

sortKeys($options = SORT_REGULAR, $descending = false)

No description

sortKeysDesc($options = SORT_REGULAR)

No description

splice($offset, $length = null, $replacement = [])

No description

take($limit)

No description

takeUntil($value)

No description

takeWhile($value)

No description

$this
transform(callable $callback)

Transform each item in the collection using a callback.

values()

No description

zip($items)

No description

pad($size, $value)

No description

TValue>
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.

TValue
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(bool $value, callable $callback = null, callable $default = null)

Apply the callback if the given "value" is (or resolves to) truthy.

Parameters

bool $value
callable $callback
callable $default

Return Value

$this|TWhenReturnType

$this|TUnlessReturnType unless(bool $value, callable $callback = null, callable $default = null)

Apply the callback if the given "value" is (or resolves to) falsy.

Parameters

bool $value
callable $callback
callable $default

Return Value

$this|TUnlessReturnType

static make($items = [])

No description

Parameters

$items

static wrap($value)

No description

Parameters

$value

static unwrap($value)

No description

Parameters

$value

static empty()

No description

static times($number, callable $callback = null)

No description

Parameters

$number
callable $callback

float|int|null average($callback = null)

Alias for the "avg" method.

Parameters

$callback

Return Value

float|int|null

bool some($key, mixed $operator = null, mixed $value = null)

Alias for the "contains" method.

Parameters

$key
mixed $operator
mixed $value

Return Value

bool

bool containsStrict($key, TValue|null $value = null)

Determine if an item exists, using strict comparison.

Parameters

$key
TValue|null $value

Return Value

bool

never dd(mixed ...$args)

Dump the items and end the script.

Parameters

mixed ...$args

Return Value

never

$this dump()

Dump the items.

Return Value

$this

$this each(callable $callback)

Execute a callback over each item.

Parameters

callable $callback

Return Value

$this

eachSpread(callable $callback)

No description

Parameters

callable $callback

bool every($key, mixed $operator = null, mixed $value = null)

Determine if all items pass the given truth test.

Parameters

$key
mixed $operator
mixed $value

Return Value

bool

TValue|null firstWhere(string $key, mixed $operator = null, mixed $value = null)

Get the first item by the given key value pair.

Parameters

string $key
mixed $operator
mixed $value

Return Value

TValue|null

bool isNotEmpty()

Determine if the collection is not empty.

Return Value

bool

mapSpread(callable $callback)

No description

Parameters

callable $callback

mapToGroups(callable $callback)

No description

Parameters

callable $callback

flatMap(callable $callback)

No description

Parameters

callable $callback

mapInto($class)

No description

Parameters

$class

TValue min($callback = null)

Get the min value of a given key.

Parameters

$callback

Return Value

TValue

TValue max($callback = null)

Get the max value of a given key.

Parameters

$callback

Return Value

TValue

EnumeratesValues forPage(int $page, int $perPage)

"Paginate" the collection by slicing it into a smaller collection.

Parameters

int $page
int $perPage

Return Value

EnumeratesValues

partition($key, $operator = null, $value = null)

No description

Parameters

$key
$operator
$value

mixed sum($callback = null)

Get the sum of the given values.

Parameters

$callback

Return Value

mixed

$this|TWhenEmptyReturnType whenEmpty(callable $callback, callable $default = null)

Apply the callback if the collection is empty.

Parameters

callable $callback
callable $default

Return Value

$this|TWhenEmptyReturnType

$this|TWhenNotEmptyReturnType whenNotEmpty(callable $callback, callable $default = null)

Apply the callback if the collection is not empty.

Parameters

callable $callback
callable $default

Return Value

$this|TWhenNotEmptyReturnType

$this|TUnlessEmptyReturnType unlessEmpty(callable $callback, callable $default = null)

Apply the callback unless the collection is empty.

Parameters

callable $callback
callable $default

Return Value

$this|TUnlessEmptyReturnType

$this|TUnlessNotEmptyReturnType unlessNotEmpty(callable $callback, callable $default = null)

Apply the callback unless the collection is not empty.

Parameters

callable $callback
callable $default

Return Value

$this|TUnlessNotEmptyReturnType

where($key, $operator = null, $value = null)

No description

Parameters

$key
$operator
$value

whereNull($key = null)

No description

Parameters

$key

whereNotNull($key = null)

No description

Parameters

$key

whereStrict($key, $value)

No description

Parameters

$key
$value

whereIn($key, $values, $strict = false)

No description

Parameters

$key
$values
$strict

whereInStrict($key, $values)

No description

Parameters

$key
$values

whereBetween($key, $values)

No description

Parameters

$key
$values

whereNotBetween($key, $values)

No description

Parameters

$key
$values

whereNotIn($key, $values, $strict = false)

No description

Parameters

$key
$values
$strict

whereNotInStrict($key, $values)

No description

Parameters

$key
$values

whereInstanceOf($type)

No description

Parameters

$type

TPipeReturnType pipe(callable $callback)

Pass the collection to the given callback and return the result.

Parameters

callable $callback

Return Value

TPipeReturnType

mixed pipeInto($class)

Pass the collection into a new class.

Parameters

$class

Return Value

mixed

TReduceReturnType reduce(callable $callback, TReduceInitial $initial = null)

Reduce the collection to a single value.

Parameters

callable $callback
TReduceInitial $initial

Return Value

TReduceReturnType

TReduceWithKeysReturnType reduceWithKeys(callable $callback, TReduceWithKeysInitial $initial = null)

Reduce an associative collection to a single value.

Parameters

callable $callback
TReduceWithKeysInitial $initial

Return Value

TReduceWithKeysReturnType

reject($callback = true)

No description

Parameters

$callback

$this tap(callable $callback)

Pass the collection to the given callback and then return it.

Parameters

callable $callback

Return Value

$this

unique($key = null, $strict = false)

No description

Parameters

$key
$strict

uniqueStrict($key = null)

No description

Parameters

$key

TValue> collect()

Collect the values into a collection.

Return Value

TValue>

toArray()

No description

jsonSerialize()

No description

string toJson(int $options = 0)

Get the collection of items as JSON.

Parameters

int $options

Return Value

string

CachingIterator getCachingIterator(int $flags = CachingIterator::CALL_TOSTRING)

Get a CachingIterator instance.

Parameters

int $flags

Return Value

CachingIterator

string __toString()

Convert the collection to its string representation.

Return Value

string

static void proxy(string $method)

Add a method to the list of proxied methods.

Parameters

string $method

Return Value

void

mixed __get(string $key)

Dynamically access collection proxies.

Parameters

string $key

Return Value

mixed

Exceptions

Exception

protected array getArrayableItems(mixed $items)

Results array of items from Collection or Arrayable.

Parameters

mixed $items

Return Value

array

protected Closure operatorForWhere(string $key, string|null $operator = null, mixed $value = null)

Get an operator checker callback.

Parameters

string $key
string|null $operator
mixed $value

Return Value

Closure

protected bool useAsCallable(mixed $value)

Determine if the given value is callable, but not a string.

Parameters

mixed $value

Return Value

bool

protected callable valueRetriever(callable|string|null $value)

Get a value retrieving callback.

Parameters

callable|string|null $value

Return Value

callable

protected Closure equality(mixed $value)

Make a function to check an item's equality.

Parameters

mixed $value

Return Value

Closure

protected Closure negate(Closure $callback)

Make a function using another function, by negating its result.

Parameters

Closure $callback

Return Value

Closure

protected Closure identity()

Make a function that returns what's passed to it.

Return Value

Closure

static void macro(string $name, object|callable $macro)

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

void __construct(TValue>|TValue>|null $items = [])

Create a new collection.

Parameters

TValue>|TValue>|null $items

Return Value

void

static Enumerable range(int $from, int $to)

No description

Parameters

int $from
int $to

Return Value

Enumerable

array all()

No description

Return Value

array

LazyCollection lazy()

Get a lazy collection for the items in this collection.

Return Value

LazyCollection

float|int|null avg($callback = null)

Get the average value of a given key.

Parameters

$callback

Return Value

float|int|null

float|int|null median($key = null)

Get the median of a given key.

Parameters

$key

Return Value

float|int|null

array<int,float|int>|null mode($key = null)

Get the mode of a given key.

Parameters

$key

Return Value

array<int,float|int>|null

collapse()

No description

bool contains($key, mixed $operator = null, mixed $value = null)

Determine if an item exists in the collection.

Parameters

$key
mixed $operator
mixed $value

Return Value

bool

crossJoin(...$lists)

No description

Parameters

...$lists

diff($items)

No description

Parameters

$items

diffUsing($items, callable $callback)

No description

Parameters

$items
callable $callback

diffAssoc($items)

No description

Parameters

$items

diffAssocUsing($items, callable $callback)

No description

Parameters

$items
callable $callback

diffKeys($items)

No description

Parameters

$items

diffKeysUsing($items, callable $callback)

No description

Parameters

$items
callable $callback

duplicates($callback = null, $strict = false)

No description

Parameters

$callback
$strict

duplicatesStrict($callback = null)

No description

Parameters

$callback

protected duplicateComparator(bool $strict)

Get the comparison function to detect duplicates.

Parameters

bool $strict

except($keys)

No description

Parameters

$keys

filter(callable $callback = null)

No description

Parameters

callable $callback

TValue|TFirstDefault first(callable $callback = null, TFirstDefault $default = null)

Get the first item from the collection passing the given truth test.

Parameters

callable $callback
TFirstDefault $default

Return Value

TValue|TFirstDefault

flatten($depth = INF)

No description

Parameters

$depth

flip()

No description

$this forget($keys)

Remove an item from the collection by key.

Parameters

$keys

Return Value

$this

TValue|TGetDefault get(TKey $key, TGetDefault $default = null)

Get an item from the collection by key.

Parameters

TKey $key
TGetDefault $default

Return Value

TValue|TGetDefault

groupBy($groupBy, $preserveKeys = false)

No description

Parameters

$groupBy
$preserveKeys

keyBy($keyBy)

No description

Parameters

$keyBy

bool has($key)

Determine if an item exists in the collection by key.

Parameters

$key

Return Value

bool

string implode(string $value, string|null $glue = null)

Concatenate values of a given key as a string.

Parameters

string $value
string|null $glue

Return Value

string

intersect($items)

No description

Parameters

$items

intersectByKeys($items)

No description

Parameters

$items

bool isEmpty()

Determine if the collection is empty or not.

Return Value

bool

bool containsOneItem()

Determine if the collection contains a single item.

Return Value

bool

string join(string $glue, string $finalGlue = '')

Join all items from the collection using a string. The final items can use a separate glue string.

Parameters

string $glue
string $finalGlue

Return Value

string

keys()

No description

TValue|TLastDefault last(callable $callback = null, TLastDefault $default = null)

Get the last item from the collection.

Parameters

callable $callback
TLastDefault $default

Return Value

TValue|TLastDefault

pluck($value, $key = null)

No description

Parameters

$value
$key

map(callable $callback)

No description

Parameters

callable $callback

mapToDictionary(callable $callback)

No description

Parameters

callable $callback

mapWithKeys(callable $callback)

No description

Parameters

callable $callback

merge($items)

No description

Parameters

$items

mergeRecursive($items)

No description

Parameters

$items

combine($values)

No description

Parameters

$values

union($items)

No description

Parameters

$items

nth($step, $offset = 0)

No description

Parameters

$step
$offset

only($keys)

No description

Parameters

$keys

pop($count = 1)

No description

Parameters

$count

$this prepend(TValue $value, TKey $key = null)

Push an item onto the beginning of the collection.

Parameters

TValue $value
TKey $key

Return Value

$this

$this push(...$values)

Push one or more items onto the end of the collection.

Parameters

...$values

Return Value

$this

concat($source)

No description

Parameters

$source

TValue|TPullDefault pull(TKey $key, TPullDefault $default = null)

Get and remove an item from the collection.

Parameters

TKey $key
TPullDefault $default

Return Value

TValue|TPullDefault

$this put(TKey $key, TValue $value)

Put an item in the collection by key.

Parameters

TKey $key
TValue $value

Return Value

$this

random($number = null)

No description

Parameters

$number

replace($items)

No description

Parameters

$items

replaceRecursive($items)

No description

Parameters

$items

reverse()

No description

Search the collection for a given value and return the corresponding key if successful.

Parameters

$value
bool $strict

Return Value

TKey|bool

shift($count = 1)

No description

Parameters

$count

shuffle($seed = null)

No description

Parameters

$seed

sliding($size = 2, $step = 1)

No description

Parameters

$size
$step

skip($count)

No description

Parameters

$count

skipUntil($value)

No description

Parameters

$value

skipWhile($value)

No description

Parameters

$value

slice($offset, $length = null)

No description

Parameters

$offset
$length

split($numberOfGroups)

No description

Parameters

$numberOfGroups

splitIn($numberOfGroups)

No description

Parameters

$numberOfGroups

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.

Parameters

$key
mixed $operator
mixed $value

Return Value

TValue

Exceptions

ItemNotFoundException
MultipleItemsFoundException

mixed firstOrFail(mixed $key = null, mixed $operator = null, mixed $value = null)

Get the first item in the collection but throw an exception if no matching items exist.

Parameters

mixed $key
mixed $operator
mixed $value

Return Value

mixed

Exceptions

ItemNotFoundException

chunk($size)

No description

Parameters

$size

chunkWhile(callable $callback)

No description

Parameters

callable $callback

sort($callback = null)

No description

Parameters

$callback

sortDesc($options = SORT_REGULAR)

No description

Parameters

$options

sortBy($callback, $options = SORT_REGULAR, $descending = false)

No description

Parameters

$callback
$options
$descending

protected Collection sortByMany(array $comparisons = [])

Sort the collection using multiple comparisons.

Parameters

array $comparisons

Return Value

Collection

sortByDesc($callback, $options = SORT_REGULAR)

No description

Parameters

$callback
$options

sortKeys($options = SORT_REGULAR, $descending = false)

No description

Parameters

$options
$descending

sortKeysDesc($options = SORT_REGULAR)

No description

Parameters

$options

splice($offset, $length = null, $replacement = [])

No description

Parameters

$offset
$length
$replacement

take($limit)

No description

Parameters

$limit

takeUntil($value)

No description

Parameters

$value

takeWhile($value)

No description

Parameters

$value

$this transform(callable $callback)

Transform each item in the collection using a callback.

Parameters

callable $callback

Return Value

$this

values()

No description

zip($items)

No description

Parameters

$items

pad($size, $value)

No description

Parameters

$size
$value

TValue> getIterator()

Get an iterator for the items.

Return Value

TValue>

int count()

Count the number of items in the collection.

Return Value

int

countBy($countBy = null)

No description

Parameters

$countBy

$this add(TValue $item)

Add an item to the collection.

Parameters

TValue $item

Return Value

$this

TValue> toBase()

Get a base Support collection instance from this collection.

Return Value

TValue>

bool offsetExists(TKey $key)

Determine if an item exists at an offset.

Parameters

TKey $key

Return Value

bool

TValue offsetGet(TKey $key)

Get an item at a given offset.

Parameters

TKey $key

Return Value

TValue

void offsetSet(TKey|null $key, TValue $value)

Set the item at a given offset.

Parameters

TKey|null $key
TValue $value

Return Value

void

void offsetUnset(TKey $key)

Unset the item at a given offset.

Parameters

TKey $key

Return Value

void