class Collection implements ArrayAccess, Arrayable, Countable, IteratorAggregate, Jsonable, JsonSerializable (View source)

Traits

Methods

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

Register a custom macro.

from Macroable
static bool
hasMacro(string $name)

Checks if macro is registered.

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(mixed $items = array())

Create a new collection.

static Collection
make(mixed $items = array())

Create a new collection instance if the value isn't one already.

static Collection
times(int $amount, callable $callback)

Create a new collection by invoking the callback a given amount of times.

array
all()

Get all of the items in the collection.

mixed
avg(callable|string|null $callback = null)

Get the average value of a given key.

mixed
average(callable|string|null $callback = null)

Alias for the "avg" method.

mixed
median(null $key = null)

Get the median of a given key.

array|null
mode(mixed $key = null)

Get the mode of a given key.

collapse()

Collapse the collection of items into a single array.

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

Determine if an item exists in the collection.

bool
containsStrict(mixed $key, mixed $value = null)

Determine if an item exists in the collection using strict comparison.

diff(mixed $items)

Get the items in the collection that are not present in the given items.

diffKeys(mixed $items)

Get the items in the collection whose keys are not present in the given items.

$this
each(callable $callback)

Execute a callback over each item.

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

Determine if all items in the collection pass the given test.

except(mixed $keys)

Get all items except for those with the specified keys.

filter(callable $callback = null)

Run a filter over each of the items.

mixed
when(bool $value, callable $callback, callable $default = null)

Apply the callback if the value is truthy.

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

Filter items by the given key value pair.

whereStrict(string $key, mixed $value)

Filter items by the given key value pair using strict comparison.

whereIn(string $key, mixed $values, bool $strict = false)

Filter items by the given key value pair.

whereInStrict(string $key, mixed $values)

Filter items by the given key value pair using strict comparison.

whereNotIn(string $key, mixed $values, bool $strict = false)

Filter items by the given key value pair.

whereNotInStrict(string $key, mixed $values)

Filter items by the given key value pair using strict comparison.

mixed
first(callable $callback = null, mixed $default = null)

Get the first item from the collection.

flatten(int $depth = INF)

Get a flattened array of the items in the collection.

flip()

Flip the items in the collection.

$this
forget(string|array $keys)

Remove an item from the collection by key.

mixed
get(mixed $key, mixed $default = null)

Get an item from the collection by key.

groupBy(callable|string $groupBy, bool $preserveKeys = false)

Group an associative array by a field or using a callback.

keyBy(callable|string $keyBy)

Key an associative array by a field or using a callback.

bool
has(mixed $key)

Determine if an item exists in the collection by key.

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

Concatenate values of a given key as a string.

intersect(mixed $items)

Intersect the collection with the given items.

bool
isEmpty()

Determine if the collection is empty or not.

bool
isNotEmpty()

Determine if the collection is not empty.

keys()

Get the keys of the collection items.

mixed
last(callable $callback = null, mixed $default = null)

Get the last item from the collection.

pluck(string|array $value, string|null $key = null)

Get the values of a given key.

map(callable $callback)

Run a map over each of the items.

mapWithKeys(callable $callback)

Run an associative map over each of the items.

flatMap(callable $callback)

Map a collection and flatten the result by a single level.

mixed
max(callable|string|null $callback = null)

Get the max value of a given key.

merge(mixed $items)

Merge the collection with the given items.

combine(mixed $values)

Create a collection by using this collection for keys and another for its values.

union(mixed $items)

Union the collection with the given items.

mixed
min(callable|string|null $callback = null)

Get the min value of a given key.

nth(int $step, int $offset)

Create a new collection consisting of every n-th element.

only(mixed $keys)

Get the items with the specified keys.

forPage(int $page, int $perPage)

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

partition(callable|string $callback)

Partition the collection into two arrays using the given callback or key.

mixed
pipe(callable $callback)

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

mixed
pop()

Get and remove the last item from the collection.

$this
prepend(mixed $value, mixed $key = null)

