Class Illuminate\Database\Eloquent\Collection

`<TKey is array-key, TModel is Model>`

`extends`	`Collection<TKey, TModel>`
`implements`	`QueueableCollection`
`uses`	`InteractsWithDictionary`

Illuminate\Support\Collection implements ArrayAccess<TKey, TValue>, CanBeEscapedWhenCastToString, Enumerable<TKey, TValue> uses EnumeratesValues, Macroable, TransformsToResourceCollection
- Illuminate\Database\Eloquent\Collection implements QueueableCollection uses InteractsWithDictionary

Methods


					
	public

find<TFindDefault>(
	mixed $key,
	TFindDefault $default = null,
): ($key is Arrayable<array-key, mixed>|array<mixed> ? static : TModel|TFindDefault)

Find a model in the collection by key.


					
	public

findOrFail(mixed $key): TModel

Find a model in the collection by key or throw an exception.

Throws

Illuminate\Database\Eloquent\ModelNotFoundException


					
	public

load(array<array-key, array|(callable(Relation<*, *, *>): mixed)|string>|string $relations): $this

Load a set of relationships onto the collection.


					
	public

loadAggregate(
	array<array-key, array|(callable(Relation<*, *, *>): mixed)|string>|string $relations,
	string $column,
	string|null $function = null,
): $this

Load a set of aggregations over relationship's column onto the collection.


					
	public

loadCount(array<array-key, array|(callable(Relation<*, *, *>): mixed)|string>|string $relations): $this

Load a set of relationship counts onto the collection.


					
	public

loadMax(array<array-key, array|(callable(Relation<*, *, *>): mixed)|string>|string $relations, string $column): $this

Load a set of relationship's max column values onto the collection.


					
	public

loadMin(array<array-key, array|(callable(Relation<*, *, *>): mixed)|string>|string $relations, string $column): $this

Load a set of relationship's min column values onto the collection.


					
	public

loadSum(array<array-key, array|(callable(Relation<*, *, *>): mixed)|string>|string $relations, string $column): $this

Load a set of relationship's column summations onto the collection.


					
	public

loadAvg(array<array-key, array|(callable(Relation<*, *, *>): mixed)|string>|string $relations, string $column): $this

Load a set of relationship's average column values onto the collection.


					
	public

loadExists(array<array-key, array|(callable(Relation<*, *, *>): mixed)|string>|string $relations): $this

Load a set of related existences onto the collection.


					
	public

loadMissing(array<array-key, array|(callable(Relation<*, *, *>): mixed)|string>|string $relations): $this

Load a set of relationships onto the collection if they are not already eager loaded.


					
	public

loadMissingRelationshipChain(array $tuples): void

Load a relationship path for models of the given type if it is not already eager loaded.


					
	protected

loadMissingRelation(Collection<int, TModel> $models, array $path): void

Load a relationship path if it is not already eager loaded.


					
	public

loadMorph(string $relation, array<array-key, array|(callable(Relation<*, *, *>): mixed)|string> $relations): $this

Load a set of relationships onto the mixed relationship collection.


					
	public

loadMorphCount(string $relation, array<array-key, array|(callable(Relation<*, *, *>): mixed)|string> $relations): $this

Load a set of relationship counts onto the mixed relationship collection.


					
	public

contains((callable(TModel, TKey): bool)|TModel|string|int $key, mixed $operator = null, mixed $value = null): bool

Determine if a key exists in the collection.

Overrides

Illuminate\Support\Collection::contains()


					
	public

doesntContain((callable(TModel, TKey): bool)|TModel|string|int $key, mixed $operator = null, mixed $value = null): bool

Determine if a key does not exist in the collection.

Overrides

Illuminate\Support\Collection::doesntContain()


					
	public

modelKeys(): array<int, array-key>

Get the array of primary keys.


					
	public

merge(iterable<array-key, TModel> $items): static

Merge the collection with the given items.

Overrides

Illuminate\Support\Collection::merge()


					
	public

