class LazyCollection implements CanBeEscapedWhenCastToString, Enumerable, Transient

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
TValue, static> read-only $average from  EnumeratesValues
TValue, static> read-only $avg from  EnumeratesValues
TValue, static> read-only $contains from  EnumeratesValues
TValue, static> read-only $doesntContain from  EnumeratesValues
TValue, static> read-only $each from  EnumeratesValues
TValue, static> read-only $every from  EnumeratesValues
TValue, static> read-only $filter from  EnumeratesValues
TValue, static> read-only $first from  EnumeratesValues
TValue, static> read-only $flatMap from  EnumeratesValues
TValue, static> read-only $groupBy from  EnumeratesValues
TValue, static> read-only $hasMany from  EnumeratesValues
TValue, static> read-only $hasSole from  EnumeratesValues
TValue, static> read-only $keyBy from  EnumeratesValues
TValue, static> read-only $last from  EnumeratesValues
TValue, static> read-only $map from  EnumeratesValues
TValue, static> read-only $max from  EnumeratesValues
TValue, static> read-only $min from  EnumeratesValues
TValue, static> read-only $partition from  EnumeratesValues
TValue, static> read-only $percentage from  EnumeratesValues
TValue, static> read-only $reject from  EnumeratesValues
TValue, static> read-only $skipUntil from  EnumeratesValues
TValue, static> read-only $skipWhile from  EnumeratesValues
TValue, static> read-only $sole from  EnumeratesValues
TValue, static> read-only $some from  EnumeratesValues
TValue, static> read-only $sortBy from  EnumeratesValues
TValue, static> read-only $sortByDesc from  EnumeratesValues
TValue, static> read-only $sum from  EnumeratesValues
TValue, static> read-only $takeUntil from  EnumeratesValues
TValue, static> read-only $takeWhile from  EnumeratesValues
TValue, static> read-only $unique from  EnumeratesValues
TValue, static> read-only $unless from  EnumeratesValues
TValue, static> read-only $until from  EnumeratesValues
TValue, static> read-only $when from  EnumeratesValues
static protected array $macros

The registered string macros.

from  Macroable
TValue>|TValue>|LazyCollection $source

The source from which to generate items.

Methods

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

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

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

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

static Enumerable
make(Arrayable|iterable|null $items = [], mixed ...$args)

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

wrap(mixed $value, mixed ...$args)

Wrap the given value in a collection if applicable.

static mixed
unwrap(mixed $value)

Get the underlying items from the given collection if applicable.

empty(mixed ...$args)

Create a new instance with no items.

times(int $number, callable|null $callback = null, mixed ...$args)

Create a new collection by invoking the callback a given amount of times.

fromJson(string $json, int $depth = 513, int $flags = 0, mixed ...$args)

Create a new collection by decoding a JSON string.

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

Get the average value of a given key.

float|int|null
average(callable|string|null $callback = null)

Alias for the "avg" method.

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

Alias for the "contains" method.

never
dd(mixed ...$args)

Dump the given arguments and terminate execution.

dump(mixed ...$args)

Dump the items.

each(callable $callback)

Execute a callback over each item.

eachSpread(callable $callback)

Execute a callback over each nested chunk of items.

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

Determine if all items pass the given truth test.

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

Get the first item by the given key value pair.

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

Determine if the collection contains multiple items, optionally matching the given criteria.

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

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

ensure(string|array $type)

Ensure that every item in the collection is of the expected type.

bool
isNotEmpty()

Determine if the collection is not empty.

mapSpread(callable $callback)

Run a map over each nested chunk of items.

mapToGroups(callable $callback)

Run a grouping map over the items.

flatMap(callable $callback)

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

mapInto(string $class)

Map the values into a new class.

mixed
min(callable|int|string|null $callback = null)

Get the min value of a given key.

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

Partition the collection into two arrays using the given callback or key.

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

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

mixed
sum(callable|int|string|null $callback = null)

Get the sum of the given values.

mixed
whenEmpty(callable $callback, callable|null $default = null)

Apply the callback if the collection is empty.

mixed
whenNotEmpty(callable $callback, callable|null $default = null)

Apply the callback if the collection is not empty.

mixed
unlessEmpty(callable $callback, callable|null $default = null)

Apply the callback unless the collection is empty.

mixed
unlessNotEmpty(callable $callback, callable|null $default = null)

Apply the callback unless the collection is not empty.