Push an item onto the beginning of the collection.

$this
push(mixed $value)

Push an item onto the end of the collection.

mixed
pull(mixed $key, mixed $default = null)

Get and remove an item from the collection.

$this
put(mixed $key, mixed $value)

Put an item in the collection by key.

mixed
random(int|null $amount = 1)

Get one or more items randomly from the collection.

mixed
reduce(callable $callback, mixed $initial = null)

Reduce the collection to a single value.

reject(callable|mixed $callback)

Create a collection of all elements that do not pass a given truth test.

reverse()

Reverse items order.

mixed
search(mixed $value, bool $strict = false)

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

mixed
shift()

Get and remove the first item from the collection.

shuffle(int $seed = null)

Shuffle the items in the collection.

slice(int $offset, int $length = null)

Slice the underlying collection array.

split(int $numberOfGroups)

Split a collection into a certain number of groups.

chunk(int $size)

Chunk the underlying collection array.

sort(callable $callback = null)

Sort through each item with a callback.

sortBy(callable|string $callback, int $options = SORT_REGULAR, bool $descending = false)

Sort the collection using the given callback.

sortByDesc(callable|string $callback, int $options = SORT_REGULAR)

Sort the collection in descending order using the given callback.

splice(int $offset, int|null $length = null, mixed $replacement = array())

Splice a portion of the underlying collection array.

mixed
sum(callable|string|null $callback = null)

Get the sum of the given values.

take(int $limit)

Take the first or last {$limit} items.

$this
tap(callable $callback)

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

$this
transform(callable $callback)

Transform each item in the collection using a callback.

unique(string|callable|null $key = null, bool $strict = false)

Return only unique items from the collection array.

uniqueStrict(string|callable|null $key = null)

Return only unique items from the collection array using strict comparison.

values()

Reset the keys on the underlying array.

zip(mixed $items)

Zip the collection together with one or more arrays.

array
toArray()

Get the collection of items as a plain array.

array
jsonSerialize()

Convert the object into something JSON serializable.

string
toJson(int $options)

Get the collection of items as JSON.

getIterator()

Get an iterator for the items.

getCachingIterator(int $flags = CachingIterator::CALL_TOSTRING)

Get a CachingIterator instance.

int
count()

Count the number of items in the collection.

toBase()

Get a base Support collection instance from this collection.

bool
offsetExists(mixed $key)

Determine if an item exists at an offset.

mixed
offsetGet(mixed $key)

Get an item at a given offset.

void
offsetSet(mixed $key, mixed $value)

Set the item at a given offset.

void
offsetUnset(string $key)

Unset the item at a given offset.

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.

Details

in Macroable at line line 24
static void macro(string $name, callable $macro)

Register a custom macro.

Parameters

string $name
callable $macro

Return Value

void

in Macroable at line line 35
static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line line 49
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Macroable at line line 71
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line line 45
void __construct(mixed $items = array())

Create a new collection.

Parameters

mixed $items

Return Value

void

at line line 56
static Collection make(mixed $items = array())

Create a new collection instance if the value isn't one already.

Parameters

mixed $items

Return Value

Collection

at line line 68
static Collection times(int $amount, callable $callback)

Create a new collection by invoking the callback a given amount of times.

Parameters

int $amount
callable $callback

Return Value

Collection

at line line 82
array all()

Get all of the items in the collection.

Return Value

array

at line line 93
mixed avg(callable|string|null $callback = null)

Get the average value of a given key.

Parameters

callable|string|null $callback

Return Value

mixed

at line line 106
mixed average(callable|string|null $callback = null)

Alias for the "avg" method.

Parameters

callable|string|null $callback

Return Value

mixed

at line line 117
mixed median(null $key = null)

Get the median of a given key.

Parameters

null $key

Return Value

mixed

at line line 145
array|null mode(mixed $key = null)

Get the mode of a given key.

Parameters

mixed $key

Return Value

array|null

at line line 175
Collection collapse()

Collapse the collection of items into a single array.

