DatabaseNotificationCollection

static

wrap($value)

No description

static

unwrap($value)

No description

static EnumeratesValues

empty()

Create a new instance with no items.

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.

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)

Execute a callback over each nested chunk of items.

bool

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

Determine if all items pass the given truth test.

TValue|null

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

Get the first item by the given key value pair.

mixed

value(string $key, mixed $default = null)

Get a single key's value from the first matching item in the collection.

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

mixed

min($callback = null)

Get the min value of a given key.

mixed

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(callable|string $key, mixed $operator = null, mixed $value = null)

Filter items by the given key value pair.

whereNull(string|null $key = null)

Filter items where the value for the given key is null.

whereNotNull(string|null $key = null)

Filter items where the value for the given key is not null.

whereStrict(string $key, mixed $value)

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

whereIn(string $key, Arrayable|iterable $values, bool $strict = false)

Filter items by the given key value pair.

whereInStrict(string $key, Arrayable|iterable $values)

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

whereBetween(string $key, Arrayable|iterable $values)

Filter items such that the value of the given key is between the given values.

whereNotBetween(string $key, Arrayable|iterable $values)

Filter items such that the value of the given key is not between the given values.

whereNotIn(string $key, Arrayable|iterable $values, bool $strict = false)

Filter items by the given key value pair.

whereNotInStrict(string $key, Arrayable|iterable $values)

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

whereInstanceOf($type)

No description

TPipeReturnType

pipe(callable $callback)

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

mixed

pipeInto(class-string $class)

Pass the collection into a new class.

mixed

pipeThrough(callable[] $callbacks)

Pass the collection through a series of callable pipes and return the result.

TReduceReturnType

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

Reduce the collection to a single value.

array

reduceSpread(callable $callback, mixed ...$initial)

Reduce the collection to multiple aggregate values.

reject($callback = true)

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

$this

tap(callable $callback)

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

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

Return only unique items from the collection array.

uniqueStrict($key = null)

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

TValue>

collect()

Collect the values into a collection.

toArray()

No description

array

jsonSerialize()

No description

string

toJson(int $options = 0)

Get the collection of items as JSON.

CachingIterator

getCachingIterator(int $flags = CachingIterator::CALL_TOSTRING)

Get a CachingIterator instance.

string

__toString()

Convert the collection to its string representation.

$this

escapeWhenCastingToString(bool $escape = true)

Indicate that the model's string representation should be escaped when __toString is invoked.

static void

proxy(string $method)

Add a method to the list of proxied methods.

mixed

__get(string $key)

Dynamically access collection proxies.

getArrayableItems($items)

No description

operatorForWhere(callable|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)

from Macroable

static void

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

Mix another object into the class.

from Macroable

static bool

hasMacro(string $name)

Checks if macro is registered.

from Macroable

static void

flushMacros()

Flush the existing macros.

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(TValue>|TValue>|null $items = [])

Create a new collection.

from Collection

static Enumerable

range(int $from, int $to)

No description

from Collection

array

all()

No description

from Collection

TValue>

lazy()

Get a lazy collection for the items in this collection.

from Collection

float|int|null

avg($callback = null)

Get the average value of a given key.

from Collection

float|int|null

median(string|array<array-key,string>|null $key = null)

Get the median of a given key.

from Collection

array<int,float|int>|null

mode(string|array<array-key,string>|null $key = null)

Get the mode of a given key.

from Collection

collapse()

Collapse the collection of items into a single array.

from Collection

bool

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

Determine if a key exists in the collection.

from Collection

bool

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

Determine if an item exists, using strict comparison.

from Collection

bool

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

Determine if an item is not contained in the collection.

from Collection

crossJoin(...$lists)

No description

from Collection

diff(TValue>|TValue> $items)

Diff the collection with the given items.

from Collection

diffUsing(TValue>|TValue> $items, callable $callback)

Get the items in the collection that are not present in the given items, using the callback.