map<TMapValue>(callable(TModel, TKey): TMapValue $callback): Collection<TKey, TMapValue>|static<TKey, TMapValue>

Run a map over each of the items.

Overrides

Illuminate\Support\Collection::map()


					
	public

mapWithKeys<TMapWithKeysKey is array-key, TMapWithKeysValue>(
	callable(TModel, TKey): array<TMapWithKeysKey, TMapWithKeysValue> $callback,
): Collection<TMapWithKeysKey, TMapWithKeysValue>|static<TMapWithKeysKey, TMapWithKeysValue>

Run an associative map over each of the items.

The callback should return an associative array with a single key / value pair.

Overrides

Illuminate\Support\Collection::mapWithKeys()


					
	public

fresh(array<array-key, string>|string $with = []): static

Reload a fresh model instance from the database for all the entities.


					
	public

diff(iterable<array-key, TModel> $items): static

Diff the collection with the given items.

Overrides

Illuminate\Support\Collection::diff()


					
	public

intersect(iterable<array-key, TModel> $items): static

Intersect the collection with the given items.

Overrides

Illuminate\Support\Collection::intersect()


					
	public

unique((callable(TModel, TKey): mixed)|string|null $key = null, bool $strict = false): static

Return only unique items from the collection.

Overrides

Illuminate\Support\Collection::unique()


					
	public

only(array<array-key, mixed>|null $keys): static

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

Overrides

Illuminate\Support\Collection::only()


					
	public

except(array<array-key, mixed>|null $keys): static

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

Overrides

Illuminate\Support\Collection::except()


					
	public

makeHidden(array<array-key, string>|string $attributes): $this

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


					
	public

mergeHidden(array<array-key, string>|string $attributes): $this

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


					
	public

setHidden(array<int, string> $hidden): $this

Set the hidden attributes across the entire collection.


					
	public

makeVisible(array<array-key, string>|string $attributes): $this

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


					
	public

mergeVisible(array<array-key, string>|string $attributes): $this

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


					
	public

setVisible(array<int, string> $visible): $this

Set the visible attributes across the entire collection.


					
	public

append(array<array-key, string>|string $attributes): $this

Append an attribute across the entire collection.


					
	public

setAppends(array<array-key, mixed> $appends): $this

Sets the appends on every element of the collection, overwriting the existing appends for each.


					
	public

withoutAppends(): $this

Remove appended properties from every element in the collection.


					
	public

getDictionary(iterable<array-key, TModel>|null $items = null): array<array-key, TModel>

Get a dictionary keyed by primary keys.


					
	public

countBy($countBy = null): Collection<array-key, int>

{@inheritDoc}

Overrides

Illuminate\Support\Collection::countBy()


					
	public

collapse(): Collection<int, mixed>

{@inheritDoc}

Overrides

Illuminate\Support\Collection::collapse()


					
	public

flatten($depth = INF): Collection<int, mixed>

{@inheritDoc}

Overrides

Illuminate\Support\Collection::flatten()


					
	public

flip(): Collection<TModel, TKey>

{@inheritDoc}

Overrides

Illuminate\Support\Collection::flip()


					
	public

keys(): Collection<int, TKey>

{@inheritDoc}

Overrides

Illuminate\Support\Collection::keys()


					
	public

pad<TPadValue>($size, $value): Collection<int, TModel|TPadValue>

{@inheritDoc}

Overrides

Illuminate\Support\Collection::pad()


					
	public

partition($key, $operator = null, $value = null): Collection<int<0, 1>, static<TKey, TModel>>

{@inheritDoc}

Implements

Illuminate\Support\Enumerable::partition()


					
	public

pluck($value, $key = null): Collection<array-key, mixed>

{@inheritDoc}

Overrides

Illuminate\Support\Collection::pluck()


					
	public

zip<TZipValue>($items): Collection<int, Collection<int, TModel|TZipValue>>

{@inheritDoc}

Overrides

Illuminate\Support\Collection::zip()


					
	protected