Return Value

Collection

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

Determine if an item exists in the collection.

Parameters

mixed $key
mixed $operator
mixed $value

Return Value

bool

at line line 214
bool containsStrict(mixed $key, mixed $value = null)

Determine if an item exists in the collection using strict comparison.

Parameters

mixed $key
mixed $value

Return Value

bool

at line line 235
Collection diff(mixed $items)

Get the items in the collection that are not present in the given items.

Parameters

mixed $items

Return Value

Collection

at line line 246
Collection diffKeys(mixed $items)

Get the items in the collection whose keys are not present in the given items.

Parameters

mixed $items

Return Value

Collection

at line line 257
$this each(callable $callback)

Execute a callback over each item.

Parameters

callable $callback

Return Value

$this

at line line 276
bool every(string|callable $key, mixed $operator = null, mixed $value = null)

Determine if all items in the collection pass the given test.

Parameters

string|callable $key
mixed $operator
mixed $value

Return Value

bool

at line line 305
Collection except(mixed $keys)

Get all items except for those with the specified keys.

Parameters

mixed $keys

Return Value

Collection

at line line 318
Collection filter(callable $callback = null)

Run a filter over each of the items.

Parameters

callable $callback

Return Value

Collection

at line line 335
mixed when(bool $value, callable $callback, callable $default = null)

Apply the callback if the value is truthy.

Parameters

bool $value
callable $callback
callable $default

Return Value

mixed

at line line 354
Collection where(string $key, mixed $operator, mixed $value = null)

Filter items by the given key value pair.

Parameters

string $key
mixed $operator
mixed $value

Return Value

Collection

at line line 401
Collection whereStrict(string $key, mixed $value)

Filter items by the given key value pair using strict comparison.

Parameters

string $key
mixed $value

Return Value

Collection

at line line 414
Collection whereIn(string $key, mixed $values, bool $strict = false)

Filter items by the given key value pair.

Parameters

string $key
mixed $values
bool $strict

Return Value

Collection

at line line 430
Collection whereInStrict(string $key, mixed $values)

Filter items by the given key value pair using strict comparison.

Parameters

string $key
mixed $values

Return Value

Collection

at line line 443
Collection whereNotIn(string $key, mixed $values, bool $strict = false)

Filter items by the given key value pair.

Parameters

string $key
mixed $values
bool $strict

Return Value

Collection

at line line 459
Collection whereNotInStrict(string $key, mixed $values)

Filter items by the given key value pair using strict comparison.

Parameters

string $key
mixed $values

Return Value

Collection

at line line 471
mixed first(callable $callback = null, mixed $default = null)

Get the first item from the collection.

Parameters

callable $callback
mixed $default

Return Value

mixed

at line line 482
Collection flatten(int $depth = INF)

Get a flattened array of the items in the collection.

Parameters

int $depth

Return Value

Collection

at line line 492
Collection flip()

Flip the items in the collection.

Return Value

Collection

at line line 503
$this forget(string|array $keys)

Remove an item from the collection by key.

Parameters

string|array $keys

Return Value

$this

at line line 519
mixed get(mixed $key, mixed $default = null)

Get an item from the collection by key.

Parameters

mixed $key
mixed $default

Return Value

mixed

at line line 535
Collection groupBy(callable|string $groupBy, bool $preserveKeys = false)

Group an associative array by a field or using a callback.

Parameters

callable|string $groupBy
bool $preserveKeys

Return Value

Collection

at line line 566
Collection keyBy(callable|string $keyBy)

Key an associative array by a field or using a callback.

Parameters

callable|string $keyBy

Return Value

Collection

at line line 591
bool has(mixed $key)

Determine if an item exists in the collection by key.

Parameters

mixed $key

Return Value

bool

at line line 603
string implode(string $value, string $glue = null)

Concatenate values of a given key as a string.

Parameters

string $value
string $glue

Return Value

string

at line line 620
Collection intersect(mixed $items)

Intersect the collection with the given items.

Parameters

mixed $items