from Collection

diffAssoc(TValue>|TValue> $items)

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

from Collection

diffAssocUsing(TValue>|TValue> $items, callable $callback)

Get the items in the collection whose keys and values are not present in the given items, using the callback.

from Collection

diffKeys(TValue>|TValue> $items)

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

from Collection

diffKeysUsing(TValue>|TValue> $items, callable $callback)

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

from Collection

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

Retrieve duplicate items from the collection.

from Collection

duplicatesStrict($callback = null)

Retrieve duplicate items from the collection using strict comparison.

from Collection

duplicateComparator(bool $strict)

Get the comparison function to detect duplicates.

from Collection

except(TKey>|TKey> $keys)

No description

from Collection

filter(callable $callback = null)

Run a filter over each of the items.

from Collection

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

No description

from Collection

flatten(int $depth = INF)

Get a flattened array of the items in the collection.

from Collection

flip()

Flip the items in the collection.

from Collection

$this

forget(TKey|TKey> $keys)

Remove an item from the collection by key.

from Collection

get($key, $default = null)

No description

from Collection

mixed

getOrPut(mixed $key, mixed $value)

Get an item from the collection by key or add it to collection if it does not exist.

from Collection

groupBy($groupBy, $preserveKeys = false)

No description

from Collection

keyBy($keyBy)

No description

from Collection

bool

has(TKey|TKey> $key)

Determine if an item exists in the collection by key.

from Collection

bool

hasAny(mixed $key)

Determine if any of the keys exist in the collection.

from Collection

string

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

Concatenate values of a given key as a string.

from Collection

intersect(TValue>|TValue> $items)

Intersect the collection with the given items.

from Collection

intersectUsing(TValue>|TValue> $items, callable $callback)

Intersect the collection with the given items, using the callback.

from Collection

intersectAssoc(TValue>|TValue> $items)

Intersect the collection with the given items with additional index check.

from Collection

intersectAssocUsing(TValue>|TValue> $items, callable $callback)

Intersect the collection with the given items with additional index check, using the callback.

from Collection

intersectByKeys(TValue>|TValue> $items)

Intersect the collection with the given items by key.

from Collection

bool

isEmpty()

Determine if the collection is empty or not.

from Collection

bool

containsOneItem()

Determine if the collection contains a single item.

from Collection

string

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

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

from Collection

keys()

Get the keys of the collection items.

from Collection

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

No description

from Collection

pluck($value, $key = null)

Get an array with the values of a given key.

from Collection

map(callable $callback)

No description

from Collection

mapToDictionary(callable $callback)

No description

from Collection

mapWithKeys(callable $callback)

No description

from Collection

merge(TValue>|TValue> $items)

Merge the collection with the given items.

from Collection

mergeRecursive($items)

No description

from Collection

combine($values)

No description

from Collection

union(TValue>|TValue> $items)

Union the collection with the given items.

from Collection

nth(int $step, int $offset = 0)

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

from Collection

only(TKey>|TKey>|string $keys)

No description

from Collection

pop($count = 1)

No description

from Collection

$this

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

Push an item onto the beginning of the collection.

from Collection

$this

push(TValue ...$values)

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

from Collection

concat(TValue> $source)

Push all of the given items onto the collection.

from Collection

pull($key, $default = null)

No description

from Collection

$this

put(TKey $key, TValue $value)

Put an item in the collection by key.

from Collection

random($number = null)

No description

from Collection

replace(TValue>|TValue> $items)

Replace the collection items with the given items.

from Collection

replaceRecursive(TValue>|TValue> $items)

Recursively replace the collection items with the given items.

from Collection

reverse()

Reverse items order.

from Collection

TKey|bool

search($value, bool $strict = false)

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

from Collection

shift($count = 1)

No description

from Collection

shuffle(int|null $seed = null)

Shuffle the items in the collection.

from Collection

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

No description

from Collection

