1. class
  2. Illuminate
  3. Database
  4. Eloquent
  5. Collection

Collection

class Collection extends Collection (View source)

Traits

Macroable

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.

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

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

from Collection
array
all()

Get all of the items in the collection.

from Collection
mixed
avg( string|null $key = null)

Get the average value of a given key.

from Collection
mixed
average( string|null $key = null)

Alias for the "avg" method.

from Collection
Collection
collapse()

Collapse the collection of items into a single array.

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

Determine if a key exists in the collection.

Collection
diff( mixed $items)

Diff the collection with the given items.

Collection
diffKeys( mixed $items)

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

from Collection
$this
each( callable $callback)

Execute a callback over each item.

from Collection
Collection
every( int $step, int $offset)

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

from Collection
Collection
except( mixed $keys)

Returns all models in the collection except the models with specified keys.

Collection
filter( callable $callback = null)

Run a filter over each of the items.

from Collection
Collection
where( string $key, mixed $value, bool $strict = true)

Filter items by the given key value pair.

from Collection
Collection
whereLoose( string $key, mixed $value)

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

from Collection
Collection
whereIn( string $key, array $values, bool $strict = true)

Filter items by the given key value pair.

from Collection
Collection
whereInLoose( string $key, array $values)

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

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

Get the first item from the collection.

from Collection
Collection
flatten( int $depth = INF)

Get a flattened array of the items in the collection.

Collection
flip()

Flip the items in the collection.

$this
forget( string|array $keys)

Remove an item from the collection by key.

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

Get an item from the collection by key.

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

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

from Collection
Collection
keyBy( callable|string $keyBy)

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

from Collection
bool
has( mixed $key)

Determine if an item exists in the collection by key.

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

Concatenate values of a given key as a string.

from Collection
Collection
intersect( mixed $items)

Intersect the collection with the given items.

bool
isEmpty()

Determine if the collection is empty or not.

from Collection
Collection
keys()

Get the keys of the collection items.

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

Get the last item from the collection.

from Collection
Collection
pluck( string $value, string|null $key = null)

Get an array with the values of a given key.

Collection
lists( string $value, string|null $key = null)

Alias for the "pluck" method.

from Collection
Collection
map( callable $callback)

Run a map over each of the items.

from Collection
Collection
flatMap( callable $callback)

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

from Collection
mixed
max( string|null $key = null)

Get the max value of a given key.

from Collection
Collection
merge( mixed $items)

Merge the collection with the given items.

Collection
combine( mixed $values)

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

from Collection
void
union( mixed $items)

Union the collection with the given items.

from Collection
mixed
min( string|null $key = null)

Get the min value of a given key.

from Collection
Collection
only( mixed $keys)

Returns only the models from the collection with the specified keys.

Collection
forPage( int $page, int $perPage)

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

from Collection
mixed
pop()

Get and remove the last item from the collection.

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

Push an item onto the beginning of the collection.

from Collection
$this
push( mixed $value)

Push an item onto the end of the collection.

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

Get and remove an item from the collection.

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

Put an item in the collection by key.

from Collection
mixed
random( int $amount = 1)

Get one or more items randomly from the collection.

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

Reduce the collection to a single value.

from Collection
Collection
reject( callable|mixed $callback)

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

from Collection
Collection
reverse()

Reverse items order.

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

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

from Collection
mixed
shift()

Get and remove the first item from the collection.

from Collection
Collection
shuffle()

Shuffle the items in the collection.

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

Slice the underlying collection array.

from Collection
Collection
chunk( int $size)

Chunk the underlying collection array.

from Collection
Collection
sort( callable $callback = null)

Sort through each item with a callback.

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

Sort the collection using the given callback.

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

Sort the collection in descending order using the given callback.

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

Splice a portion of the underlying collection array.

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

Get the sum of the given values.

from Collection
Collection
take( int $limit)

Take the first or last {$limit} items.

from Collection
$this
transform( callable $callback)

Transform each item in the collection using a callback.