Return Value

Collection

at line line 630
bool isEmpty()

Determine if the collection is empty or not.

Return Value

bool

at line line 640
bool isNotEmpty()

Determine if the collection is not empty.

Return Value

bool

at line line 661
Collection keys()

Get the keys of the collection items.

Return Value

Collection

at line line 673
mixed last(callable $callback = null, mixed $default = null)

Get the last item from the collection.

Parameters

callable $callback
mixed $default

Return Value

mixed

at line line 685
Collection pluck(string|array $value, string|null $key = null)

Get the values of a given key.

Parameters

string|array $value
string|null $key

Return Value

Collection

at line line 696
Collection map(callable $callback)

Run a map over each of the items.

Parameters

callable $callback

Return Value

Collection

at line line 713
Collection 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.

Parameters

callable $callback

Return Value

Collection

at line line 734
Collection flatMap(callable $callback)

Map a collection and flatten the result by a single level.

Parameters

callable $callback

Return Value

Collection

at line line 745
mixed max(callable|string|null $callback = null)

Get the max value of a given key.

Parameters

callable|string|null $callback

Return Value

mixed

at line line 764
Collection merge(mixed $items)

Merge the collection with the given items.

Parameters

mixed $items

Return Value

Collection

at line line 775
Collection combine(mixed $values)

Create a collection by using this collection for keys and another for its values.

Parameters

mixed $values

Return Value

Collection

at line line 786
Collection union(mixed $items)

Union the collection with the given items.

Parameters

mixed $items

Return Value

Collection

at line line 797
mixed min(callable|string|null $callback = null)

Get the min value of a given key.

Parameters

callable|string|null $callback

Return Value

mixed

at line line 817
Collection nth(int $step, int $offset)

Create a new collection consisting of every n-th element.

Parameters

int $step
int $offset

Return Value

Collection

at line line 840
Collection only(mixed $keys)

Get the items with the specified keys.

Parameters

mixed $keys

Return Value

Collection

at line line 858
Collection forPage(int $page, int $perPage)

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

Parameters

int $page
int $perPage

Return Value

Collection

at line line 869
Collection partition(callable|string $callback)

Partition the collection into two arrays using the given callback or key.

Parameters

callable|string $callback

Return Value

Collection

at line line 888
mixed pipe(callable $callback)

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

Parameters

callable $callback

Return Value

mixed

at line line 898
mixed pop()

Get and remove the last item from the collection.

Return Value

mixed

at line line 910
$this prepend(mixed $value, mixed $key = null)

Push an item onto the beginning of the collection.

Parameters

mixed $value
mixed $key

Return Value

$this

at line line 923
$this push(mixed $value)

Push an item onto the end of the collection.

Parameters

mixed $value

Return Value

$this

at line line 937
mixed pull(mixed $key, mixed $default = null)

Get and remove an item from the collection.

Parameters

mixed $key
mixed $default

Return Value

mixed

at line line 949
$this put(mixed $key, mixed $value)

Put an item in the collection by key.

Parameters

mixed $key
mixed $value

Return Value

$this

at line line 964
mixed random(int|null $amount = 1)

Get one or more items randomly from the collection.

Parameters

int|null $amount

Return Value

mixed

Exceptions

InvalidArgumentException

at line line 988
mixed reduce(callable $callback, mixed $initial = null)

Reduce the collection to a single value.

Parameters

callable $callback
mixed $initial

Return Value

mixed

at line line 999
Collection reject(callable|mixed $callback)

Create a collection of all elements that do not pass a given truth test.

Parameters

callable|mixed $callback

Return Value

Collection

at line line 1017
Collection reverse()

Reverse items order.

Return Value

Collection

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

Parameters

mixed $value
bool $strict

Return Value

mixed

at line line 1049
mixed shift()

Get and remove the first item from the collection.

Return Value

mixed

at line line 1060
Collection shuffle(int $seed = null)

Shuffle the items in the collection.

Parameters

int $seed

Return Value

Collection