skip(int $count)

Skip the first {$count} items.

from Collection

skipUntil($value)

Skip items in the collection until the given condition is met.

from Collection

skipWhile($value)

Skip items in the collection while the given condition is met.

from Collection

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

Slice the underlying collection array.

from Collection

split($numberOfGroups)

No description

from Collection

splitIn($numberOfGroups)

No description

from Collection

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.

from Collection

TValue

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

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

from Collection

chunk($size)

No description

from Collection

chunkWhile(callable $callback)

No description

from Collection

sort($callback = null)

Sort through each item with a callback.

from Collection

sortDesc(int $options = SORT_REGULAR)

Sort items in descending order.

from Collection

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

Sort the collection using the given callback.

from Collection

sortByMany(array $comparisons = [])

Sort the collection using multiple comparisons.

from Collection

sortByDesc($callback, int $options = SORT_REGULAR)

Sort the collection in descending order using the given callback.

from Collection

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

Sort the collection keys.

from Collection

sortKeysDesc(int $options = SORT_REGULAR)

Sort the collection keys in descending order.

from Collection

sortKeysUsing(callable $callback)

Sort the collection keys using a callback.

from Collection

splice(int $offset, int|null $length = null, TValue> $replacement = [])

Splice a portion of the underlying collection array.

from Collection

take(int $limit)

Take the first or last {$limit} items.

from Collection

takeUntil($value)

Take items in the collection until the given condition is met.

from Collection

takeWhile($value)

Take items in the collection while the given condition is met.

from Collection

$this

transform(callable $callback)

Transform each item in the collection using a callback.

from Collection

undot()

Convert a flatten "dot" notation array into an expanded array.

from Collection

values()

No description

from Collection

zip($items)

Zip the collection together with one or more arrays.

from Collection

pad($size, $value)

Pad collection to the specified length with a value.

from Collection

Traversable

getIterator()

Get an iterator for the items.

from Collection

int

count()

Count the number of items in the collection.

from Collection

countBy($countBy = null)

Count the number of items in the collection by a field or using a callback.

from Collection

$this

add(TValue $item)

Add an item to the collection.

from Collection

TValue>

toBase()

Get a base Support collection instance from this collection.

from Collection

bool

offsetExists(TKey $key)

Determine if an item exists at an offset.

from Collection

mixed

offsetGet(TKey $key)

Get an item at a given offset.

from Collection

void

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

Set the item at a given offset.

from Collection

void

offsetUnset(TKey $key)

Unset the item at a given offset.

from Collection

find($key, $default = null)

No description

from Collection

$this

load($relations)

Load a set of relationships onto the collection.

from Collection

$this

loadAggregate($relations, string $column, string|null $function = null)

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

from Collection

$this

loadCount($relations)

Load a set of relationship counts onto the collection.

from Collection

$this

loadMax($relations, string $column)

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

from Collection

$this

loadMin($relations, string $column)

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

from Collection

$this

loadSum($relations, string $column)

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

from Collection

$this

loadAvg($relations, string $column)

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

from Collection

$this

loadExists($relations)

Load a set of related existences onto the collection.

from Collection

$this

loadMissing($relations)

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

from Collection

void

loadMissingRelation(Collection $models, array $path)

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

from Collection

$this

loadMorph(string $relation, $relations)

Load a set of relationships onto the mixed relationship collection.

from Collection

$this

loadMorphCount(string $relation, $relations)

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

from Collection

array<int,array-key>

modelKeys()

Get the array of primary keys.

from Collection

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

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

from Collection

$this

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

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

from Collection

$this

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

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

from Collection

$this

setVisible(array<int,string> $visible)

Set the visible attributes across the entire collection.

from Collection

$this

setHidden(array<int,string> $hidden)

Set the hidden attributes across the entire collection.

from Collection

$this

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

Append an attribute across the entire collection.

from Collection

TModel>

getDictionary(TModel>|null $items = null)