where(callable|string|null $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(callable|string|null $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(string|array $type)

Filter the items, removing any items that don't match the given type(s).

mixed
pipe(callable $callback)

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

mixed
pipeInto(string $class)

Pass the collection into a new class.

mixed
pipeThrough(array $callbacks)

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

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

Reduce the collection to a single value.

mixed
reduceInto(mixed $initial, callable $callback)

Reduce the collection to a single value by mutating an initial value.

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

Reduce the collection to multiple aggregate values.

mixed
reduceWithKeys(callable $callback, mixed $initial = null)

Reduce an associative collection to a single value.

reject(mixed $callback = true)

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

chunkBy(callable|string $key)

Chunk the collection into chunks by comparing adjacent values using the given key or callback.

tap(callable $callback)

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

unique(callable|int|string|null $key = null, bool $strict = false)

Return only unique items from the collection array.

uniqueStrict(callable|string|null $key = null)

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

collect()

Collect the values into a collection.

array
toArray()

Get the collection of items as a plain array.

array
jsonSerialize()

Convert the object into something JSON serializable.

string
toJson(int $options = 0)

Get the collection of items as JSON.

string
toPrettyJson(int $options = 0)

Get the collection of items as pretty print formatted JSON.

getCachingIterator(int $flags = CachingIterator::CALL_TOSTRING)

Get a CachingIterator instance.

string
__toString()

Convert the collection to its string representation.

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.

static void
flushProxies()

Flush the registered proxies, restoring the default list.

mixed
__get(string $key)

Dynamically access collection proxies.

array
getArrayableItems(mixed $items)

Results array of items from Collection or Arrayable.

callable
operatorForWhere(callable|string|null $key, mixed $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|int|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, callable|object $macro)

Register a custom macro.

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

Mix another object into the class.

static bool
hasMacro(string $name)

Check 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(mixed $source = null)

Create a new lazy collection instance.

newInstance(mixed $items = [])

Create a new instance of the collection.

static Enumerable
range(int $from, int $to, int $step = 1, mixed ...$args)

Create a collection with the given range.

array
all()

Get all items in the enumerable.

eager()

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

remember()

Cache values as they're enumerated.

float|int|null
median(string|array|null $key = null)

Get the median of a given key.

array|null
mode(string|array|null $key = null)

Get the mode of a given key.

collapse()

Collapse the collection of items into a single array.

collapseWithKeys()

Collapse the collection of items into a single array while preserving its keys.

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

Determine if an item exists in the enumerable.

bool
containsStrict(mixed $key, mixed $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.

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

Determine if an item is not contained in the enumerable, using strict comparison.

crossJoin(Arrayable|iterable ...$arrays)

Cross join with the given lists, returning all possible permutations.

countBy(callable|string|null $countBy = null)

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

diff(mixed $items)

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

diffUsing(mixed $items, callable $callback)

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

diffAssoc(Arrayable|iterable $items)

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

diffAssocUsing(Arrayable|iterable $items, callable $callback)

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

diffKeys(Arrayable|iterable $items)

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

diffKeysUsing(Arrayable|iterable $items, callable $callback)

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

duplicates(callable|string|null $callback = null, bool $strict = false)

Retrieve duplicate items.

duplicatesStrict(callable|string|null $callback = null)

Retrieve duplicate items using strict comparison.

except(mixed $keys)

Get all items except for those with the specified keys.

filter(callable|null $callback = null)

Run a filter over each of the items.

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

Get the first item from the enumerable passing the given truth test.

flatten(int|float $depth = INF)

Get a flattened list of the items in the collection.

flip()

Flip the items in the collection.

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

Get an item by key.

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

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

keyBy(callable|array|string $keyBy)

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

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

Concatenate values of a given key as a string.

intersect(mixed $items)

Intersect the collection with the given items.

intersectUsing(mixed $items, callable $callback)

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

intersectAssoc(mixed $items)

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

intersectAssocUsing(mixed $items, callable $callback)

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

intersectByKeys(mixed $items)

Intersect the collection with the given items by key.

bool
isEmpty()

Determine if the items are empty or not.

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

Get the keys of the collection items.

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

Get the last item from the collection.

pluck(Closure|string|int|array|null $value, Closure|string|int|array|null $key = null)

Get the values of a given key.

map(callable $callback)

Run a map over each of the items.

mapToDictionary(callable $callback)

Run a dictionary map over the items.

mapWithKeys(callable $callback)

Run an associative map over each of the items.

merge(mixed $items)

Merge the collection with the given items.

mergeRecursive(mixed $items)

Recursively merge the collection with the given items.

multiply(int $multiplier)

Multiply the items in the collection by the multiplier.

combine(Arrayable|iterable $values)

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

union(mixed $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(mixed $keys)

Get the items with the specified keys.

select(mixed $keys)

Select specific values from the items within the collection.

concat(iterable $source)

Push all of the given items onto the collection.

mixed
random(callable|int|string|null $number = null, bool $preserveKeys = false)

Get one or a specified number of items randomly from the collection.

replace(mixed $items)

Replace the collection items with the given items.

replaceRecursive(mixed $items)

Recursively replace the collection items with the given items.

reverse()

Reverse items order.

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

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

mixed
before(mixed $value, bool $strict = false)

Get the item before the given item.

mixed
after(mixed $value, bool $strict = false)

Get the item after the given item.

shuffle()

Shuffle the items in the collection.

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

Create chunks representing a "sliding window" view of the items in the collection.

skip(int $count)

Skip the first {$count} items.

skipUntil(mixed $value)

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

skipWhile(mixed $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(int $numberOfGroups)

Split a collection into a certain number of groups.

mixed
sole(callable|string|null $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.

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

Determine if the collection contains a single item or a single item matching the given criteria.

mixed
firstOrFail(callable|string|null $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(int $size, bool $preserveKeys = true)

Chunk the collection into chunks of the given size.

splitIn(int $numberOfGroups)

Split a collection into a certain number of groups, and fill the first groups completely.

chunkWhile(callable $callback)

Chunk the collection into chunks with a callback.

sort(callable|int|null $callback = null)

Sort through each item with a callback.

sortDesc(int $options = SORT_REGULAR)

Sort items in descending order.

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

Sort the collection using the given callback.

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

Sort the collection in descending order using the given callback.

sortKeys(int $options = SORT_REGULAR, SortDirection|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(mixed $value)

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

takeUntilTimeout(DateTimeInterface $timeout, callable|null $callback = null)

Take items in the collection until a given point in time, with an optional callback on timeout.

takeWhile(mixed $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.

throttle(float $seconds)

Throttle the values, releasing them at most once per the given seconds.

dot(int|float $depth = INF)

Flatten a multi-dimensional associative array with dots.

undot()

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

values()

Reset the keys on the underlying array.

withHeartbeat(DateInterval|int $interval, callable $callback)

Run the given callback every time the interval has passed.

int
intervalSeconds(DateInterval $interval)

Get the total seconds from the given interval.

zip(Arrayable|iterable ...$items)

Zip the collection together with one or more arrays.

pad(int $size, mixed $value)

Pad collection to the specified length with a value.

getIterator()

Get the values iterator.

int
count()

Count the number of items in the collection.

makeIterator(IteratorAggregate|Iterator|array|callable $source)

Make an iterator from the given source.

array
explodePluckParameters(Closure|string|int|array|null $value, Closure|string|int|array|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.

float
preciseNow()

Get the precise current time.

void
usleep(int $microseconds)

Sleep for the given amount of microseconds.

static void
flushState()

Flush all static state.

Details

in Conditionable at line 23
mixed when(mixed $value = null, callable|null $callback = null, callable|null $default = null)

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

Parameters

mixed $value
callable|null $callback
callable|null $default

Return Value

mixed

in Conditionable at line 56
mixed unless(mixed $value = null, callable|null $callback = null, callable|null $default = null)

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

Parameters

mixed $value
callable|null $callback
callable|null $default

Return Value

mixed

at line 98
static Enumerable make(Arrayable|iterable|null $items = [], mixed ...$args)

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

Parameters

Arrayable|iterable|null $items
mixed ...$args

Return Value

Enumerable

in EnumeratesValues at line 142
static EnumeratesValues wrap(mixed $value, mixed ...$args)

Wrap the given value in a collection if applicable.

Parameters

mixed $value
mixed ...$args

Return Value

EnumeratesValues

in EnumeratesValues at line 159
static mixed unwrap(mixed $value)

Get the underlying items from the given collection if applicable.

Parameters

mixed $value

Return Value

mixed

in EnumeratesValues at line 167
static EnumeratesValues empty(mixed ...$args)

Create a new instance with no items.

Parameters

mixed ...$args

Return Value

EnumeratesValues

at line 137
static Collection|Enumerable times(int $number, callable|null $callback = null, mixed ...$args)

Create a new collection by invoking the callback a given amount of times.

Parameters

int $number
callable|null $callback
mixed ...$args

Return Value

Collection|Enumerable

in EnumeratesValues at line 196
static EnumeratesValues fromJson(string $json, int $depth = 513, int $flags = 0, mixed ...$args)

Create a new collection by decoding a JSON string.

Parameters

string $json
int $depth
int $flags
mixed ...$args

Return Value

EnumeratesValues

in EnumeratesValues at line 207
float|int|null avg(callable|int|string|null $callback = null)

Get the average value of a given key.

Parameters

callable|int|string|null $callback

Return Value

float|int|null

in EnumeratesValues at line 228
float|int|null average(callable|string|null $callback = null)

Alias for the "avg" method.

Parameters

callable|string|null $callback

Return Value

float|int|null

in EnumeratesValues at line 238
bool some(mixed $key, mixed $operator = null, mixed $value = null)

Alias for the "contains" method.

Parameters

mixed $key
mixed $operator
mixed $value

Return Value

bool

in EnumeratesValues at line 246
never dd(mixed ...$args)

Dump the given arguments and terminate execution.

Parameters

mixed ...$args

Return Value

never

in EnumeratesValues at line 254
EnumeratesValues dump(mixed ...$args)

Dump the items.

Parameters

mixed ...$args

Return Value

EnumeratesValues

in EnumeratesValues at line 266
EnumeratesValues each(callable $callback)

Execute a callback over each item.

Parameters

callable $callback

Return Value

EnumeratesValues

in EnumeratesValues at line 280
EnumeratesValues eachSpread(callable $callback)

Execute a callback over each nested chunk of items.

Parameters

callable $callback

Return Value

EnumeratesValues

in EnumeratesValues at line 292
bool every(mixed $key, mixed $operator = null, mixed $value = null)

Determine if all items pass the given truth test.

Parameters

mixed $key
mixed $operator
mixed $value

Return Value

bool

in EnumeratesValues at line 314
mixed 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

mixed

in EnumeratesValues at line 324
bool hasMany(callable|string|null $key = null, mixed $operator = null, mixed $value = null)

Determine if the collection contains multiple items, optionally matching the given criteria.

Parameters

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

Return Value

bool

in EnumeratesValues at line 345
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

in EnumeratesValues at line 364
EnumeratesValues ensure(string|array $type)

Ensure that every item in the collection is of the expected type.

Parameters

string|array $type

Return Value

EnumeratesValues

Exceptions

UnexpectedValueException

in EnumeratesValues at line 393
bool isNotEmpty()

Determine if the collection is not empty.

Return Value

bool

at line 785
Collection|Enumerable mapSpread(callable $callback)

Run a map over each nested chunk of items.

Parameters

callable $callback

Return Value

Collection|Enumerable

at line 810
Collection|Enumerable mapToGroups(callable $callback)

Run a grouping map over the items.

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

Parameters

callable $callback

Return Value

Collection|Enumerable

at line 846
Collection|Enumerable flatMap(callable $callback)

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

Parameters

callable $callback

Return Value

Collection|Enumerable

at line 859
Collection|Enumerable mapInto(string $class)

Map the values into a new class.

Parameters

string $class

Return Value

Collection|Enumerable

in EnumeratesValues at line 467
mixed min(callable|int|string|null $callback = null)

Get the min value of a given key.

Parameters

callable|int|string|null $callback

Return Value

mixed

in EnumeratesValues at line 484
mixed max(callable|int|string|null $callback = null)

Get the max value of a given key.

Parameters

callable|int|string|null $callback

Return Value

mixed

in EnumeratesValues at line 498
EnumeratesValues forPage(int $page, int $perPage)

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

Parameters

int $page
int $perPage

Return Value

EnumeratesValues

at line 1038
Collection|Enumerable partition(mixed $key, mixed $operator = null, mixed $value = null)

Partition the collection into two arrays using the given callback or key.

Parameters

mixed $key
mixed $operator
mixed $value

Return Value

Collection|Enumerable

in EnumeratesValues at line 528
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

in EnumeratesValues at line 548
mixed sum(callable|int|string|null $callback = null)

Get the sum of the given values.

Parameters

callable|int|string|null $callback

Return Value

mixed

in EnumeratesValues at line 566
mixed whenEmpty(callable $callback, callable|null $default = null)

Apply the callback if the collection is empty.

Parameters

callable $callback
callable|null $default

Return Value

mixed

in EnumeratesValues at line 580
mixed whenNotEmpty(callable $callback, callable|null $default = null)

Apply the callback if the collection is not empty.

Parameters

callable $callback
callable|null $default

Return Value

mixed

in EnumeratesValues at line 594
mixed unlessEmpty(callable $callback, callable|null $default = null)

Apply the callback unless the collection is empty.

Parameters

callable $callback
callable|null $default

Return Value

mixed

in EnumeratesValues at line 608
mixed unlessNotEmpty(callable $callback, callable|null $default = null)

Apply the callback unless the collection is not empty.

Parameters

callable $callback
callable|null $default

Return Value

mixed

in EnumeratesValues at line 616
EnumeratesValues where(callable|string|null $key, mixed $operator = null, mixed $value = null)

Filter items by the given key value pair.

Parameters

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

Return Value

EnumeratesValues

in EnumeratesValues at line 624
EnumeratesValues whereNull(string|null $key = null)

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

Parameters

string|null $key

Return Value

EnumeratesValues

in EnumeratesValues at line 632
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

in EnumeratesValues at line 640
EnumeratesValues whereStrict(callable|string|null $key, mixed $value)

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

Parameters

callable|string|null $key
mixed $value

Return Value

EnumeratesValues

in EnumeratesValues at line 648
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

in EnumeratesValues at line 658
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

in EnumeratesValues at line 666
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

in EnumeratesValues at line 676
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

in EnumeratesValues at line 692
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

in EnumeratesValues at line 702
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

in EnumeratesValues at line 715
EnumeratesValues whereInstanceOf(string|array $type)

Filter the items, removing any items that don't match the given type(s).

Parameters

string|array $type

Return Value

EnumeratesValues

in EnumeratesValues at line 742
mixed pipe(callable $callback)

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

Parameters

callable $callback

Return Value

mixed

in EnumeratesValues at line 755
mixed pipeInto(string $class)

Pass the collection into a new class.

Parameters

string $class

Return Value

mixed

in EnumeratesValues at line 765
mixed pipeThrough(array $callbacks)

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

Parameters

array $callbacks

Return Value

mixed

in EnumeratesValues at line 783
mixed reduce(callable $callback, mixed $initial = null)

Reduce the collection to a single value.

Parameters

callable $callback
mixed $initial

Return Value

mixed

in EnumeratesValues at line 803
mixed reduceInto(mixed $initial, callable $callback)

Reduce the collection to a single value by mutating an initial value.

Parameters

mixed $initial
callable $callback

Return Value

mixed

in EnumeratesValues at line 817
array reduceSpread(callable $callback, mixed ...$initial)

Reduce the collection to multiple aggregate values.

Parameters

callable $callback
mixed ...$initial

Return Value

array

Exceptions

UnexpectedValueException

in EnumeratesValues at line 846
mixed reduceWithKeys(callable $callback, mixed $initial = null)

Reduce an associative collection to a single value.

Parameters

callable $callback
mixed $initial

Return Value

mixed

in EnumeratesValues at line 856
EnumeratesValues reject(mixed $callback = true)

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

Parameters

mixed $callback

Return Value

EnumeratesValues

in EnumeratesValues at line 873
EnumeratesValues chunkBy(callable|string $key)

Chunk the collection into chunks by comparing adjacent values using the given key or callback.

Parameters

callable|string $key

Return Value

EnumeratesValues

in EnumeratesValues at line 888
EnumeratesValues tap(callable $callback)

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

Parameters

callable $callback

Return Value

EnumeratesValues

at line 1714
Enumerable unique(callable|int|string|null $key = null, bool $strict = false)

Return only unique items from the collection array.

Parameters

callable|int|string|null $key
bool $strict

Return Value

Enumerable

in EnumeratesValues at line 920
EnumeratesValues uniqueStrict(callable|string|null $key = null)

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

Parameters

callable|string|null $key

Return Value

EnumeratesValues

in EnumeratesValues at line 930
Collection collect()

Collect the values into a collection.

Return Value

Collection

in EnumeratesValues at line 940
array toArray()

Get the collection of items as a plain array.

Return Value

array

in EnumeratesValues at line 950
array jsonSerialize()

Convert the object into something JSON serializable.

Return Value

array

in EnumeratesValues at line 968
string toJson(int $options = 0)

Get the collection of items as JSON.

Parameters

int $options

Return Value

string

Exceptions

JsonException

in EnumeratesValues at line 978
string toPrettyJson(int $options = 0)

Get the collection of items as pretty print formatted JSON.

Parameters

int $options

Return Value

string

Exceptions

JsonException

in EnumeratesValues at line 986
CachingIterator getCachingIterator(int $flags = CachingIterator::CALL_TOSTRING)

Get a CachingIterator instance.

Parameters

int $flags

Return Value

CachingIterator

in EnumeratesValues at line 995
string __toString()

Convert the collection to its string representation.

Return Value

string

in EnumeratesValues at line 1005
EnumeratesValues escapeWhenCastingToString(bool $escape = true)

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

Parameters

bool $escape

Return Value

EnumeratesValues

in EnumeratesValues at line 1019
static void proxy(string $method)

Add a method to the list of proxied methods.

Boot or tests only. The method is registered on a worker-wide static and applies to every subsequent collection access; per-request use races across coroutines.

Parameters

string $method

Return Value

void

in EnumeratesValues at line 1030
static void flushProxies()

Flush the registered proxies, restoring the default list.

Boot or tests only. Resets the worker-wide proxy registry; concurrent coroutines may resolve different proxies depending on timing.

Return Value

void

in EnumeratesValues at line 1040
mixed __get(string $key)

Dynamically access collection proxies.

Parameters

string $key

Return Value

mixed

Exceptions

Exception

in EnumeratesValues at line 1054
protected array getArrayableItems(mixed $items)

Results array of items from Collection or Arrayable.

Parameters

mixed $items

Return Value

array

in EnumeratesValues at line 1064
protected callable operatorForWhere(callable|string|null $key, mixed $operator = null, mixed $value = null)

Get an operator checker callback.

Parameters

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

Return Value

callable

in EnumeratesValues at line 1118
protected bool useAsCallable(mixed $value)

Determine if the given value is callable, but not a string.

Parameters

mixed $value

Return Value

bool

in EnumeratesValues at line 1126
protected callable valueRetriever(callable|int|string|null $value)

Get a value retrieving callback.

Parameters

callable|int|string|null $value

Return Value

callable

in EnumeratesValues at line 1140
protected Closure equality(mixed $value)

Make a function to check an item's equality.

Parameters

mixed $value

Return Value

Closure

in EnumeratesValues at line 1148
protected Closure negate(Closure $callback)

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

Parameters

Closure $callback

Return Value

Closure

in EnumeratesValues at line 1158
protected Closure identity()

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

Return Value

Closure

in Macroable at line 28
static void macro(string $name, callable|object $macro)

Register a custom macro.

Boot-only. Macros persist in a static property for the worker lifetime and apply to every subsequent call on the macroable class.

Parameters

string $name
callable|object $macro

Return Value

void

in Macroable at line 41
static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Boot-only. Delegates to macro() for each method; registered macros persist in a static property for the worker lifetime.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

in Macroable at line 57
static bool hasMacro(string $name)

Check if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 68
static void flushMacros()

Flush the existing macros.

Boot or tests only. Clears worker-wide macros; concurrent coroutines may resolve different methods depending on timing.

Return Value

void

in Macroable at line 78
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Macroable at line 103
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line 60
__construct(mixed $source = null)

Create a new lazy collection instance.

Parameters

mixed $source

Exceptions

InvalidArgumentException

at line 84
protected LazyCollection newInstance(mixed $items = [])

Create a new instance of the collection.

Parameters

mixed $items

Return Value

LazyCollection

at line 110
static Enumerable range(int $from, int $to, int $step = 1, mixed ...$args)

Create a collection with the given range.

Parameters

int $from
int $to
int $step
mixed ...$args

Return Value

Enumerable

Exceptions

InvalidArgumentException

at line 165
array all()

Get all items in the enumerable.

Return Value

array

at line 179
LazyCollection eager()

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

Return Value

LazyCollection

at line 189
LazyCollection remember()

Cache values as they're enumerated.

Return Value

LazyCollection

at line 227
float|int|null median(string|array|null $key = null)

Get the median of a given key.

Parameters

string|array|null $key

Return Value

float|int|null

at line 238
array|null mode(string|array|null $key = null)

Get the mode of a given key.

Parameters

string|array|null $key

Return Value

array|null

at line 248
Collection|Enumerable collapse()

Collapse the collection of items into a single array.

Return Value

Collection|Enumerable

at line 266
LazyCollection collapseWithKeys()

Collapse the collection of items into a single array while preserving its keys.

Return Value

LazyCollection

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

Determine if an item exists in the enumerable.

Parameters

mixed $key
mixed $operator
mixed $value

Return Value

bool

at line 314
bool containsStrict(mixed $key, mixed $value = null)

Determine if an item exists, using strict comparison.

Parameters

mixed $key
mixed $value

Return Value

bool

at line 338
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

at line 346
bool doesntContainStrict(mixed $key, mixed $operator = null, mixed $value = null)

Determine if an item is not contained in the enumerable, using strict comparison.

Parameters

mixed $key
mixed $operator
mixed $value

Return Value

bool

at line 351
Enumerable crossJoin(Arrayable|iterable ...$arrays)

Cross join with the given lists, returning all possible permutations.

Parameters

Arrayable|iterable ...$arrays

Return Value

Enumerable

at line 363
Collection|Enumerable countBy(callable|string|null $countBy = null)

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

Parameters

callable|string|null $countBy

Return Value

Collection|Enumerable

at line 387
Enumerable diff(mixed $items)

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

Parameters

mixed $items

Return Value

Enumerable

at line 393
Enumerable diffUsing(mixed $items, callable $callback)

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

Parameters

mixed $items
callable $callback

Return Value

Enumerable

at line 399
Enumerable diffAssoc(Arrayable|iterable $items)

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

Parameters

Arrayable|iterable $items

Return Value

Enumerable

at line 405
Enumerable diffAssocUsing(Arrayable|iterable $items, callable $callback)

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

Parameters

Arrayable|iterable $items
callable $callback

Return Value

Enumerable

at line 411
Enumerable diffKeys(Arrayable|iterable $items)

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

Parameters

Arrayable|iterable $items

Return Value

Enumerable

at line 417
Enumerable diffKeysUsing(Arrayable|iterable $items, callable $callback)

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

Parameters

Arrayable|iterable $items
callable $callback

Return Value

Enumerable

at line 423
Enumerable duplicates(callable|string|null $callback = null, bool $strict = false)

Retrieve duplicate items.

Parameters

callable|string|null $callback
bool $strict

Return Value

Enumerable

at line 429
Enumerable duplicatesStrict(callable|string|null $callback = null)

Retrieve duplicate items using strict comparison.

Parameters

callable|string|null $callback

Return Value

Enumerable

at line 435
Enumerable except(mixed $keys)

Get all items except for those with the specified keys.

Parameters

mixed $keys

Return Value

Enumerable

at line 446
Enumerable filter(callable|null $callback = null)

Run a filter over each of the items.

Parameters

callable|null $callback

Return Value

Enumerable

at line 470
mixed first(callable|null $callback = null, mixed $default = null)

Get the first item from the enumerable passing the given truth test.

Parameters

callable|null $callback
mixed $default

Return Value

mixed

at line 496
Collection|Enumerable flatten(int|float $depth = INF)

Get a flattened list of the items in the collection.

Parameters

int|float $depth

Return Value

Collection|Enumerable

at line 518
Collection|Enumerable flip()

Flip the items in the collection.

Return Value

Collection|Enumerable

at line 538
mixed get(mixed $key, mixed $default = null)

Get an item by key.

Parameters

mixed $key
mixed $default

Return Value

mixed

at line 568
Collection|Enumerable groupBy(callable|array|string $groupBy, bool $preserveKeys = false)

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

Parameters

callable|array|string $groupBy
bool $preserveKeys

Return Value

Collection|Enumerable

at line 578
Enumerable keyBy(callable|array|string $keyBy)

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

Parameters

callable|array|string $keyBy

Return Value

Enumerable

at line 601
bool has(mixed $key)

Determine if an item exists in the collection by key.

Parameters

mixed $key

Return Value

bool

at line 623
bool hasAny(mixed $key)

Determine if any of the keys exist in the collection.

Parameters

mixed $key

Return Value

bool

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

Concatenate values of a given key as a string.

Parameters

callable|string|null $value
string|null $glue

Return Value

string

at line 646
Enumerable intersect(mixed $items)

Intersect the collection with the given items.

Parameters

mixed $items

Return Value

Enumerable

at line 652
Enumerable intersectUsing(mixed $items, callable $callback)

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

Parameters

mixed $items
callable $callback

Return Value

Enumerable

at line 658
Enumerable intersectAssoc(mixed $items)

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

Parameters

mixed $items

Return Value

Enumerable

at line 664
Enumerable intersectAssocUsing(mixed $items, callable $callback)

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

Parameters

mixed $items
callable $callback

Return Value

Enumerable

at line 670
Enumerable intersectByKeys(mixed $items)

Intersect the collection with the given items by key.

Parameters

mixed $items

Return Value

Enumerable

at line 679
bool isEmpty()

Determine if the items are empty or not.

Return Value

bool

at line 689
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

at line 699
Collection|Enumerable keys()

Get the keys of the collection items.

Return Value

Collection|Enumerable

at line 717
mixed last(callable|null $callback = null, mixed $default = null)

Get the last item from the collection.

Parameters

callable|null $callback
mixed $default

Return Value

mixed

at line 736
Collection|Enumerable pluck(Closure|string|int|array|null $value, Closure|string|int|array|null $key = null)

Get the values of a given key.

Parameters

Closure|string|int|array|null $value
Closure|string|int|array|null $key

Return Value

Collection|Enumerable

at line 771
Collection|Enumerable map(callable $callback)

Run a map over each of the items.

Parameters

callable $callback

Return Value

Collection|Enumerable

at line 792
Enumerable mapToDictionary(callable $callback)

Run a dictionary map over the items.

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

Parameters

callable $callback

Return Value

Enumerable

at line 828
Collection|Enumerable mapWithKeys(callable $callback)

Run an associative map over each of the items.

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

Parameters

callable $callback

Return Value

Collection|Enumerable

at line 868
Enumerable merge(mixed $items)

Merge the collection with the given items.

Parameters

mixed $items

Return Value

Enumerable

at line 875
Enumerable mergeRecursive(mixed $items)

Recursively merge the collection with the given items.

Parameters

mixed $items

Return Value

Enumerable

at line 885
LazyCollection multiply(int $multiplier)

Multiply the items in the collection by the multiplier.

Parameters

int $multiplier

Return Value

LazyCollection

at line 899
Enumerable combine(Arrayable|iterable $values)

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

Parameters

Arrayable|iterable $values

Return Value

Enumerable

at line 928
Enumerable union(mixed $items)

Union the collection with the given items.

Parameters

mixed $items

Return Value

Enumerable

at line 941
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

Exceptions

InvalidArgumentException

at line 965
Enumerable only(mixed $keys)

Get the items with the specified keys.

Parameters

mixed $keys

Return Value

Enumerable

at line 1001
LazyCollection select(mixed $keys)

Select specific values from the items within the collection.

Parameters

mixed $keys

Return Value

LazyCollection

at line 1059
Enumerable concat(iterable $source)

Push all of the given items onto the collection.

Parameters

iterable $source

Return Value

Enumerable

at line 1074
mixed random(callable|int|string|null $number = null, bool $preserveKeys = false)

Get one or a specified number of items randomly from the collection.

Parameters

callable|int|string|null $number
bool $preserveKeys

Return Value

mixed

Exceptions

InvalidArgumentException

at line 1086
Enumerable replace(mixed $items)

Replace the collection items with the given items.

Parameters

mixed $items

Return Value

Enumerable

at line 1107
Enumerable replaceRecursive(mixed $items)

Recursively replace the collection items with the given items.

Parameters

mixed $items

Return Value

Enumerable

at line 1113
Enumerable reverse()

Reverse items order.

Return Value

Enumerable

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

Parameters

mixed $value
bool $strict

Return Value

mixed

at line 1149
mixed before(mixed $value, bool $strict = false)

Get the item before the given item.

Parameters

mixed $value
bool $strict

Return Value

mixed

at line 1177
mixed after(mixed $value, bool $strict = false)

Get the item after the given item.

Parameters

mixed $value
bool $strict

Return Value

mixed

at line 1201
Enumerable shuffle()

Shuffle the items in the collection.

Return Value

Enumerable

at line 1216
Collection|Enumerable sliding(int $size = 2, int $step = 1)

Create chunks representing a "sliding window" view of the items in the collection.

Parameters

int $size
int $step

Return Value

Collection|Enumerable

Exceptions

InvalidArgumentException

at line 1258
Enumerable skip(int $count)

Skip the first {$count} items.

Parameters

int $count

Return Value

Enumerable

at line 1280
Enumerable skipUntil(mixed $value)

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

Parameters

mixed $value

Return Value

Enumerable

at line 1292
Enumerable skipWhile(mixed $value)

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

Parameters

mixed $value

Return Value

Enumerable

at line 1311
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

at line 1328
Enumerable split(int $numberOfGroups)

Split a collection into a certain number of groups.

Parameters

int $numberOfGroups

Return Value

Enumerable

Exceptions

InvalidArgumentException

at line 1348
mixed sole(callable|string|null $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

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

Return Value

mixed

Exceptions

ItemNotFoundException
MultipleItemsFoundException

at line 1367
bool hasSole(callable|string|null $key = null, mixed $operator = null, mixed $value = null)

Determine if the collection contains a single item or a single item matching the given criteria.

Parameters

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

Return Value

bool

at line 1388
mixed firstOrFail(callable|string|null $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

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

Return Value

mixed

Exceptions

ItemNotFoundException

at line 1407
Enumerable chunk(int $size, bool $preserveKeys = true)

Chunk the collection into chunks of the given size.

Parameters

int $size
bool $preserveKeys

Return Value

Enumerable

at line 1452
Enumerable splitIn(int $numberOfGroups)

Split a collection into a certain number of groups, and fill the first groups completely.

Parameters

int $numberOfGroups

Return Value

Enumerable

Exceptions

InvalidArgumentException

at line 1467
Enumerable chunkWhile(callable $callback)

Chunk the collection into chunks with a callback.

Parameters

callable $callback

Return Value

Enumerable

at line 1501
Enumerable sort(callable|int|null $callback = null)

Sort through each item with a callback.

Parameters

callable|int|null $callback

Return Value

Enumerable

at line 1507
Enumerable sortDesc(int $options = SORT_REGULAR)

Sort items in descending order.

Parameters

int $options

Return Value

Enumerable

at line 1513
Enumerable sortBy(array|callable|int|string $callback, int $options = SORT_REGULAR, SortDirection|bool $descending = false)

Sort the collection using the given callback.

Parameters

array|callable|int|string $callback
int $options
SortDirection|bool $descending

Return Value

Enumerable

at line 1519
Enumerable sortByDesc(array|callable|int|string $callback, int $options = SORT_REGULAR)

Sort the collection in descending order using the given callback.

Parameters

array|callable|int|string $callback
int $options

Return Value

Enumerable

at line 1525
Enumerable sortKeys(int $options = SORT_REGULAR, SortDirection|bool $descending = false)

Sort the collection keys.

Parameters

int $options
SortDirection|bool $descending

Return Value

Enumerable

at line 1531
Enumerable sortKeysDesc(int $options = SORT_REGULAR)

Sort the collection keys in descending order.

Parameters

int $options

Return Value

Enumerable

at line 1537
Enumerable sortKeysUsing(callable $callback)

Sort the collection keys using a callback.

Parameters

callable $callback

Return Value

Enumerable

at line 1548
Enumerable take(int $limit)

Take the first or last {$limit} items.

Parameters

int $limit

Return Value

Enumerable

at line 1591
Enumerable takeUntil(mixed $value)

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

Parameters

mixed $value

Return Value

Enumerable

at line 1613
LazyCollection takeUntilTimeout(DateTimeInterface $timeout, callable|null $callback = null)

Take items in the collection until a given point in time, with an optional callback on timeout.

Parameters

DateTimeInterface $timeout
callable|null $callback

Return Value

LazyCollection

at line 1646
Enumerable takeWhile(mixed $value)

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

Parameters

mixed $value

Return Value

Enumerable

at line 1660
LazyCollection tapEach(callable $callback)

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

Parameters

callable $callback

Return Value

LazyCollection

at line 1676
LazyCollection throttle(float $seconds)

Throttle the values, releasing them at most once per the given seconds.

Parameters

float $seconds

Return Value

LazyCollection

at line 1696
Enumerable dot(int|float $depth = INF)

Flatten a multi-dimensional associative array with dots.

Parameters

int|float $depth

Return Value

Enumerable

at line 1702
Enumerable undot()

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

Return Value

Enumerable

at line 1736
Enumerable values()

Reset the keys on the underlying array.

Return Value

Enumerable

at line 1750
LazyCollection withHeartbeat(DateInterval|int $interval, callable $callback)

Run the given callback every time the interval has passed.

Parameters

DateInterval|int $interval
callable $callback

Return Value

LazyCollection

at line 1774
protected int intervalSeconds(DateInterval $interval)

Get the total seconds from the given interval.

Parameters

DateInterval $interval

Return Value

int

at line 1792
Collection|Enumerable zip(Arrayable|iterable ...$items)

Zip the collection together with one or more arrays.

e.g. new LazyCollection([1, 2, 3])->zip([4, 5, 6]); => [[1, 4], [2, 5], [3, 6]]

Parameters

Arrayable|iterable ...$items

Return Value

Collection|Enumerable

at line 1817
Collection|Enumerable pad(int $size, mixed $value)

Pad collection to the specified length with a value.

Parameters

int $size
mixed $value

Return Value

Collection|Enumerable

at line 1844
Traversable getIterator()

Get the values iterator.

Return Value

Traversable

at line 1852
int count()

Count the number of items in the collection.

Return Value

int

at line 1870
protected Iterator makeIterator(IteratorAggregate|Iterator|array|callable $source)

Make an iterator from the given source.

Parameters

IteratorAggregate|Iterator|array|callable $source

Return Value

Iterator

at line 1904
protected array explodePluckParameters(Closure|string|int|array|null $value, Closure|string|int|array|null $key)

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

Parameters

Closure|string|int|array|null $value
Closure|string|int|array|null $key

Return Value

array

at line 1918
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

at line 1928
protected int now()

Get the current time.

Return Value

int

at line 1938
protected float preciseNow()

Get the precise current time.

Return Value

float

at line 1948
protected void usleep(int $microseconds)

Sleep for the given amount of microseconds.

Parameters

int $microseconds

Return Value

void

at line 1962
static void flushState()

Flush all static state.

Return Value

void