duplicateComparator($strict): callable(TModel, TModel): bool

Get the comparison function to detect duplicates.

Overrides

Illuminate\Support\Collection::duplicateComparator()


					
	public

withRelationshipAutoloading(): $this

Enable relationship autoloading for all models in this collection.


					
	public

getQueueableClass(): string|null

Get the type of the entities being queued.

Throws

LogicException

Implements

Illuminate\Contracts\Queue\QueueableCollection::getQueueableClass()


					
	protected

getQueueableModelClass(Model $model): string

Get the queueable class name for the given model.


					
	public

getQueueableIds(): array<int, mixed>

Get the identifiers for all of the entities.

Implements

Illuminate\Contracts\Queue\QueueableCollection::getQueueableIds()


					
	public

getQueueableRelations(): array<int, string>

Get the relationships of the entities being queued.

Implements

Illuminate\Contracts\Queue\QueueableCollection::getQueueableRelations()


					
	public

getQueueableConnection(): string|null

Get the connection of the entities being queued.

Throws

LogicException

Implements

Illuminate\Contracts\Queue\QueueableCollection::getQueueableConnection()


					
	public

toQuery(): Builder<TModel>

Get the Eloquent query builder from the collection.

Throws

LogicException

Methods inherited from Illuminate\Support\Collection
__construct(), range(), all(), lazy(), median(), mode(), collapseWithKeys(), containsStrict(), doesntContainStrict(), crossJoin(), diffUsing(), diffAssoc(), diffAssocUsing(), diffKeys(), diffKeysUsing(), duplicates(), duplicatesStrict(), filter(), first(), forget(), get(), getOrPut(), groupBy(), keyBy(), has(), hasAny(), implode(), intersectUsing(), intersectAssoc(), intersectAssocUsing(), intersectByKeys(), isEmpty(), containsOneItem(), containsManyItems(), join(), last(), mapToDictionary(), mergeRecursive(), multiply(), combine(), union(), nth(), select(), pop(), prepend(), push(), unshift(), concat(), pull(), put(), random(), replace(), replaceRecursive(), reverse(), search(), before(), after(), shift(), shuffle(), sliding(), skip(), skipUntil(), skipWhile(), slice(), split(), splitIn(), sole(), hasSole(), firstOrFail(), chunk(), chunkWhile(), sort(), sortDesc(), sortBy(), sortByMany(), sortByDesc(), sortKeys(), sortKeysDesc(), sortKeysUsing(), splice(), take(), takeUntil(), takeWhile(), transform(), dot(), undot(), values(), getIterator(), count(), add(), toBase(), offsetExists(), offsetGet(), offsetSet(), offsetUnset()

Methods inherited from Illuminate\Support\Collection

__construct(), range(), all(), lazy(), median(), mode(), collapseWithKeys(), containsStrict(), doesntContainStrict(), crossJoin(), diffUsing(), diffAssoc(), diffAssocUsing(), diffKeys(), diffKeysUsing(), duplicates(), duplicatesStrict(), filter(), first(), forget(), get(), getOrPut(), groupBy(), keyBy(), has(), hasAny(), implode(), intersectUsing(), intersectAssoc(), intersectAssocUsing(), intersectByKeys(), isEmpty(), containsOneItem(), containsManyItems(), join(), last(), mapToDictionary(), mergeRecursive(), multiply(), combine(), union(), nth(), select(), pop(), prepend(), push(), unshift(), concat(), pull(), put(), random(), replace(), replaceRecursive(), reverse(), search(), before(), after(), shift(), shuffle(), sliding(), skip(), skipUntil(), skipWhile(), slice(), split(), splitIn(), sole(), hasSole(), firstOrFail(), chunk(), chunkWhile(), sort(), sortDesc(), sortBy(), sortByMany(), sortByDesc(), sortKeys(), sortKeysDesc(), sortKeysUsing(), splice(), take(), takeUntil(), takeWhile(), transform(), dot(), undot(), values(), getIterator(), count(), add(), toBase(), offsetExists(), offsetGet(), offsetSet(), offsetUnset()

