class LazyCollection implements CanBeEscapedWhenCastToString, Enumerable (View source)

Traits

Properties

protected bool $escapeWhenCastingToString

Indicates that the object's string representation should be escaped when __toString is invoked.

from  EnumeratesValues
static protected array<int,string> $proxies

The methods that can be proxied.

from  EnumeratesValues
HigherOrderCollectionProxy read-only $average from  EnumeratesValues
HigherOrderCollectionProxy read-only $avg from  EnumeratesValues
HigherOrderCollectionProxy read-only $contains from  EnumeratesValues
HigherOrderCollectionProxy read-only $doesntContain from  EnumeratesValues
HigherOrderCollectionProxy read-only $each from  EnumeratesValues
HigherOrderCollectionProxy read-only $every from  EnumeratesValues
HigherOrderCollectionProxy read-only $filter from  EnumeratesValues
HigherOrderCollectionProxy read-only $first from  EnumeratesValues
HigherOrderCollectionProxy read-only $flatMap from  EnumeratesValues
HigherOrderCollectionProxy read-only $groupBy from  EnumeratesValues
HigherOrderCollectionProxy read-only $keyBy from  EnumeratesValues
HigherOrderCollectionProxy read-only $map from  EnumeratesValues
HigherOrderCollectionProxy read-only $max from  EnumeratesValues
HigherOrderCollectionProxy read-only $min from  EnumeratesValues
HigherOrderCollectionProxy read-only $partition from  EnumeratesValues
HigherOrderCollectionProxy read-only $percentage from  EnumeratesValues
HigherOrderCollectionProxy read-only $reject from  EnumeratesValues
HigherOrderCollectionProxy read-only $skipUntil from  EnumeratesValues
HigherOrderCollectionProxy read-only $skipWhile from  EnumeratesValues
HigherOrderCollectionProxy read-only $some from  EnumeratesValues
HigherOrderCollectionProxy read-only $sortBy from  EnumeratesValues
HigherOrderCollectionProxy read-only $sortByDesc from  EnumeratesValues
HigherOrderCollectionProxy read-only $sum from  EnumeratesValues
HigherOrderCollectionProxy read-only $takeUntil from  EnumeratesValues
HigherOrderCollectionProxy read-only $takeWhile from  EnumeratesValues
HigherOrderCollectionProxy read-only $unique from  EnumeratesValues
HigherOrderCollectionProxy read-only $unless from  EnumeratesValues
HigherOrderCollectionProxy read-only $until from  EnumeratesValues
HigherOrderCollectionProxy read-only $when from  EnumeratesValues
static protected array $macros

The registered string macros.

from  Macroable
$source

Methods

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

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

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

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

static 
make($items = [])

No description

static 
wrap($value)

No description

static 
unwrap($value)

No description

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.

value($key, $default = null)

No description

ensure($type)

No description

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

float|null
percentage(callable $callback, int $precision = 2)

Calculate the percentage of items that pass a given truth test.

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.

TPipeIntoValue
pipeInto(TPipeIntoValue> $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.

TReduceWithKeysReturnType
reduceWithKeys(callable $callback, TReduceWithKeysInitial $initial = null)

Reduce an associative collection to a single value.

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.

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)

Register a custom macro.

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

Mix another object into the class.

static bool
hasMacro(string $name)

Checks if macro is registered.

static void
flushMacros()

Flush the existing macros.

static mixed
__callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

mixed
__call(string $method, array $parameters)

Dynamically handle calls to the class.

__construct($source = null)

No description

static Enumerable
range(int $from, int $to)

No description

array
all()

No description

eager()

Eager load all items into a new lazy collection backed by an array.

remember()

Cache values as they're enumerated.

float|int|null
avg($callback = null)

Get the average value of a given key.

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

Get the median of a given key.

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

Get the mode of a given key.

collapse()

No description

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

Determine if an item exists in the enumerable.

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

Determine if an item exists, using strict comparison.

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

