interface Enumerable implements Arrayable, Countable, IteratorAggregate, Jsonable, JsonSerializable (View source)

Methods

toArray()

No description

string
toJson(int $options = 0)

Get the collection of items as JSON.

static 
make($items = [])

No description

static Enumerable
times(int $number, callable $callback = null)

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

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

Create a collection with the given range.

static 
wrap($value)

No description

static 
unwrap($value)

No description

static Enumerable
empty()

Create a new instance with no items.

array
all()

Get all items in the enumerable.

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

Alias for the "avg" method.

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

Alias for the "contains" method.

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

Determine if an item exists, using strict comparison.

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

Get the average value of a given key.

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

Determine if an item exists in the enumerable.

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

Determine if an item is not contained in the collection.

crossJoin(...$lists)

No description

never
dd(mixed ...$args)

Dump the collection and end the script.

$this
dump()

Dump the collection.

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.

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

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.

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

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

$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|TUnlessReturnType
unless(bool $value, callable $callback, callable $default = null)

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

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

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

No description

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

Get the first item by the given key value pair.

flatten(int $depth = INF)

Get a flattened array of the items in the collection.

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

intersectByKeys(TValue>|TValue> $items)

Intersect the collection with the given items by key.

bool
isEmpty()

Determine if the collection is empty or not.

bool
isNotEmpty()

Determine if the collection is not empty.

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

map(callable $callback)

No description

mapSpread(callable $callback)

Run a map over each nested chunk of items.

mapToDictionary(callable $callback)

No description

mapToGroups(callable $callback)

No description

mapWithKeys(callable $callback)

No description

flatMap(callable $callback)

No description

mapInto($class)

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.

TValue
min($callback = null)

Get the min value of a given key.

TValue
max($callback = null)

Get the max value of a given key.

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.

forPage(int $page, int $perPage)

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

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

No description

concat(TValue> $source)

Push all of the given items onto the collection.

random($number = null)

No description

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.

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

chunkWhile(callable $callback)

No description

splitIn($numberOfGroups)

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.

mixed
sum($callback = null)

Get the sum of the given values.

take(int $limit)

Take the first or last {$limit} items.

takeUntil($value)

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

takeWhile($value)

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

$this
tap(callable $callback)

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

TPipeReturnType
pipe(callable $callback)

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

mixed
pipeInto(class-string $class)

Pass the collection into a new class.

mixed
pipeThrough(callable[] $pipes)

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

pluck($value, $key = null)

No description

reject($callback = true)

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

undot()

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

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.

values()

No description

pad($size, $value)

No description

getIterator()

Get the values iterator.

int
count()

Count the number of items in the collection.

countBy($callback = null)

No description

zip($items)

No description

TValue>
collect()

Collect the values into a collection.

array
jsonSerialize()

No description

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.

Details

toArray()

No description

string toJson(int $options = 0)

Get the collection of items as JSON.

Parameters

int $options

Return Value

string

static make($items = [])

No description

Parameters

$items

static Enumerable times(int $number, callable $callback = null)

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

Parameters

int $number
callable $callback

Return Value

Enumerable

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

Create a collection with the given range.

Parameters

int $from
int $to

Return Value

Enumerable

static wrap($value)

No description

Parameters

$value

static unwrap($value)

No description

Parameters

$value

static Enumerable empty()

Create a new instance with no items.

Return Value

Enumerable

array all()

Get all items in the enumerable.

Return Value

array

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

Alias for the "avg" method.

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

Alias for the "contains" method.

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

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

Get the average value of a given key.

Parameters

$callback

Return Value

float|int|null

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

Determine if an item is not contained in the collection.

Parameters

mixed $key
mixed $operator
mixed $value

Return Value

bool

crossJoin(...$lists)

No description

Parameters

...$lists

never dd(mixed ...$args)

Dump the collection and end the script.

Parameters

mixed ...$args

Return Value

never

$this dump()

Dump the collection.

Return Value

$this

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

$this each(callable $callback)

Execute a callback over each item.

Parameters

callable $callback

Return Value

$this

Enumerable eachSpread(callable $callback)

Execute a callback over each nested chunk of items.

Parameters

callable $callback

Return Value

Enumerable

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

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

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

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

Parameters