at line line 1084
Collection slice(int $offset, int $length = null)

Slice the underlying collection array.

Parameters

int $offset
int $length

Return Value

Collection

at line line 1095
Collection split(int $numberOfGroups)

Split a collection into a certain number of groups.

Parameters

int $numberOfGroups

Return Value

Collection

at line line 1112
Collection chunk(int $size)

Chunk the underlying collection array.

Parameters

int $size

Return Value

Collection

at line line 1133
Collection sort(callable $callback = null)

Sort through each item with a callback.

Parameters

callable $callback

Return Value

Collection

at line line 1152
Collection sortBy(callable|string $callback, int $options = SORT_REGULAR, bool $descending = false)

Sort the collection using the given callback.

Parameters

callable|string $callback
int $options
bool $descending

Return Value

Collection

at line line 1185
Collection sortByDesc(callable|string $callback, int $options = SORT_REGULAR)

Sort the collection in descending order using the given callback.

Parameters

callable|string $callback
int $options

Return Value

Collection

at line line 1198
Collection splice(int $offset, int|null $length = null, mixed $replacement = array())

Splice a portion of the underlying collection array.

Parameters

int $offset
int|null $length
mixed $replacement

Return Value

Collection

at line line 1213
mixed sum(callable|string|null $callback = null)

Get the sum of the given values.

Parameters

callable|string|null $callback

Return Value

mixed

at line line 1232
Collection take(int $limit)

Take the first or last {$limit} items.

Parameters

int $limit

Return Value

Collection

at line line 1247
$this tap(callable $callback)

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

Parameters

callable $callback

Return Value

$this

at line line 1260
$this transform(callable $callback)

Transform each item in the collection using a callback.

Parameters

callable $callback

Return Value

$this

at line line 1274
Collection unique(string|callable|null $key = null, bool $strict = false)

Return only unique items from the collection array.

Parameters

string|callable|null $key
bool $strict

Return Value

Collection

at line line 1299
Collection uniqueStrict(string|callable|null $key = null)

Return only unique items from the collection array using strict comparison.

Parameters

string|callable|null $key

Return Value

Collection

at line line 1309
Collection values()

Reset the keys on the underlying array.

Return Value

Collection

at line line 1340
Collection zip(mixed $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]]

Parameters

mixed $items

Return Value

Collection

at line line 1358
array toArray()

Get the collection of items as a plain array.

Return Value

array

at line line 1370
array jsonSerialize()

Convert the object into something JSON serializable.

Return Value

array

at line line 1391
string toJson(int $options)

Get the collection of items as JSON.

Parameters

int $options

Return Value

string

at line line 1401
ArrayIterator getIterator()

Get an iterator for the items.

Return Value

ArrayIterator

at line line 1412
CachingIterator getCachingIterator(int $flags = CachingIterator::CALL_TOSTRING)

Get a CachingIterator instance.

Parameters

int $flags

Return Value

CachingIterator

at line line 1422
int count()

Count the number of items in the collection.

Return Value

int

at line line 1432
Collection toBase()

Get a base Support collection instance from this collection.

Return Value

Collection

at line line 1443
bool offsetExists(mixed $key)

Determine if an item exists at an offset.

Parameters

mixed $key

Return Value

bool

at line line 1454
mixed offsetGet(mixed $key)

Get an item at a given offset.

Parameters

mixed $key

Return Value

mixed

at line line 1466
void offsetSet(mixed $key, mixed $value)

Set the item at a given offset.

Parameters

mixed $key
mixed $value

Return Value

void

at line line 1481
void offsetUnset(string $key)

Unset the item at a given offset.

Parameters

string $key

Return Value

void

at line line 1491
string __toString()

Convert the collection to its string representation.

Return Value

string

at line line 1527
static void proxy(string $method)

Add a method to the list of proxied methods.

Parameters

string $method

Return Value

void

at line line 1540
mixed __get(string $key)

Dynamically access collection proxies.

Parameters

string $key

Return Value

mixed

Exceptions

Exception