Determine if an item is not contained in the enumerable.

crossJoin(...$arrays)

No description

countBy($countBy = null)

No description

diff(TValue>|TValue> $items)

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

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

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

diffAssoc(TValue>|TValue> $items)

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

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

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

diffKeys(TValue>|TValue> $items)

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

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

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

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

Retrieve duplicate items.

duplicatesStrict($callback = null)

Retrieve duplicate items using strict comparison.

except(TKey>|TKey> $keys)

Get all items except for those with the specified keys.

filter(callable $callback = null)

Run a filter over each of the items.

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

No description

flatten(int $depth = INF)

No description

flip()

No description

get($key, $default = null)

No description

groupBy($groupBy, $preserveKeys = false)

No description

keyBy($keyBy)

No description

bool
has(TKey|TKey> $key)

Determine if an item exists in the collection by key.

bool
hasAny(mixed $key)

Determine if any of the keys exist in the collection.

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

Concatenate values of a given key as a string.

intersect(TValue>|TValue> $items)

Intersect the collection with the given items.

intersectUsing()

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

intersectAssoc(TValue>|TValue> $items)

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

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

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

intersectByKeys(TValue>|TValue> $items)

Intersect the collection with the given items by key.

bool
isEmpty()

Determine if the items are empty or not.

bool
containsOneItem()

Determine if the collection contains a single item.

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

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

keys()

No description

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

No description

pluck($value, $key = null)

No description

map(callable $callback)

No description

mapToDictionary(callable $callback)

No description

mapWithKeys(callable $callback)

No description

merge(TValue>|TValue> $items)

Merge the collection with the given items.

mergeRecursive($items)

No description

combine($values)

No description

union(TValue>|TValue> $items)

Union the collection with the given items.

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

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

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

Get the items with the specified keys.

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

Select specific values from the items within the collection.

concat($source)

No description

random($number = null)

No description

replace(TValue>|TValue> $items)

Replace the collection items with the given items.

replaceRecursive(TValue>|TValue> $items)

Recursively replace the collection items with the given items.

reverse()

Reverse items order.

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

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

shuffle(int|null $seed = null)

Shuffle the items in the collection.

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

No description

skip(int $count)

Skip the first {$count} items.

skipUntil($value)

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

skipWhile($value)

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

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

Get a slice of items from the enumerable.

split($numberOfGroups)

No description

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.

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.

chunk($size)

No description

splitIn($numberOfGroups)

No description

chunkWhile(callable $callback)

No description

sort($callback = null)

Sort through each item with a callback.

sortDesc(int $options = SORT_REGULAR)

Sort items in descending order.

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

Sort the collection using the given callback.

sortByDesc($callback, int $options = SORT_REGULAR)

Sort the collection in descending order using the given callback.

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

Sort the collection keys.

sortKeysDesc(int $options = SORT_REGULAR)

Sort the collection keys in descending order.

sortKeysUsing(callable $callback)

Sort the collection keys using a callback.

take(int $limit)

Take the first or last {$limit} items.

takeUntil($value)

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

takeUntilTimeout(DateTimeInterface $timeout)

Take items in the collection until a given point in time.

takeWhile($value)

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

tapEach(callable $callback)

Pass each item in the collection to the given callback, lazily.

dot()

Flatten a multi-dimensional associative array with dots.

undot()

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

values()

No description

zip($items)

No description

pad($size, $value)

No description

getIterator()

Get the values iterator.

int
count()

Count the number of items in the collection.

makeIterator($source)

No description

explodePluckParameters(string|string[] $value, string|string[]|null $key)

Explode the "value" and "key" arguments passed to "pluck".

passthru(string $method, array $params)

Pass this lazy collection through a method on the collection class.

int
now()

Get the current time.

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

EnumeratesValues

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

EnumeratesValues

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

value($key, $default = null)

No description

Parameters

$key
$default

ensure($type)

No description

Parameters