Get a dictionary keyed by primary keys.

from Collection

string|null

getQueueableClass()

Get the type of the entities being queued.

from Collection

string

getQueueableModelClass(Model $model)

Get the queueable class name for the given model.

from Collection

array<int,mixed>

getQueueableIds()

Get the identifiers for all of the entities.

from Collection

array<int,string>

getQueueableRelations()

Get the relationships of the entities being queued.

from Collection

string|null

getQueueableConnection()

Get the connection of the entities being queued.

from Collection

Builder

toQuery()

Get the Eloquent query builder from the collection.

from Collection

void

markAsRead()

Mark all notifications as read.

void

markAsUnread()

Mark all notifications as unread.

Details

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

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

Parameters

	$value
callable	$callback
callable	$default

Return Value

$this|TWhenReturnType

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

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

Parameters

	$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 EnumeratesValues empty()

Create a new instance with no items.

Return Value

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

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

EnumeratesValues eachSpread(callable $callback)

Execute a callback over each nested chunk of items.

Parameters

callable

$callback

Return Value

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(callable|string $key, mixed $operator = null, mixed $value = null)

Get the first item by the given key value pair.

Parameters

callable\|string	$key
mixed	$operator
mixed	$value

Return Value

TValue|null

mixed value(string $key, mixed $default = null)

Get a single key's value from the first matching item in the collection.

Parameters

string	$key
mixed	$default

Return Value

mixed

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

mixed min($callback = null)

Get the min value of a given key.

Parameters

$callback

Return Value

mixed

mixed max($callback = null)

Get the max value of a given key.

Parameters

$callback

Return Value

mixed

EnumeratesValues forPage(int $page, int $perPage)

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

Parameters

int	$page
int	$perPage

Return Value

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

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

Filter items by the given key value pair.

Parameters

callable\|string	$key
mixed	$operator
mixed	$value

Return Value

EnumeratesValues whereNull(string|null $key = null)

Filter items where the value for the given key is null.

Parameters

string|null

$key

Return Value

EnumeratesValues whereNotNull(string|null $key = null)

Filter items where the value for the given key is not null.

Parameters

string|null

$key

Return Value

EnumeratesValues whereStrict(string $key, mixed $value)

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

Parameters

string	$key
mixed	$value

Return Value

EnumeratesValues whereIn(string $key, Arrayable|iterable $values, bool $strict = false)

Filter items by the given key value pair.

Parameters

string	$key
Arrayable\|iterable	$values
bool	$strict

Return Value

EnumeratesValues whereInStrict(string $key, Arrayable|iterable $values)

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

Parameters

string	$key
Arrayable\|iterable	$values

Return Value

EnumeratesValues whereBetween(string $key, Arrayable|iterable $values)

Filter items such that the value of the given key is between the given values.

Parameters

string	$key
Arrayable\|iterable	$values

Return Value

EnumeratesValues whereNotBetween(string $key, Arrayable|iterable $values)

Filter items such that the value of the given key is not between the given values.

Parameters

string	$key
Arrayable\|iterable	$values

Return Value

EnumeratesValues whereNotIn(string $key, Arrayable|iterable $values, bool $strict = false)

Filter items by the given key value pair.

Parameters

string	$key
Arrayable\|iterable	$values
bool	$strict

Return Value

EnumeratesValues whereNotInStrict(string $key, Arrayable|iterable $values)

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

Parameters

string	$key
Arrayable\|iterable	$values

Return Value

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-string $class)

Pass the collection into a new class.

Parameters

class-string

$class

Return Value

mixed

mixed pipeThrough(callable[] $callbacks)

Pass the collection through a series of callable pipes and return the result.

Parameters

callable[]

$callbacks

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

array reduceSpread(callable $callback, mixed ...$initial)

Reduce the collection to multiple aggregate values.

Parameters

callable	$callback
mixed	...$initial

Return Value

array

Exceptions