from Collection
Collection
unique( string|callable|null $key = null)

Return only unique items from the collection.

Collection
values()

Reset the keys on the underlying array.

from Collection
Collection
zip( mixed $items)

Zip the collection together with one or more arrays.

array
toArray()

Get the collection of items as a plain array.

from Collection
array
jsonSerialize()

Convert the object into something JSON serializable.

from Collection
string
toJson( int $options)

Get the collection of items as JSON.

from Collection
ArrayIterator
getIterator()

Get an iterator for the items.

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

Get a CachingIterator instance.

from Collection
int
count()

Count the number of items in the collection.

from Collection
bool
offsetExists( mixed $key)

Determine if an item exists at an offset.

from Collection
mixed
offsetGet( mixed $key)

Get an item at a given offset.

from Collection
void
offsetSet( mixed $key, mixed $value)

Set the item at a given offset.

from Collection
void
offsetUnset( string $key)

Unset the item at a given offset.

from Collection
string
__toString()

Convert the collection to its string representation.

from Collection
Model
find( mixed $key, mixed $default = null)

Find a model in the collection by key.

$this
load( mixed $relations)

Load a set of relationships onto the collection.

$this
add( mixed $item)

Add an item to the collection.

array
modelKeys()

Get the array of primary keys.

$this
makeHidden( array|string $attributes)

Make the given, typically visible, attributes hidden across the entire collection.

$this
makeVisible( array|string $attributes)

Make the given, typically hidden, attributes visible across the entire collection.

$this
withHidden( array|string $attributes)

Make the given, typically hidden, attributes visible across the entire collection.

array
getDictionary( ArrayAccess|array|null $items = null)

Get a dictionary keyed by primary keys.

Collection
toBase()

Get a base Support collection instance from this collection.

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

in Collection at line line 33
void __construct( mixed $items = array())

Create a new collection.

Parameters

mixed $items

Return Value

void

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

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

Parameters

mixed $items

Return Value

Collection

in Collection at line line 54
array all()

Get all of the items in the collection.

Return Value

array

in Collection at line line 65
mixed avg( string|null $key = null)

Get the average value of a given key.

Parameters

string|null $key

Return Value

mixed

in Collection at line line 78
mixed average( string|null $key = null)

Alias for the "avg" method.

Parameters

string|null $key

Return Value

mixed

at line line 299
Collection collapse()

Collapse the collection of items into a single array.

Return Value

Collection

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

Determine if a key exists in the collection.

Parameters

mixed $key
mixed $value

Return Value

bool

at line line 122
Collection diff( mixed $items)

Diff the collection with the given items.

Parameters

mixed $items

Return Value

Collection

in Collection at line line 132
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

in Collection at line line 143
$this each( callable $callback)

Execute a callback over each item.

Parameters

callable $callback

Return Value

$this