$type

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

EnumeratesValues

partition($key, $operator = null, $value = null)

No description

Parameters

$key
$operator
$value

float|null percentage(callable $callback, int $precision = 2)

Calculate the percentage of items that pass a given truth test.

Parameters

callable $callback
int $precision

Return Value

float|null

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

EnumeratesValues whereNull(string|null $key = null)

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

Parameters

string|null $key

Return Value

EnumeratesValues

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

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

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

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

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

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

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

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

EnumeratesValues

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

TPipeIntoValue pipeInto(TPipeIntoValue> $class)

Pass the collection into a new class.

Parameters

TPipeIntoValue> $class

Return Value

TPipeIntoValue

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

TReduceWithKeysReturnType reduceWithKeys(callable $callback, TReduceWithKeysInitial $initial = null)

Reduce an associative collection to a single value.

Parameters

callable $callback
TReduceWithKeysInitial $initial

Return Value

TReduceWithKeysReturnType

EnumeratesValues reject($callback = true)

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

Parameters

$callback

Return Value

EnumeratesValues

$this tap(callable $callback)

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

Parameters

callable $callback

Return Value

$this

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

Return only unique items from the collection array.

Parameters

$key
bool $strict

Return Value

Enumerable

EnumeratesValues uniqueStrict($key = null)

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

Parameters

$key

Return Value

EnumeratesValues

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

Closure

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

Closure $callback

Return Value

Closure

protected identity()

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

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

Register a custom 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

__construct($source = null)

No description

Parameters

$source

static Enumerable range(int $from, int $to)

No description

Parameters

int $from
int $to

Return Value

Enumerable

array all()

No description

Return Value

array

LazyCollection eager()

Eager load all items into a new lazy collection backed by an array.

Return Value

LazyCollection

LazyCollection remember()

Cache values as they're enumerated.

Return Value

LazyCollection

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

No description

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

Determine if an item exists in the enumerable.

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 enumerable.

Parameters

mixed $key
mixed $operator
mixed $value

Return Value

bool

crossJoin(...$arrays)

No description

Parameters

...$arrays

countBy($countBy = null)

No description

Parameters

$countBy

Enumerable diff(TValue>|TValue> $items)

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

Parameters

TValue>|TValue> $items

Return Value

Enumerable

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

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

Parameters

TValue>|TValue> $items
callable $callback

Return Value

Enumerable

Enumerable diffAssoc(TValue>|TValue> $items)

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

Parameters

TValue>|TValue> $items

Return Value

Enumerable

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

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

Parameters

TValue>|TValue> $items
callable $callback

Return Value

Enumerable

Enumerable diffKeys(TValue>|TValue> $items)

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

Parameters

TValue>|TValue> $items

Return Value

Enumerable

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

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

Parameters

TValue>|TValue> $items
callable $callback

Return Value

Enumerable

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

Retrieve duplicate items.

Parameters

$callback
bool $strict

Return Value

Enumerable

Enumerable duplicatesStrict($callback = null)

Retrieve duplicate items using strict comparison.

Parameters

$callback

Return Value

Enumerable

Enumerable except(TKey>|TKey> $keys)

Get all items except for those with the specified keys.

Parameters

TKey>|TKey> $keys

Return Value

Enumerable

Enumerable filter(callable $callback = null)

Run a filter over each of the items.

Parameters

callable $callback

Return Value

Enumerable

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

No description

Parameters

callable $callback
$default

Enumerable flatten(int $depth = INF)

No description

Parameters

int $depth

Return Value

Enumerable

flip()

No description

get($key, $default = null)

No description

Parameters

$key
$default

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

Concatenate values of a given key as a string.

Parameters

callable|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

Enumerable

LazyCollection intersectUsing()

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

Return Value

LazyCollection

LazyCollection intersectAssoc(TValue>|TValue> $items)

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

Parameters

TValue>|TValue> $items

Return Value

LazyCollection

LazyCollection 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