UnexpectedValueException

EnumeratesValues reject($callback = true)

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

Parameters

$callback

Return Value

$this tap(callable $callback)

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

Parameters

callable

$callback

Return Value

$this

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

Return only unique items from the collection array.

Parameters

	$key
bool	$strict

Return Value

EnumeratesValues uniqueStrict($key = null)

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

Parameters

$key

Return Value

TValue> collect()

Collect the values into a collection.

Return Value

TValue>

toArray()

No description

array jsonSerialize()

No description

Return Value

array

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

$this escapeWhenCastingToString(bool $escape = true)

Indicate that the model's string representation should be escaped when __toString is invoked.

Parameters

bool

$escape

Return Value

$this

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 getArrayableItems($items)

No description

Parameters

$items

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

Get an operator checker callback.

Parameters

callable\|string	$key
string\|null	$operator
mixed	$value

Return Value

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 equality(mixed $value)

Make a function to check an item's equality.

Parameters

mixed

$value

protected Closure negate(Closure $callback)

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

Parameters

$callback

Return Value

protected identity()

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

static void macro(string $name, object|callable $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 void flushMacros()

Flush the existing macros.

Return Value

void

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

array all()

No description

Return Value

array

TValue> lazy()

Get a lazy collection for the items in this collection.

Return Value

TValue>

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

Get the median of a given key.

Parameters

string|array<array-key,string>|null

$key

Return Value

float|int|null

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

Get the mode of a given key.

Parameters

string|array<array-key,string>|null

$key

Return Value

array<int,float|int>|null

collapse()

Collapse the collection of items into a single array.

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

Determine if a key exists in the collection.

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

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

Determine if an item is not contained in the collection.

Parameters

mixed	$key
mixed	$operator
mixed	$value

Return Value

bool

crossJoin(...$lists)

No description

Parameters

...$lists

Enumerable diff(TValue>|TValue> $items)

Diff the collection with the given items.

Parameters

TValue>|TValue>

$items

Return Value

Enumerable diffUsing(TValue>|TValue> $items, callable $callback)

Get the items in the collection that are not present in the given items, using the callback.

Parameters

TValue>\|TValue>	$items
callable	$callback

Return Value

Enumerable diffAssoc(TValue>|TValue> $items)

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

Parameters

TValue>|TValue>

$items

Return Value

Enumerable diffAssocUsing(TValue>|TValue> $items, callable $callback)

Get the items in the collection whose keys and values are not present in the given items, using the callback.

Parameters

TValue>\|TValue>	$items
callable	$callback

Return Value

Enumerable diffKeys(TValue>|TValue> $items)

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

Parameters

TValue>|TValue>

$items

Return Value

Enumerable diffKeysUsing(TValue>|TValue> $items, callable $callback)

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

Parameters

TValue>\|TValue>	$items
callable	$callback

Return Value

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

Retrieve duplicate items from the collection.

Parameters

	$callback
bool	$strict

Return Value

Enumerable duplicatesStrict($callback = null)

Retrieve duplicate items from the collection using strict comparison.

Parameters

$callback

Return Value

protected duplicateComparator(bool $strict)

Get the comparison function to detect duplicates.

Parameters

bool

$strict

Enumerable except(TKey>|TKey> $keys)

No description

Parameters

TKey>|TKey>

$keys

Return Value

Enumerable filter(callable $callback = null)

Run a filter over each of the items.

Parameters

callable

$callback

Return Value

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

No description

Parameters

callable	$callback
	$default

Enumerable flatten(int $depth = INF)

Get a flattened array of the items in the collection.

Parameters

int

$depth

Return Value

flip()

Flip the items in the collection.

$this forget(TKey|TKey> $keys)

Remove an item from the collection by key.

Parameters

TKey|TKey>

$keys

Return Value

$this

get($key, $default = null)

No description

Parameters

	$key
	$default

mixed getOrPut(mixed $key, mixed $value)

Get an item from the collection by key or add it to collection if it does not exist.

Parameters

mixed	$key
mixed	$value

Return Value

mixed

groupBy($groupBy, $preserveKeys = false)

No description

Parameters

	$groupBy
	$preserveKeys

keyBy($keyBy)

No description

Parameters

$keyBy

bool has(TKey|TKey> $key)

Determine if an item exists in the collection by key.

Parameters

TKey|TKey>

$key

Return Value

bool

bool hasAny(mixed $key)

Determine if any of the keys exist in the collection.

Parameters

mixed

$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

Enumerable intersect(TValue>|TValue> $items)

Intersect the collection with the given items.

Parameters

TValue>|TValue>

$items

Return Value

Collection intersectUsing(TValue>|TValue> $items, callable $callback)

Intersect the collection with the given items, using the callback.

Parameters

TValue>\|TValue>	$items
callable	$callback

Return Value

Collection intersectAssoc(TValue>|TValue> $items)

Intersect the collection with the given items with additional index check.

Parameters

TValue>|TValue>

$items

Return Value

Collection intersectAssocUsing(TValue>|TValue> $items, callable $callback)

Intersect the collection with the given items with additional index check, using the callback.

Parameters

TValue>\|TValue>	$items
callable	$callback

Return Value

Enumerable intersectByKeys(TValue>|TValue> $items)

Intersect the collection with the given items by key.

Parameters

TValue>|TValue>

$items

Return Value

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

Get the keys of the collection items.

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

No description

Parameters

callable	$callback
	$default

pluck($value, $key = null)

Get an array with the values of a given key.

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

Enumerable merge(TValue>|TValue> $items)

Merge the collection with the given items.

Parameters

TValue>|TValue>

$items

Return Value

mergeRecursive($items)

No description

Parameters

$items

combine($values)

No description

Parameters

$values

Enumerable union(TValue>|TValue> $items)

Union the collection with the given items.

Parameters

TValue>|TValue>

$items

Return Value

Enumerable nth(int $step, int $offset = 0)

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

Parameters

int	$step
int	$offset

Return Value

Enumerable only(TKey>|TKey>|string $keys)

No description

Parameters

TKey>|TKey>|string

$keys

Return Value

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(TValue ...$values)

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

Parameters

TValue

...$values

Return Value

$this

Enumerable concat(TValue> $source)

Push all of the given items onto the collection.

Parameters

TValue>

$source

Return Value

pull($key, $default = null)

No description

Parameters

	$key
	$default

$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

Enumerable replace(TValue>|TValue> $items)

Replace the collection items with the given items.

Parameters

TValue>|TValue>

$items

Return Value

Enumerable replaceRecursive(TValue>|TValue> $items)

Recursively replace the collection items with the given items.

Parameters

TValue>|TValue>

$items

Return Value

Enumerable reverse()

Reverse items order.

Return Value

TKey|bool search($value, bool $strict = false)

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

Enumerable shuffle(int|null $seed = null)

Shuffle the items in the collection.

Parameters

int|null

$seed

Return Value

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

No description

Parameters

	$size
	$step

Enumerable skip(int $count)

Skip the first {$count} items.

Parameters

int

$count

Return Value

Enumerable skipUntil($value)

Skip items in the collection until the given condition is met.

Parameters

$value

Return Value

Enumerable skipWhile($value)

Skip items in the collection while the given condition is met.

Parameters

$value

Return Value

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

Slice the underlying collection array.

Parameters

int	$offset
int\|null	$length

Return Value

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

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

	$key
mixed	$operator
mixed	$value

Return Value

TValue

Exceptions

ItemNotFoundException

chunk($size)

No description

Parameters

$size

chunkWhile(callable $callback)

No description

Parameters

callable

$callback

Enumerable sort($callback = null)

Sort through each item with a callback.

Parameters

$callback

Return Value

Enumerable sortDesc(int $options = SORT_REGULAR)

Sort items in descending order.

Parameters

int

$options

Return Value

Enumerable sortBy($callback, int $options = SORT_REGULAR, bool $descending = false)

Sort the collection using the given callback.

Parameters

	$callback
int	$options
bool	$descending

Return Value

protected Collection sortByMany(array $comparisons = [])

Sort the collection using multiple comparisons.

Parameters

array

$comparisons

Return Value

Enumerable sortByDesc($callback, int $options = SORT_REGULAR)

Sort the collection in descending order using the given callback.

Parameters

	$callback
int	$options

Return Value

Enumerable sortKeys(int $options = SORT_REGULAR, bool $descending = false)

Sort the collection keys.

Parameters

int	$options
bool	$descending

Return Value

Enumerable sortKeysDesc(int $options = SORT_REGULAR)

Sort the collection keys in descending order.

Parameters

int

$options

Return Value

Enumerable sortKeysUsing(callable $callback)

Sort the collection keys using a callback.

Parameters

callable

$callback

Return Value

Collection splice(int $offset, int|null $length = null, TValue> $replacement = [])

Splice a portion of the underlying collection array.

Parameters

int	$offset
int\|null	$length
TValue>	$replacement

Return Value

Enumerable take(int $limit)

Take the first or last {$limit} items.

Parameters

int

$limit

Return Value

Enumerable takeUntil($value)

Take items in the collection until the given condition is met.

Parameters

$value

Return Value

Enumerable takeWhile($value)

Take items in the collection while the given condition is met.

Parameters

$value

Return Value

$this transform(callable $callback)

Transform each item in the collection using a callback.

Parameters

callable

$callback

Return Value

$this

Enumerable undot()

Convert a flatten "dot" notation array into an expanded array.

Return Value

values()

No description

zip($items)

Zip the collection together with one or more arrays.

Parameters

$items

pad($size, $value)

Pad collection to the specified length with a value.

Parameters

	$size
	$value

Traversable getIterator()

Get an iterator for the items.

Return Value

Traversable

int count()

Count the number of items in the collection.

Return Value

int

countBy($countBy = null)

Count the number of items in the collection by a field or using a callback.

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

mixed offsetGet(TKey $key)

Get an item at a given offset.

Parameters

TKey

$key

Return Value

mixed

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

find($key, $default = null)

No description

Parameters

	$key
	$default

$this load($relations)

Load a set of relationships onto the collection.

Parameters

$relations

Return Value

$this

$this loadAggregate($relations, string $column, string|null $function = null)

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

Parameters

	$relations
string	$column
string\|null	$function

Return Value

$this

$this loadCount($relations)

Load a set of relationship counts onto the collection.

Parameters

$relations

Return Value

$this

$this loadMax($relations, string $column)

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

Parameters

	$relations
string	$column

Return Value

$this

$this loadMin($relations, string $column)

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

Parameters

	$relations
string	$column

Return Value

$this

$this loadSum($relations, string $column)

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

Parameters

	$relations
string	$column

Return Value

$this

$this loadAvg($relations, string $column)

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

Parameters

	$relations
string	$column

Return Value

$this

$this loadExists($relations)

Load a set of related existences onto the collection.

Parameters

$relations

Return Value

$this

$this loadMissing($relations)

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

Parameters

$relations

Return Value

$this

protected void loadMissingRelation(Collection $models, array $path)

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

Parameters

Collection	$models
array	$path

Return Value

void

$this loadMorph(string $relation, $relations)

Load a set of relationships onto the mixed relationship collection.

Parameters

string	$relation
	$relations

Return Value

$this

$this loadMorphCount(string $relation, $relations)

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

Parameters

string	$relation
	$relations

Return Value

$this

array<int,array-key> modelKeys()

Get the array of primary keys.

Return Value

array<int,array-key>

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

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

Parameters

array<array-key,string>|string

$with

Return Value