in Collection at line line 161
Collection every( 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 192
Collection except( mixed $keys)

Returns all models in the collection except the models with specified keys.

Parameters

mixed $keys

Return Value

Collection

in Collection at line line 197
Collection filter( callable $callback = null)

Run a filter over each of the items.

Parameters

callable $callback

Return Value

Collection

in Collection at line line 222
Collection where( string $key, mixed $value, bool $strict = true)

Filter items by the given key value pair.

Parameters

string $key
mixed $value
bool $strict

Return Value

Collection

in Collection at line line 237
Collection whereLoose( string $key, mixed $value)

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

Parameters

string $key
mixed $value

Return Value

Collection

in Collection at line line 250
Collection whereIn( string $key, array $values, bool $strict = true)

Filter items by the given key value pair.

Parameters

string $key
array $values
bool $strict

Return Value

Collection

in Collection at line line 264
Collection whereInLoose( string $key, array $values)

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

Parameters

string $key
array $values

Return Value

Collection

in Collection at line line 276
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 310
Collection flatten( int $depth = INF)

Get a flattened array of the items in the collection.

Parameters

int $depth

Return Value

Collection

at line line 320
Collection flip()

Flip the items in the collection.

Return Value

Collection

in Collection at line line 308
$this forget( string|array $keys)

Remove an item from the collection by key.

Parameters

string|array $keys

Return Value

$this

in Collection at line line 324
mixed get( mixed $key, mixed $default = null)

Get an item from the collection by key.

Parameters

mixed $key
mixed $default

Return Value

mixed

in Collection at line line 340
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

in Collection at line line 371
Collection keyBy( callable|string $keyBy)

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

Parameters

callable|string $keyBy

Return Value

Collection

in Collection at line line 390
bool has( mixed $key)

Determine if an item exists in the collection by key.

Parameters

mixed $key

Return Value

bool

in Collection at line line 402
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 143
Collection intersect( mixed $items)

Intersect the collection with the given items.

Parameters

mixed $items

Return Value

Collection

in Collection at line line 429
bool isEmpty()

Determine if the collection is empty or not.

Return Value

bool

at line line 278
Collection keys()

Get the keys of the collection items.

Return Value

Collection

in Collection at line line 462
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 268
Collection pluck( string $value, string|null $key = null)

Get an array with the values of a given key.

Parameters

string $value
string|null $key

Return Value

Collection

in Collection at line line 488
Collection lists( string $value, string|null $key = null)

Alias for the "pluck" method.

Parameters

string $value
string|null $key

Return Value

Collection

in Collection at line line 499
Collection map( callable $callback)

Run a map over each of the items.

Parameters

callable $callback

Return Value

Collection

in Collection at line line 514
Collection flatMap( callable $callback)

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

Parameters

callable $callback

Return Value

Collection

in Collection at line line 525
mixed max( string|null $key = null)

Get the max value of a given key.

Parameters

string|null $key

Return Value

mixed

at line line 105
Collection merge( mixed $items)

Merge the collection with the given items.

Parameters

mixed $items

Return Value

Collection

in Collection at line line 551
Collection combine( mixed $values)

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

Parameters

mixed $values

Return Value

Collection

in Collection at line line 562
void union( mixed $items)

Union the collection with the given items.

Parameters

mixed $items

Return Value

void

in Collection at line line 573
mixed min( string|null $key = null)

Get the min value of a given key.

Parameters

string|null $key

Return Value

mixed

at line line 179
Collection only( mixed $keys)

Returns only the models from the collection with the specified keys.

Parameters

mixed $keys

Return Value

Collection

in Collection at line line 602
Collection forPage( int $page, int $perPage)

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

Parameters

int $page
int $perPage

Return Value

Collection

in Collection at line line 612
mixed pop()

Get and remove the last item from the collection.

Return Value

mixed

in Collection at line line 624
$this prepend( mixed $value, mixed $key = null)

Push an item onto the beginning of the collection.

Parameters

mixed $value
mixed $key

Return Value

$this

in Collection at line line 637
$this push( mixed $value)

Push an item onto the end of the collection.

Parameters

mixed $value

Return Value

$this

in Collection at line line 651
mixed pull( mixed $key, mixed $default = null)

Get and remove an item from the collection.

Parameters

mixed $key
mixed $default

Return Value

mixed

in Collection at line line 663
$this put( mixed $key, mixed $value)

Put an item in the collection by key.

Parameters

mixed $key
mixed $value

Return Value

$this

in Collection at line line 678
mixed random( int $amount = 1)

Get one or more items randomly from the collection.

Parameters

int $amount

Return Value

mixed

Exceptions

InvalidArgumentException

in Collection at line line 700
mixed reduce( callable $callback, mixed $initial = null)

Reduce the collection to a single value.

Parameters

callable $callback
mixed $initial

Return Value

mixed

in Collection at line line 711
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

in Collection at line line 729
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

in Collection at line line 761
mixed shift()

Get and remove the first item from the collection.

Return Value

mixed

in Collection at line line 771
Collection shuffle()

Shuffle the items in the collection.

Return Value

Collection

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

Slice the underlying collection array.

Parameters

int $offset
int $length

Return Value

Collection

in Collection at line line 798
Collection chunk( int $size)

Chunk the underlying collection array.

Parameters

int $size

Return Value

Collection

in Collection at line line 815
Collection sort( callable $callback = null)

Sort through each item with a callback.

Parameters

callable $callback

Return Value

Collection

in Collection at line line 839
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

in Collection at line line 872
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

in Collection at line line 885
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

in Collection at line line 900
mixed sum( callable|string|null $callback = null)

Get the sum of the given values.

Parameters

callable|string|null $callback

Return Value

mixed

in Collection at line line 919
Collection take( int $limit)

Take the first or last {$limit} items.

Parameters

int $limit

Return Value

Collection

in Collection at line line 934
$this transform( callable $callback)

Transform each item in the collection using a callback.

Parameters

callable $callback

Return Value

$this

at line line 164
Collection unique( string|callable|null $key = null)

Return only unique items from the collection.

Parameters

string|callable|null $key

Return Value

Collection

in Collection at line line 971
Collection values()

Reset the keys on the underlying array.

Return Value

Collection

at line line 289
Collection zip( mixed $items)

Zip the collection together with one or more arrays.

Parameters

mixed $items

Return Value

Collection

in Collection at line line 1020
array toArray()

Get the collection of items as a plain array.

Return Value

array

in Collection at line line 1032
array jsonSerialize()

Convert the object into something JSON serializable.

Return Value

array

in Collection at line line 1053
string toJson( int $options)

Get the collection of items as JSON.

Parameters

int $options

Return Value

string

in Collection at line line 1063
ArrayIterator getIterator()

Get an iterator for the items.

Return Value

ArrayIterator

in Collection at line line 1074
CachingIterator getCachingIterator( int $flags = CachingIterator::CALL_TOSTRING)

Get a CachingIterator instance.

Parameters

int $flags

Return Value

CachingIterator

in Collection at line line 1084
int count()

Count the number of items in the collection.

Return Value

int

in Collection at line line 1095
bool offsetExists( mixed $key)

Determine if an item exists at an offset.

Parameters

mixed $key

Return Value

bool

in Collection at line line 1106
mixed offsetGet( mixed $key)

Get an item at a given offset.

Parameters

mixed $key

Return Value

mixed

in Collection at line line 1118
void offsetSet( mixed $key, mixed $value)

Set the item at a given offset.

Parameters

mixed $key
mixed $value

Return Value

void

in Collection at line line 1133
void offsetUnset( string $key)

Unset the item at a given offset.

Parameters

string $key

Return Value

void

in Collection at line line 1143
string __toString()

Convert the collection to its string representation.

Return Value

string

at line line 17
Model find( mixed $key, mixed $default = null)

Find a model in the collection by key.

Parameters

mixed $key
mixed $default

Return Value

Model

at line line 35
$this load( mixed $relations)

Load a set of relationships onto the collection.

Parameters

mixed $relations

Return Value

$this

at line line 56
$this add( mixed $item)

Add an item to the collection.

Parameters

mixed $item

Return Value

$this

at line line 92
array modelKeys()

Get the array of primary keys.

Return Value

array

at line line 205
$this makeHidden( array|string $attributes)

Make the given, typically visible, attributes hidden across the entire collection.

Parameters

array|string $attributes

Return Value

$this

at line line 218
$this makeVisible( array|string $attributes)

Make the given, typically hidden, attributes visible across the entire collection.

Parameters

array|string $attributes

Return Value

$this

at line line 233
$this withHidden( array|string $attributes)

Make the given, typically hidden, attributes visible across the entire collection.

Parameters

array|string $attributes

Return Value

$this

at line line 244
array getDictionary( ArrayAccess|array|null $items = null)

Get a dictionary keyed by primary keys.

Parameters

ArrayAccess|array|null $items

Return Value

array

at line line 330
Collection toBase()

Get a base Support collection instance from this collection.

Return Value

Collection