LazyCollection

Enumerable intersectByKeys(TValue>|TValue> $items)

Intersect the collection with the given items by key.

Parameters

TValue>|TValue> $items

Return Value

Enumerable

bool isEmpty()

Determine if the items are 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()

No description

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

No description

Parameters

callable $callback
$default

pluck($value, $key = null)

No description

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

Enumerable

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

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

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

Get the items with the specified keys.

Parameters

TKey>|TKey>|string $keys

Return Value

Enumerable

LazyCollection select(TKey>|TKey>|string $keys)

Select specific values from the items within the collection.

Parameters

TKey>|TKey>|string $keys

Return Value

LazyCollection

concat($source)

No description

Parameters

$source

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

Enumerable replaceRecursive(TValue>|TValue> $items)

Recursively replace the collection items with the given items.

Parameters

TValue>|TValue> $items

Return Value

Enumerable

Enumerable reverse()

Reverse items order.

Return Value

Enumerable

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

Parameters

$value
bool $strict

Return Value

TKey|bool

Enumerable shuffle(int|null $seed = null)

Shuffle the items in the collection.

Parameters

int|null $seed

Return Value

Enumerable

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

Enumerable skipUntil($value)

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

Parameters

$value

Return Value

Enumerable

Enumerable skipWhile($value)

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

Parameters

$value

Return Value

Enumerable

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

Get a slice of items from the enumerable.

Parameters

int $offset
int|null $length

Return Value

Enumerable

split($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

splitIn($numberOfGroups)

No description

Parameters

$numberOfGroups

chunkWhile(callable $callback)

No description

Parameters

callable $callback

Enumerable sort($callback = null)

Sort through each item with a callback.

Parameters

$callback

Return Value

Enumerable

Enumerable sortDesc(int $options = SORT_REGULAR)

Sort items in descending order.

Parameters

int $options

Return Value

Enumerable

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

Enumerable

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

Sort the collection in descending order using the given callback.

Parameters

$callback
int $options

Return Value

Enumerable

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

Sort the collection keys.

Parameters

int $options
bool $descending

Return Value

Enumerable

Enumerable sortKeysDesc(int $options = SORT_REGULAR)

Sort the collection keys in descending order.

Parameters

int $options

Return Value

Enumerable

Enumerable sortKeysUsing(callable $callback)

Sort the collection keys using a callback.

Parameters

callable $callback

Return Value

Enumerable

Enumerable take(int $limit)

Take the first or last {$limit} items.

Parameters

int $limit

Return Value

Enumerable

Enumerable takeUntil($value)

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

Parameters

$value

Return Value

Enumerable

LazyCollection takeUntilTimeout(DateTimeInterface $timeout)

Take items in the collection until a given point in time.

Parameters

DateTimeInterface $timeout

Return Value

LazyCollection

Enumerable takeWhile($value)

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

Parameters

$value

Return Value

Enumerable

LazyCollection tapEach(callable $callback)

Pass each item in the collection to the given callback, lazily.

Parameters

callable $callback

Return Value

LazyCollection

LazyCollection dot()

Flatten a multi-dimensional associative array with dots.

Return Value

LazyCollection

Enumerable undot()

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

Return Value

Enumerable

values()

No description

zip($items)

No description

Parameters

$items

pad($size, $value)

No description

Parameters

$size
$value

Traversable getIterator()

Get the values iterator.

Return Value

Traversable

int count()

Count the number of items in the collection.

Return Value

int

protected makeIterator($source)

No description

Parameters

$source

protected explodePluckParameters(string|string[] $value, string|string[]|null $key)

Explode the "value" and "key" arguments passed to "pluck".

Parameters

string|string[] $value
string|string[]|null $key

protected LazyCollection passthru(string $method, array $params)

Pass this lazy collection through a method on the collection class.

Parameters

string $method
array $params

Return Value

LazyCollection

protected int now()

Get the current time.

Return Value

int