class Collection extends Collection implements QueueableCollection (View source)
Macroable |
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(callable|string|null $callback = null) Get the average value of a given key. | from Collection |
mixed | average(callable|string|null $callback = null) Alias for the "avg" method. | from Collection |
mixed | median(null $key = null) Get the median of a given key. | from Collection |
array | mode(mixed $key = null) Get the mode of a given key. | 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. | |
bool | containsStrict(mixed $key, mixed $value = null) Determine if an item exists in the collection using strict comparison. | from 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 $operator, mixed $value = null) Filter items by the given key value pair. | from Collection |
Collection | whereStrict(string $key, mixed $value) Filter items by the given key value pair using strict comparison. | from Collection |
Collection | whereIn(string $key, mixed $values, bool $strict = false) Filter items by the given key value pair. | from Collection |
Collection | whereInStrict(string $key, mixed $values) Filter items by the given key value pair using strict 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 |
bool | isNotEmpty() Determine if the collection is not empty. | 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 | map(callable $callback) Run a map over each of the items. | |
Collection | mapWithKeys(callable $callback) Run an associative 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(callable|string|null $callback = 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 |
Collection | union(mixed $items) Union the collection with the given items. | from Collection |
mixed | min(callable|string|null $callback = 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 |
Collection | partition(callable|string $callback) Partition the collection into two arrays using the given callback or key. | from Collection |
mixed | pipe(callable $callback) Pass the collection to the given callback and return the result. | 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(int $seed = null) Shuffle the items in the collection. | from Collection |
Collection | slice(int $offset, int $length = null) Slice the underlying collection array. | from Collection |
Collection | split(int $numberOfGroups) Split a collection into a certain number of groups. | 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, bool $strict = false) Return only unique items from the collection. | |
Collection | uniqueStrict(string|callable|null $key = null) Return only unique items from the collection array using strict comparison. | from 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 |
Collection | toBase() Get a base Support collection instance from this 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. | |
array | getDictionary(ArrayAccess|array|null $items = null) Get a dictionary keyed by primary keys. | |
string|null | getQueueableClass() Get the type of the entities being queued. | |
array | getQueueableIds() Get the identifiers for all of the entities. |
Register a custom macro.
Checks if macro is registered.
Dynamically handle calls to the class.
Dynamically handle calls to the class.
Create a new collection.
Create a new collection instance if the value isn't one already.
Get all of the items in the collection.
Get the average value of a given key.
Alias for the "avg" method.
Get the median of a given key.
Get the mode of a given key.
Collapse the collection of items into a single array.
Determine if a key exists in the collection.
Determine if an item exists in the collection using strict comparison.
Diff the collection with the given items.
Get the items in the collection whose keys are not present in the given items.
Execute a callback over each item.
Create a new collection consisting of every n-th element.
Returns all models in the collection except the models with specified keys.
Run a filter over each of the items.
Filter items by the given key value pair.
Filter items by the given key value pair using strict comparison.
Filter items by the given key value pair.
Filter items by the given key value pair using strict comparison.
Get the first item from the collection.
Get a flattened array of the items in the collection.
Flip the items in the collection.
Remove an item from the collection by key.
Get an item from the collection by key.
Group an associative array by a field or using a callback.
Key an associative array by a field or using a callback.
Determine if an item exists in the collection by key.
Concatenate values of a given key as a string.
Intersect the collection with the given items.
Determine if the collection is empty or not.
Determine if the collection is not empty.
Get the keys of the collection items.
Get the last item from the collection.
Get an array with the values of a given key.
Run a 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.
Map a collection and flatten the result by a single level.
Get the max value of a given key.
Merge the collection with the given items.
Create a collection by using this collection for keys and another for its values.
Union the collection with the given items.
Get the min value of a given key.
Returns only the models from the collection with the specified keys.
"Paginate" the collection by slicing it into a smaller collection.
Partition the collection into two arrays using the given callback or key.
Pass the collection to the given callback and return the result.
Get and remove the last item from the collection.
Push an item onto the beginning of the collection.
Push an item onto the end of the collection.
Get and remove an item from the collection.
Put an item in the collection by key.
Get one or more items randomly from the collection.
Reduce the collection to a single value.
Create a collection of all elements that do not pass a given truth test.
Reverse items order.
Search the collection for a given value and return the corresponding key if successful.
Get and remove the first item from the collection.
Shuffle the items in the collection.
Slice the underlying collection array.
Split a collection into a certain number of groups.
Chunk the underlying collection array.
Sort through each item with a callback.
Sort the collection using the given callback.
Sort the collection in descending order using the given callback.
Splice a portion of the underlying collection array.
Get the sum of the given values.
Take the first or last {$limit} items.
Transform each item in the collection using a callback.
Return only unique items from the collection.
Return only unique items from the collection array using strict comparison.
Reset the keys on the underlying array.
Zip the collection together with one or more arrays.
Get the collection of items as a plain array.
Convert the object into something JSON serializable.
Get the collection of items as JSON.
Get an iterator for the items.
Get a CachingIterator instance.
Count the number of items in the collection.
Get a base Support collection instance from this collection.
Determine if an item exists at an offset.
Get an item at a given offset.
Set the item at a given offset.
Unset the item at a given offset.
Convert the collection to its string representation.
Find a model in the collection by key.
Load a set of relationships onto the collection.
Add an item to the collection.
Get the array of primary keys.
Make the given, typically visible, attributes hidden across the entire collection.
Make the given, typically hidden, attributes visible across the entire collection.
Get a dictionary keyed by primary keys.
Get the type of the entities being queued.
Get the identifiers for all of the entities.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.3/Illuminate/Database/Eloquent/Collection.html