bool $value
callable $callback
callable $default

Return Value

$this|TWhenReturnType

$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|TUnlessReturnType unless(bool $value, callable $callback, callable $default = null)

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

Parameters

bool $value
callable $callback
callable $default

Return Value

$this|TUnlessReturnType

$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

Enumerable where(string $key, mixed $operator = null, mixed $value = null)

Filter items by the given key value pair.

Parameters

string $key
mixed $operator
mixed $value

Return Value

Enumerable

Enumerable whereNull(string|null $key = null)

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

Parameters

string|null $key

Return Value

Enumerable

Enumerable whereNotNull(string|null $key = null)

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

Parameters

string|null $key

Return Value

Enumerable

Enumerable whereStrict(string $key, mixed $value)

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

Parameters

string $key
mixed $value

Return Value

Enumerable

Enumerable 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

Enumerable

Enumerable 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

Enumerable

Enumerable 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

Enumerable

Enumerable 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

Enumerable

Enumerable 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

Enumerable

Enumerable 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

Enumerable

whereInstanceOf($type)

No description

Parameters

$type

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

No description

Parameters

callable $callback
$default

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

Get the first item by the given key value pair.

Parameters

string $key
mixed $operator
mixed $value

Return Value

TValue|null

Enumerable flatten(int $depth = INF)

Get a flattened array of the items in the collection.

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

Concatenate values of a given key as a string.

Parameters

string $value
string|null $glue

Return Value

string

Enumerable intersect(TValue>|TValue> $items)

Intersect the collection with the given items.

Parameters

TValue>|TValue> $items

Return Value

Enumerable

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 collection is empty or not.

Return Value

bool

bool isNotEmpty()

Determine if the collection is not empty.

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

map(callable $callback)

No description

Parameters

callable $callback

Enumerable mapSpread(callable $callback)

Run a map over each nested chunk of items.

Parameters

callable $callback

Return Value

Enumerable

mapToDictionary(callable $callback)

No description

Parameters

callable $callback

mapToGroups(callable $callback)

No description

Parameters

callable $callback

mapWithKeys(callable $callback)

No description

Parameters

callable $callback

flatMap(callable $callback)

No description

Parameters

callable $callback

mapInto($class)

No description

Parameters

$class

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

TValue min($callback = null)

Get the min value of a given key.

Parameters

$callback

Return Value

TValue

TValue max($callback = null)

Get the max value of a given key.

Parameters

$callback

Return Value

TValue

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

Enumerable forPage(int $page, int $perPage)

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

Parameters

int $page
int $perPage

Return Value

Enumerable

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

No description

Parameters

$key
$operator
$value

Enumerable concat(TValue> $source)

Push all of the given items onto the collection.

Parameters

TValue> $source

Return Value

Enumerable

random($number = null)

No description

Parameters

$number

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

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

chunkWhile(callable $callback)

No description

Parameters

callable $callback

splitIn($numberOfGroups)

No description

Parameters

$numberOfGroups

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

mixed sum($callback = null)

Get the sum of the given values.

Parameters

$callback

Return Value

mixed

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

Enumerable takeWhile($value)

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

Parameters

$value

Return Value

Enumerable

$this tap(callable $callback)

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

Parameters

callable $callback

Return Value

$this

TPipeReturnType pipe(callable $callback)

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

Parameters

callable $callback

Return Value

TPipeReturnType

mixed pipeInto(class-string $class)

Pass the collection into a new class.

Parameters

class-string $class

Return Value

mixed

mixed pipeThrough(callable[] $pipes)

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

Parameters

callable[] $pipes

Return Value

mixed

pluck($value, $key = null)

No description

Parameters

$value
$key

Enumerable reject($callback = true)

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

Parameters

$callback

Return Value

Enumerable

Enumerable undot()

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

Return Value

Enumerable

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

Return only unique items from the collection array.

Parameters

$key
bool $strict

Return Value

Enumerable

Enumerable uniqueStrict($key = null)

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

Parameters

$key

Return Value

Enumerable

values()

No description

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

countBy($callback = null)

No description

Parameters

$callback

zip($items)

No description

Parameters

$items

TValue> collect()

Collect the values into a collection.

Return Value

TValue>

array jsonSerialize()

No description

Return Value

array

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