Methods used from Illuminate\Support\Traits\EnumeratesValues
make(), wrap(), unwrap(), empty(), times(), fromJson(), avg(), average(), some(), dd(), dump(), each(), eachSpread(), every(), firstWhere(), hasMany(), value(), ensure(), isNotEmpty(), mapSpread(), mapToGroups(), flatMap(), mapInto(), min(), max(), forPage(), percentage(), sum(), whenEmpty(), whenNotEmpty(), unlessEmpty(), unlessNotEmpty(), where(), whereNull(), whereNotNull(), whereStrict(), whereIn(), whereInStrict(), whereBetween(), whereNotBetween(), whereNotIn(), whereNotInStrict(), whereInstanceOf(), pipe(), pipeInto(), pipeThrough(), reduce(), reduceSpread(), reduceWithKeys(), reject(), tap(), uniqueStrict(), collect(), toArray(), jsonSerialize(), toJson(), toPrettyJson(), getCachingIterator(), __toString(), escapeWhenCastingToString(), proxy(), __get(), getArrayableItems(), operatorForWhere(), useAsCallable(), valueRetriever(), equality(), negate(), identity()

Methods used from Illuminate\Support\Traits\EnumeratesValues

make(), wrap(), unwrap(), empty(), times(), fromJson(), avg(), average(), some(), dd(), dump(), each(), eachSpread(), every(), firstWhere(), hasMany(), value(), ensure(), isNotEmpty(), mapSpread(), mapToGroups(), flatMap(), mapInto(), min(), max(), forPage(), percentage(), sum(), whenEmpty(), whenNotEmpty(), unlessEmpty(), unlessNotEmpty(), where(), whereNull(), whereNotNull(), whereStrict(), whereIn(), whereInStrict(), whereBetween(), whereNotBetween(), whereNotIn(), whereNotInStrict(), whereInstanceOf(), pipe(), pipeInto(), pipeThrough(), reduce(), reduceSpread(), reduceWithKeys(), reject(), tap(), uniqueStrict(), collect(), toArray(), jsonSerialize(), toJson(), toPrettyJson(), getCachingIterator(), __toString(), escapeWhenCastingToString(), proxy(), __get(), getArrayableItems(), operatorForWhere(), useAsCallable(), valueRetriever(), equality(), negate(), identity()

Methods used from Illuminate\Support\Traits\Macroable
`macro(), mixin(), hasMacro(), flushMacros(), __callStatic(), __call()`

Methods used from Illuminate\Support\Traits\TransformsToResourceCollection
`toResourceCollection(), guessResourceCollection(), resolveResourceFromAttribute(), resolveResourceCollectionFromAttribute()`

Methods used from Illuminate\Database\Eloquent\Relations\Concerns\InteractsWithDictionary
`getDictionaryKey()`

Properties inherited from Illuminate\Support\Collection
`$items`

Properties used from Illuminate\Support\Traits\EnumeratesValues
`$escapeWhenCastingToString, $proxies, $average, $avg, $contains, $doesntContain, $each, $every, $filter, $first, $flatMap, $groupBy, $hasMany, $hasSole, $keyBy, $last, $map, $max, $min, $partition, $percentage, $reject, $skipUntil, $skipWhile, $some, $sortBy, $sortByDesc, $sum, $takeUntil, $takeWhile, $unique, $unless, $until, $when`

Properties used from Illuminate\Support\Traits\Macroable
`$macros`

Namespaces

Classes

Interfaces

Traits

Exceptions

Class Illuminate\Database\Eloquent\Collection

`<TKey is array-key, TModel is Model>`

Throws

Overrides

Overrides

Overrides

Overrides

Overrides

Overrides

Overrides

Overrides

Overrides

Overrides

Overrides

Overrides

Overrides

Overrides

Overrides

Overrides

Implements

Overrides

Overrides

Overrides

Throws

Implements

Implements

Implements

Throws

Implements

Throws