LazyCollection
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 |
| TValue> read-only | $average | from EnumeratesValues | |
| TValue> read-only | $avg | from EnumeratesValues | |
| TValue> read-only | $contains | from EnumeratesValues | |
| TValue> read-only | $doesntContain | from EnumeratesValues | |
| TValue> read-only | $each | from EnumeratesValues | |
| TValue> read-only | $every | from EnumeratesValues | |
| TValue> read-only | $filter | from EnumeratesValues | |
| TValue> read-only | $first | from EnumeratesValues | |
| TValue> read-only | $flatMap | from EnumeratesValues | |
| TValue> read-only | $groupBy | from EnumeratesValues | |
| TValue> read-only | $keyBy | from EnumeratesValues | |
| TValue> read-only | $last | from EnumeratesValues | |
| TValue> read-only | $map | from EnumeratesValues | |
| TValue> read-only | $max | from EnumeratesValues | |
| TValue> read-only | $min | from EnumeratesValues | |
| TValue> read-only | $partition | from EnumeratesValues | |
| TValue> read-only | $percentage | from EnumeratesValues | |
| TValue> read-only | $reject | from EnumeratesValues | |
| TValue> read-only | $skipUntil | from EnumeratesValues | |
| TValue> read-only | $skipWhile | from EnumeratesValues | |
| TValue> read-only | $some | from EnumeratesValues | |
| TValue> read-only | $sortBy | from EnumeratesValues | |
| TValue> read-only | $sortByDesc | from EnumeratesValues | |
| TValue> read-only | $sum | from EnumeratesValues | |
| TValue> read-only | $takeUntil | from EnumeratesValues | |
| TValue> read-only | $takeWhile | from EnumeratesValues | |
| TValue> read-only | $unique | from EnumeratesValues | |
| TValue> read-only | $unless | from EnumeratesValues | |
| TValue> read-only | $until | from EnumeratesValues | |
| TValue> read-only | $when | from EnumeratesValues | |
| static protected array | $macros | The registered string macros. |
from Macroable |
| $source |
Methods
Apply the callback if the given "value" is (or resolves to) truthy.
Apply the callback if the given "value" is (or resolves to) falsy.
No description
Alias for the "contains" method.
Execute a callback over each nested chunk of items.
Determine if all items pass the given truth test.
Get the first item by the given key value pair.
"Paginate" the collection by slicing it into a smaller collection.
Calculate the percentage of items that pass a given truth test.
Apply the callback if the collection is empty.
Apply the callback if the collection is not empty.
Apply the callback unless the collection is empty.
Apply the callback unless the collection is not empty.
Filter items by the given key value pair.
Filter items where the value for the given key is null.
Filter items where the value for the given key is not null.
Filter items by the given key value pair using strict comparison.
Filter items by the given key value pair.
Filter items by the given key value pair using strict comparison.
Filter items such that the value of the given key is between the given values.
Filter items such that the value of the given key is not between the given values.
Filter items by the given key value pair.
Filter items by the given key value pair using strict comparison.
Pass the collection to the given callback and return the result.
Pass the collection into a new class.
Pass the collection through a series of callable pipes and return the result.
Reduce the collection to a single value.
Reduce the collection to multiple aggregate values.
Reduce an associative collection to a single value.
Create a collection of all elements that do not pass a given truth test.
Pass the collection to the given callback and then return it.
Return only unique items from the collection array.
Return only unique items from the collection array using strict comparison.
Get a CachingIterator instance.
Indicate that the model's string representation should be escaped when __toString is invoked.
Add a method to the list of proxied methods.
Get an operator checker callback.
Determine if the given value is callable, but not a string.
Get a value retrieving callback.
Mix another object into the class.
Dynamically handle calls to the class.
Dynamically handle calls to the class.
No description
No description
No description
Eager load all items into a new lazy collection backed by an array.
Cache values as they're enumerated.
Get the median of a given key.
Get the mode of a given key.
No description
No description
Determine if an item exists in the enumerable.
Determine if an item exists, using strict comparison.
Determine if an item is not contained in the enumerable.
No description
No description
Get the items that are not present in the given items.
Get the items that are not present in the given items, using the callback.
Get the items whose keys and values are not present in the given items.
Get the items whose keys and values are not present in the given items, using the callback.
Get the items whose keys are not present in the given items.
Get the items whose keys are not present in the given items, using the callback.
Retrieve duplicate items.
Retrieve duplicate items using strict comparison.
Get all items except for those with the specified keys.
Run a filter over each of the items.
No description
No description
No description
No description
No description
No description
Determine if an item exists in the collection by key.
Determine if any of the keys exist in the collection.
Concatenate values of a given key as a string.
Intersect the collection with the given items.
Intersect the collection with the given items, using the callback.
Intersect the collection with the given items with additional index check.
Intersect the collection with the given items with additional index check, using the callback.
Intersect the collection with the given items by key.
Determine if the items are empty or not.
Determine if the collection contains a single item.
Join all items from the collection using a string. The final items can use a separate glue string.
No description
No description
No description
No description
No description
No description
Merge the collection with the given items.
No description
Multiply the items in the collection by the multiplier.
No description
Union the collection with the given items.
Create a new collection consisting of every n-th element.
Get the items with the specified keys.
Select specific values from the items within the collection.
No description
No description
Replace the collection items with the given items.
Recursively replace the collection items with the given items.
Reverse items order.
Search the collection for a given value and return the corresponding key if successful.
Get the item before the given item.
Get the item after the given item.
Shuffle the items in the collection.
No description
Skip the first {$count} items.
Skip items in the collection until the given condition is met.
Skip items in the collection while the given condition is met.
Get a slice of items from the enumerable.
No description
Get the first item in the collection, but only if exactly one item exists. Otherwise, throw an exception.
Get the first item in the collection but throw an exception if no matching items exist.
Chunk the collection into chunks of the given size.
No description
No description
Sort through each item with a callback.
Sort items in descending order.
Sort the collection using the given callback.
Sort the collection in descending order using the given callback.
Sort the collection keys.
Sort the collection keys in descending order.
Sort the collection keys using a callback.
Take the first or last {$limit} items.
Take items in the collection until the given condition is met.
Take items in the collection until a given point in time.
Take items in the collection while the given condition is met.
Pass each item in the collection to the given callback, lazily.
No description
Flatten a multi-dimensional associative array with dots.
Convert a flatten "dot" notation array into an expanded array.
No description
No description
No description
Get the values iterator.
Count the number of items in the collection.
No description
Explode the "value" and "key" arguments passed to "pluck".
Pass this lazy collection through a method on the collection class.
Get the current time.
Get the precise current time.
Sleep for the given amount of microseconds.
Details
$this|TWhenReturnType
when($value = null, callable|null $callback = null, callable|null $default = null)
Apply the callback if the given "value" is (or resolves to) truthy.
$this|TUnlessReturnType
unless($value = null, callable|null $callback = null, callable|null $default = null)
Apply the callback if the given "value" is (or resolves to) falsy.
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.
EnumeratesValues
forPage(int $page, int $perPage)
"Paginate" the collection by slicing it into a smaller collection.
float|null
percentage(callable $callback, int $precision = 2)
Calculate the percentage of items that pass a given truth test.
$this|TWhenEmptyReturnType
whenEmpty(callable $callback, callable|null $default = null)
Apply the callback if the collection is empty.
$this|TWhenNotEmptyReturnType
whenNotEmpty(callable $callback, callable|null $default = null)
Apply the callback if the collection is not empty.
$this|TUnlessEmptyReturnType
unlessEmpty(callable $callback, callable|null $default = null)
Apply the callback unless the collection is empty.
$this|TUnlessNotEmptyReturnType
unlessNotEmpty(callable $callback, callable|null $default = null)
Apply the callback unless the collection is not empty.
EnumeratesValues
where(callable|string $key, mixed $operator = null, mixed $value = null)
Filter items by the given key value pair.
EnumeratesValues
whereNull(string|null $key = null)
Filter items where the value for the given key is null.
EnumeratesValues
whereNotNull(string|null $key = null)
Filter items where the value for the given key is not null.
EnumeratesValues
whereStrict(string $key, mixed $value)
Filter items by the given key value pair using strict comparison.
EnumeratesValues
whereIn(string $key, Arrayable|iterable $values, bool $strict = false)
Filter items by the given key value pair.
EnumeratesValues
whereInStrict(string $key, Arrayable|iterable $values)
Filter items by the given key value pair using strict comparison.
EnumeratesValues
whereBetween(string $key, Arrayable|iterable $values)
Filter items such that the value of the given key is between the given values.
EnumeratesValues
whereNotBetween(string $key, Arrayable|iterable $values)
Filter items such that the value of the given key is not between the given values.
EnumeratesValues
whereNotIn(string $key, Arrayable|iterable $values, bool $strict = false)
Filter items by the given key value pair.
EnumeratesValues
whereNotInStrict(string $key, Arrayable|iterable $values)
Filter items by the given key value pair using strict comparison.
TPipeReturnType
pipe(callable $callback)
Pass the collection to the given callback and return the result.
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.
EnumeratesValues
reject($callback = true)
Create a collection of all elements that do not pass a given truth test.
Enumerable
unique($key = null, bool $strict = false)
Return only unique items from the collection array.
EnumeratesValues
uniqueStrict($key = null)
Return only unique items from the collection array using strict comparison.
CachingIterator
getCachingIterator(int $flags = CachingIterator::CALL_TOSTRING)
Get a CachingIterator instance.
$this
escapeWhenCastingToString(bool $escape = true)
Indicate that the model's string representation should be escaped when __toString is invoked.
protected Closure
operatorForWhere(callable|string $key, string|null $operator = null, mixed $value = null)
Get an operator checker callback.
protected bool
useAsCallable(mixed $value)
Determine if the given value is callable, but not a string.
protected Closure
negate(Closure $callback)
Make a function using another function, by negating its result.
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.
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.
Enumerable
diffUsing(TValue>|TValue> $items, callable $callback)
Get the items that are not present in the given items, using the callback.
Enumerable
diffAssoc(TValue>|TValue> $items)
Get the items whose keys and values are not present in the given items.
Enumerable
diffAssocUsing(TValue>|TValue> $items, callable $callback)
Get the items whose keys and values are not present in the given items, using the callback.
Enumerable
diffKeys(TKey,mixed>|TKey,mixed> $items)
Get the items whose keys are not present in the given items.
Enumerable
diffKeysUsing(TKey,mixed>|TKey,mixed> $items, callable $callback)
Get the items whose keys are not present in the given items, using the callback.
Enumerable
intersectUsing(TValue>|TValue> $items, callable $callback)
Intersect the collection with the given items, using the callback.
Enumerable
intersectAssoc(TValue>|TValue> $items)
Intersect the collection with the given items with additional index check.
Enumerable
intersectAssocUsing(TValue>|TValue> $items, callable $callback)
Intersect the collection with the given items with additional index check, using the callback.
Enumerable
intersectByKeys(TKey,mixed>|TKey,mixed> $items)
Intersect the collection with the given items by key.
string
join(string $glue, string $finalGlue = '')
Join all items from the collection using a string. The final items can use a separate glue string.
Enumerable
nth(int $step, int $offset = 0)
Create a new collection consisting of every n-th element.
LazyCollection
select(TKey>|TKey>|string $keys)
Select specific values from the items within the collection.
Enumerable
replaceRecursive(TValue>|TValue> $items)
Recursively replace the collection items with the given items.
TKey|bool
search($value, bool $strict = false)
Search the collection for a given value and return the corresponding key if successful.
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.
Enumerable
sortBy($callback, int $options = SORT_REGULAR, bool $descending = false)
Sort the collection using the given callback.
Enumerable
sortByDesc($callback, int $options = SORT_REGULAR)
Sort the collection in descending order using the given callback.
Enumerable
sortKeys(int $options = SORT_REGULAR, bool $descending = false)
Sort the collection keys.
LazyCollection
takeUntilTimeout(DateTimeInterface $timeout)
Take items in the collection until a given point in time.
LazyCollection
tapEach(callable $callback)
Pass each item in the collection to the given callback, lazily.
protected
explodePluckParameters(string|string[] $value, string|string[]|null $key)
Explode the "value" and "key" arguments passed to "pluck".
protected LazyCollection
passthru(string $method, array $params)
Pass this lazy collection through a method on the collection class.