1. class
  2. Illuminate
  3. \
  4. Routing
  5. \
  6. SortedMiddleware

SortedMiddleware

class SortedMiddleware extends Collection (View source)

Traits

Macroable

Properties

static protected array $macros The registered string macros. from Macroable
protected array $items The items contained in the collection. from Collection
static protected array $proxies The methods that can be proxied. from Collection

Methods

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

Register a custom macro.

from Macroable
static void
mixin(object $mixin)

Mix another object into the class.

from Macroable
static bool
hasMacro(string $name)

Checks if macro is registered.

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

Dynamically handle calls to the class.

from Macroable
mixed
__call(string $method, array $parameters)

Dynamically handle calls to the class.

from Macroable
void
__construct(array $priorityMap, array|Collection $middlewares)

Create a new Sorted Middleware container.

static Collection
make(mixed $items = [])

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

from Collection
static Collection
wrap(mixed $value)

Wrap the given value in a collection if applicable.

from Collection
static array
unwrap(array|Collection $value)

Get the underlying items from the given collection if applicable.

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

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

from Collection
array
all()

Get all of the items in the collection.

from Collection
mixed
avg(callable|string|null $callback = null)

Get the average value of a given key.

from Collection
mixed
average(callable|string|null $callback = null)

Alias for the "avg" method.

from Collection
mixed
median(null $key = null)

Get the median of a given key.

from Collection
array|null
mode(mixed $key = null)

Get the mode of a given key.

from Collection
Collection
collapse()

Collapse the collection of items into a single array.

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

Determine if an item exists in the collection.

from Collection
bool
containsStrict(mixed $key, mixed $value = null)

Determine if an item exists in the collection using strict comparison.

from Collection
Collection
crossJoin(mixed ...$lists)

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

from Collection
void
dd(...$args)

Dump the collection and end the script.

from Collection
$this
dump()

Dump the collection.

from Collection
Collection
diff(mixed $items)

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

from Collection
Collection
diffUsing(mixed $items, callable $callback)

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

from Collection
Collection
diffAssoc(mixed $items)

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

from Collection
Collection
diffAssocUsing(mixed $items, callable $callback)

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

from Collection
Collection
diffKeys(mixed $items)

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

from Collection
Collection
diffKeysUsing(mixed $items, callable $callback)

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

from Collection
$this
each(callable $callback)

Execute a callback over each item.

from Collection
Collection
eachSpread(callable $callback)

Execute a callback over each nested chunk of items.

from Collection
bool
every(string|callable $key, mixed $operator = null, mixed $value = null)

Determine if all items in the collection pass the given test.

from Collection
Collection
except(Collection|mixed $keys)

Get all items except for those with the specified keys.

from Collection
Collection
filter(callable $callback = null)

Run a filter over each of the items.

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

Apply the callback if the value is truthy.

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

Apply the callback if the value is falsy.

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

Filter items by the given key value pair.

from Collection
Closure
operatorForWhere(string $key, string $operator, mixed $value = null)

Get an operator checker callback.

from Collection
Collection
whereStrict(string $key, mixed $value)

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

from Collection
Collection
whereIn(string $key, mixed $values, bool $strict = false)

Filter items by the given key value pair.

from Collection
Collection
whereInStrict(string $key, mixed $values)

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

from Collection
Collection
whereNotIn(string $key, mixed $values, bool $strict = false)

Filter items by the given key value pair.

from Collection
Collection
whereNotInStrict(string $key, mixed $values)

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

from Collection
Collection
whereInstanceOf(string $type)

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

from Collection
mixed
first(callable $callback = null, mixed $default = null)

Get the first item from the collection.

from Collection
Collection
firstWhere(string $key, mixed $operator, mixed $value = null)

Get the first item by the given key value pair.

from Collection
Collection
flatten(int $depth = INF)

Get a flattened array of the items in the collection.

from Collection
Collection
flip()

Flip the items in the collection.

from Collection
$this
forget(string|array $keys)

Remove an item from the collection by key.

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

Get an item from the collection by key.

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

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

from Collection
Collection
keyBy(callable|string $keyBy)

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

from Collection
bool
has(mixed $key)

Determine if an item exists in the collection by key.

from Collection
string
implode(string $value, string $glue = null)

Concatenate values of a given key as a string.

from Collection
Collection
intersect(mixed $items)

Intersect the collection with the given items.

from Collection
Collection
intersectByKeys(mixed $items)

Intersect the collection with the given items by key.

from Collection
bool
isEmpty()

Determine if the collection is empty or not.

from Collection
bool
isNotEmpty()

Determine if the collection is not empty.

from Collection
bool
useAsCallable(mixed $value)

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

from Collection
Collection
keys()

Get the keys of the collection items.

from Collection
mixed
last(callable $callback = null, mixed $default = null)

Get the last item from the collection.

from Collection
Collection
pluck(string|array $value, string|null $key = null)

Get the values of a given key.

from Collection
Collection
map(callable $callback)

Run a map over each of the items.

from Collection
Collection
mapSpread(callable $callback)

Run a map over each nested chunk of items.

from Collection
Collection
mapToDictionary(callable $callback)

Run a dictionary map over the items.

from Collection
Collection
mapToGroups(callable $callback)

Run a grouping map over the items.

from Collection
Collection
mapWithKeys(callable $callback)

Run an associative map over each of the items.

from Collection
Collection
flatMap(callable $callback)

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

from Collection
Collection
mapInto(string $class)

Map the values into a new class.

from Collection
mixed
max(callable|string|null $callback = null)

Get the max value of a given key.

from Collection
Collection
merge(mixed $items)

Merge the collection with the given items.

from Collection
Collection
combine(mixed $values)

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

from Collection
Collection
union(mixed $items)

Union the collection with the given items.

from Collection
mixed
min(callable|string|null $callback = null)

Get the min value of a given key.

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

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

from Collection
Collection
only(mixed $keys)

Get the items with the specified keys.

from Collection
Collection
forPage(int $page, int $perPage)

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

from Collection
Collection
partition(callable|string $key, mixed $operator = null, mixed $value = null)

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

from Collection
mixed
pipe(callable $callback)

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

from Collection
mixed
pop()

Get and remove the last item from the collection.

from Collection
$this
prepend(mixed $value, mixed $key = null)

Push an item onto the beginning of the collection.

from Collection
$this
push(mixed $value)

Push an item onto the end of the collection.

from Collection
Collection
concat(Traversable|array $source)

Push all of the given items onto the collection.

from Collection
mixed
pull(mixed $key, mixed $default = null)

Get and remove an item from the collection.

from Collection
$this
put(mixed $key, mixed $value)

Put an item in the collection by key.

from Collection
Collection|mixed
random(int|null $number = null)

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

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

Reduce the collection to a single value.

from Collection
Collection
reject(callable|mixed $callback)

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

from Collection
Collection
reverse()

Reverse items order.

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

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

from Collection
mixed
shift()

Get and remove the first item from the collection.

from Collection
Collection
shuffle(int $seed = null)

Shuffle the items in the collection.

from Collection
Collection
slice(int $offset, int $length = null)

Slice the underlying collection array.

from Collection
Collection
split(int $numberOfGroups)

Split a collection into a certain number of groups.

from Collection
Collection
chunk(int $size)

Chunk the underlying collection array.

from Collection
Collection
sort(callable $callback = null)

Sort through each item with a callback.

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

Sort the collection using the given callback.

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

Sort the collection in descending order using the given callback.

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

Sort the collection keys.

from Collection
Collection
sortKeysDesc(int $options = SORT_REGULAR)

Sort the collection keys in descending order.

from Collection
Collection
splice(int $offset, int|null $length = null, mixed $replacement = [])

Splice a portion of the underlying collection array.

from Collection
mixed
sum(callable|string|null $callback = null)

Get the sum of the given values.

from Collection
Collection
take(int $limit)

Take the first or last {$limit} items.

from Collection
$this
tap(callable $callback)

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

from Collection
$this
transform(callable $callback)

Transform each item in the collection using a callback.

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

Return only unique items from the collection array.

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

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

from Collection
Collection
values()

Reset the keys on the underlying array.

from Collection
callable
valueRetriever(string $value)

Get a value retrieving callback.

from Collection
Collection
zip(mixed $items)

Zip the collection together with one or more arrays.

from Collection
Collection
pad(int $size, mixed $value)

Pad collection to the specified length with a value.

from Collection
array
toArray()

Get the collection of items as a plain array.

from Collection
array
jsonSerialize()

Convert the object into something JSON serializable.

from Collection
string
toJson(int $options = 0)

Get the collection of items as JSON.

from Collection
ArrayIterator
getIterator()

Get an iterator for the items.

from Collection
CachingIterator
getCachingIterator(int $flags = CachingIterator::CALL_TOSTRING)

Get a CachingIterator instance.

from Collection
int
count()

Count the number of items in the collection.

from Collection
Collection
toBase()

Get a base Support collection instance from this collection.

from Collection
bool
offsetExists(mixed $key)

Determine if an item exists at an offset.

from Collection
mixed
offsetGet(mixed $key)

Get an item at a given offset.

from Collection
void
offsetSet(mixed $key, mixed $value)

Set the item at a given offset.

from Collection
void
offsetUnset(string $key)

Unset the item at a given offset.

from Collection
string
__toString()

Convert the collection to its string representation.

from Collection
array
getArrayableItems(mixed $items)

Results array of items from Collection or Arrayable.

from Collection
static void
proxy(string $method)

Add a method to the list of proxied methods.

from Collection
mixed
__get(string $key)

Dynamically access collection proxies.

from Collection
array
sortMiddleware(array $priorityMap, array $middlewares)

Sort the middlewares by the given priority map.

array
moveMiddleware(array $middlewares, int $from, int $to)

Splice a middleware into a new position and remove the old entry.

Details

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

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

in Macroable at line 39
static void mixin(object $mixin)

Mix another object into the class.

Parameters

object $mixin

Return Value

void

Exceptions

ReflectionException

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

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 72
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 96
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line 16
void __construct(array $priorityMap, array|Collection $middlewares)

Create a new Sorted Middleware container.

Parameters

array $priorityMap
array|Collection $middlewares

Return Value

void

in Collection at line 81
static Collection make(mixed $items = [])

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

Parameters

mixed $items

Return Value

Collection

in Collection at line 92
static Collection wrap(mixed $value)

Wrap the given value in a collection if applicable.

Parameters

mixed $value

Return Value

Collection

in Collection at line 105
static array unwrap(array|Collection $value)

Get the underlying items from the given collection if applicable.

Parameters

array|Collection $value

Return Value

array

in Collection at line 117
static Collection times(int $number, callable $callback = null)

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

Parameters

int $number
callable $callback

Return Value

Collection

in Collection at line 135
array all()

Get all of the items in the collection.

Return Value

array

in Collection at line 146
mixed avg(callable|string|null $callback = null)

Get the average value of a given key.

Parameters

callable|string|null $callback

Return Value

mixed

in Collection at line 159
mixed average(callable|string|null $callback = null)

Alias for the "avg" method.

Parameters

callable|string|null $callback

Return Value

mixed

in Collection at line 170
mixed median(null $key = null)

Get the median of a given key.

Parameters

null $key

Return Value

mixed

in Collection at line 198
array|null mode(mixed $key = null)

Get the mode of a given key.

Parameters

mixed $key

Return Value

array|null

in Collection at line 228
Collection collapse()

Collapse the collection of items into a single array.

Return Value

Collection

in Collection at line 241
bool contains(mixed $key, mixed $operator = null, mixed $value = null)

Determine if an item exists in the collection.

Parameters

mixed $key
mixed $operator
mixed $value

Return Value

bool

in Collection at line 263
bool containsStrict(mixed $key, mixed $value = null)

Determine if an item exists in the collection using strict comparison.

Parameters

mixed $key
mixed $value

Return Value

bool

in Collection at line 284
Collection crossJoin(mixed ...$lists)

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

Parameters

mixed ...$lists

Return Value

Collection

in Collection at line 296
void dd(...$args)

Dump the collection and end the script.

Parameters

...$args

Return Value

void

in Collection at line 308
$this dump()

Dump the collection.

Return Value

$this

in Collection at line 325
Collection diff(mixed $items)

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

Parameters

mixed $items

Return Value

Collection

in Collection at line 337
Collection diffUsing(mixed $items, callable $callback)

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

Parameters

mixed $items
callable $callback

Return Value

Collection

in Collection at line 348
Collection diffAssoc(mixed $items)

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

Parameters

mixed $items

Return Value

Collection

in Collection at line 360
Collection diffAssocUsing(mixed $items, callable $callback)

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

Parameters

mixed $items
callable $callback

Return Value

Collection

in Collection at line 371
Collection diffKeys(mixed $items)

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

Parameters

mixed $items

Return Value

Collection

in Collection at line 383
Collection diffKeysUsing(mixed $items, callable $callback)

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

Parameters

mixed $items
callable $callback

Return Value

Collection

in Collection at line 394
$this each(callable $callback)

Execute a callback over each item.

Parameters

callable $callback

Return Value

$this

in Collection at line 411
Collection eachSpread(callable $callback)

Execute a callback over each nested chunk of items.

Parameters

callable $callback

Return Value

Collection

in Collection at line 428
bool every(string|callable $key, mixed $operator = null, mixed $value = null)

Determine if all items in the collection pass the given test.

Parameters

string|callable $key
mixed $operator
mixed $value

Return Value

bool

in Collection at line 451
Collection except(Collection|mixed $keys)

Get all items except for those with the specified keys.

Parameters

Collection|mixed $keys

Return Value

Collection

in Collection at line 468
Collection filter(callable $callback = null)

Run a filter over each of the items.

Parameters

callable $callback

Return Value

Collection

in Collection at line 485
Collection|mixed when(bool $value, callable $callback, callable $default = null)

Apply the callback if the value is truthy.

Parameters

bool $value
callable $callback
callable $default

Return Value

Collection|mixed

in Collection at line 504
Collection|mixed unless(bool $value, callable $callback, callable $default = null)

Apply the callback if the value is falsy.

Parameters

bool $value
callable $callback
callable $default

Return Value

Collection|mixed

in Collection at line 517
Collection where(string $key, mixed $operator, mixed $value = null)

Filter items by the given key value pair.

Parameters

string $key
mixed $operator
mixed $value

Return Value

Collection

in Collection at line 530
protected Closure operatorForWhere(string $key, string $operator, mixed $value = null)

Get an operator checker callback.

Parameters

string $key
string $operator
mixed $value

Return Value

Closure

in Collection at line 572
Collection whereStrict(string $key, mixed $value)

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

Parameters

string $key
mixed $value

Return Value

Collection

in Collection at line 585
Collection whereIn(string $key, mixed $values, bool $strict = false)

Filter items by the given key value pair.

Parameters

string $key
mixed $values
bool $strict

Return Value

Collection

in Collection at line 601
Collection whereInStrict(string $key, mixed $values)

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

Parameters

string $key
mixed $values

Return Value

Collection

in Collection at line 614
Collection whereNotIn(string $key, mixed $values, bool $strict = false)

Filter items by the given key value pair.

Parameters

string $key
mixed $values
bool $strict

Return Value

Collection

in Collection at line 630
Collection whereNotInStrict(string $key, mixed $values)

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

Parameters

string $key
mixed $values

Return Value

Collection

in Collection at line 641
Collection whereInstanceOf(string $type)

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

Parameters

string $type

Return Value

Collection

in Collection at line 655
mixed first(callable $callback = null, mixed $default = null)

Get the first item from the collection.

Parameters

callable $callback
mixed $default

Return Value

mixed

in Collection at line 668
Collection firstWhere(string $key, mixed $operator, mixed $value = null)

Get the first item by the given key value pair.

Parameters

string $key
mixed $operator
mixed $value

Return Value

Collection

in Collection at line 679
Collection flatten(int $depth = INF)

Get a flattened array of the items in the collection.

Parameters

int $depth

Return Value

Collection

in Collection at line 689
Collection flip()

Flip the items in the collection.

Return Value

Collection

in Collection at line 700
$this forget(string|array $keys)

Remove an item from the collection by key.

Parameters

string|array $keys

Return Value

$this

in Collection at line 716
mixed get(mixed $key, mixed $default = null)

Get an item from the collection by key.

Parameters

mixed $key
mixed $default

Return Value

mixed

in Collection at line 732
Collection groupBy(callable|string $groupBy, bool $preserveKeys = false)

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

Parameters

callable|string $groupBy
bool $preserveKeys

Return Value

Collection

in Collection at line 777
Collection keyBy(callable|string $keyBy)

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

Parameters

callable|string $keyBy

Return Value

Collection

in Collection at line 802
bool has(mixed $key)

Determine if an item exists in the collection by key.

Parameters

mixed $key

Return Value

bool

in Collection at line 822
string implode(string $value, string $glue = null)

Concatenate values of a given key as a string.

Parameters

string $value
string $glue

Return Value

string

in Collection at line 839
Collection intersect(mixed $items)

Intersect the collection with the given items.

Parameters

mixed $items

Return Value

Collection

in Collection at line 850
Collection intersectByKeys(mixed $items)

Intersect the collection with the given items by key.

Parameters

mixed $items

Return Value

Collection

in Collection at line 862
bool isEmpty()

Determine if the collection is empty or not.

Return Value

bool

in Collection at line 872
bool isNotEmpty()

Determine if the collection is not empty.

Return Value

bool

in Collection at line 883
protected bool useAsCallable(mixed $value)

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

Parameters

mixed $value

Return Value

bool

in Collection at line 893
Collection keys()

Get the keys of the collection items.

Return Value

Collection

in Collection at line 905
mixed last(callable $callback = null, mixed $default = null)

Get the last item from the collection.

Parameters

callable $callback
mixed $default

Return Value

mixed

in Collection at line 917
Collection pluck(string|array $value, string|null $key = null)

Get the values of a given key.

Parameters

string|array $value
string|null $key

Return Value

Collection

in Collection at line 928
Collection map(callable $callback)

Run a map over each of the items.

Parameters

callable $callback

Return Value

Collection

in Collection at line 943
Collection mapSpread(callable $callback)

Run a map over each nested chunk of items.

Parameters

callable $callback

Return Value

Collection

in Collection at line 960
Collection 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

Collection

in Collection at line 989
Collection 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

in Collection at line 1004
Collection 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

in Collection at line 1025
Collection flatMap(callable $callback)

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

Parameters

callable $callback

Return Value

Collection

in Collection at line 1036
Collection mapInto(string $class)

Map the values into a new class.

Parameters

string $class

Return Value

Collection

in Collection at line 1049
mixed max(callable|string|null $callback = null)

Get the max value of a given key.

Parameters

callable|string|null $callback

Return Value

mixed

in Collection at line 1068
Collection merge(mixed $items)

Merge the collection with the given items.

Parameters

mixed $items

Return Value

Collection

in Collection at line 1079
Collection combine(mixed $values)

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

Parameters

mixed $values

Return Value

Collection

in Collection at line 1090
Collection union(mixed $items)

Union the collection with the given items.

Parameters

mixed $items

Return Value

Collection

in Collection at line 1101
mixed min(callable|string|null $callback = null)

Get the min value of a given key.

Parameters

callable|string|null $callback

Return Value

mixed

in Collection at line 1121
Collection nth(int $step, int $offset = 0)

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

Parameters

int $step
int $offset

Return Value

Collection

in Collection at line 1144
Collection only(mixed $keys)

Get the items with the specified keys.

Parameters

mixed $keys

Return Value

Collection

in Collection at line 1166
Collection forPage(int $page, int $perPage)

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

Parameters

int $page
int $perPage

Return Value

Collection

in Collection at line 1181
Collection partition(callable|string $key, mixed $operator = null, mixed $value = null)

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

Parameters

callable|string $key
mixed $operator
mixed $value

Return Value

Collection

in Collection at line 1202
mixed pipe(callable $callback)

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

Parameters

callable $callback

Return Value

mixed

in Collection at line 1212
mixed pop()

Get and remove the last item from the collection.

Return Value

mixed

in Collection at line 1224
$this prepend(mixed $value, mixed $key = null)

Push an item onto the beginning of the collection.

Parameters

mixed $value
mixed $key

Return Value

$this

in Collection at line 1237
$this push(mixed $value)

Push an item onto the end of the collection.

Parameters

mixed $value

Return Value

$this

in Collection at line 1250
Collection concat(Traversable|array $source)

Push all of the given items onto the collection.

Parameters

Traversable|array $source

Return Value

Collection

in Collection at line 1268
mixed pull(mixed $key, mixed $default = null)

Get and remove an item from the collection.

Parameters

mixed $key
mixed $default

Return Value

mixed

in Collection at line 1280
$this put(mixed $key, mixed $value)

Put an item in the collection by key.

Parameters

mixed $key
mixed $value

Return Value

$this

in Collection at line 1295
Collection|mixed random(int|null $number = null)

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

Parameters

int|null $number

Return Value

Collection|mixed

Exceptions

InvalidArgumentException

in Collection at line 1311
mixed reduce(callable $callback, mixed $initial = null)

Reduce the collection to a single value.

Parameters

callable $callback
mixed $initial

Return Value

mixed

in Collection at line 1322
Collection reject(callable|mixed $callback)

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

Parameters

callable|mixed $callback

Return Value

Collection

in Collection at line 1340
Collection reverse()

Reverse items order.

Return Value

Collection

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

Parameters

mixed $value
bool $strict

Return Value

mixed

in Collection at line 1372
mixed shift()

Get and remove the first item from the collection.

Return Value

mixed

in Collection at line 1383
Collection shuffle(int $seed = null)

Shuffle the items in the collection.

Parameters

int $seed

Return Value

Collection

in Collection at line 1395
Collection slice(int $offset, int $length = null)

Slice the underlying collection array.

Parameters

int $offset
int $length

Return Value

Collection

in Collection at line 1406
Collection split(int $numberOfGroups)

Split a collection into a certain number of groups.

Parameters

int $numberOfGroups

Return Value

Collection

in Collection at line 1423
Collection chunk(int $size)

Chunk the underlying collection array.

Parameters

int $size

Return Value

Collection

in Collection at line 1444
Collection sort(callable $callback = null)

Sort through each item with a callback.

Parameters

callable $callback

Return Value

Collection

in Collection at line 1463
Collection sortBy(callable|string $callback, int $options = SORT_REGULAR, bool $descending = false)

Sort the collection using the given callback.

Parameters

callable|string $callback
int $options
bool $descending

Return Value

Collection

in Collection at line 1496
Collection sortByDesc(callable|string $callback, int $options = SORT_REGULAR)

Sort the collection in descending order using the given callback.

Parameters

callable|string $callback
int $options

Return Value

Collection

in Collection at line 1508
Collection sortKeys(int $options = SORT_REGULAR, bool $descending = false)

Sort the collection keys.

Parameters

int $options
bool $descending

Return Value

Collection

in Collection at line 1523
Collection sortKeysDesc(int $options = SORT_REGULAR)

Sort the collection keys in descending order.

Parameters

int $options

Return Value

Collection

in Collection at line 1536
Collection splice(int $offset, int|null $length = null, mixed $replacement = [])

Splice a portion of the underlying collection array.

Parameters

int $offset
int|null $length
mixed $replacement

Return Value

Collection

in Collection at line 1551
mixed sum(callable|string|null $callback = null)

Get the sum of the given values.

Parameters

callable|string|null $callback

Return Value

mixed

in Collection at line 1570
Collection take(int $limit)

Take the first or last {$limit} items.

Parameters

int $limit

Return Value

Collection

in Collection at line 1585
$this tap(callable $callback)

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

Parameters

callable $callback

Return Value

$this

in Collection at line 1598
$this transform(callable $callback)

Transform each item in the collection using a callback.

Parameters

callable $callback

Return Value

$this

in Collection at line 1612
Collection unique(string|callable|null $key = null, bool $strict = false)

Return only unique items from the collection array.

Parameters

string|callable|null $key
bool $strict

Return Value

Collection

in Collection at line 1633
Collection uniqueStrict(string|callable|null $key = null)

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

Parameters

string|callable|null $key

Return Value

Collection

in Collection at line 1643
Collection values()

Reset the keys on the underlying array.

Return Value

Collection

in Collection at line 1654
protected callable valueRetriever(string $value)

Get a value retrieving callback.

Parameters

string $value

Return Value

callable

in Collection at line 1674
Collection zip(mixed $items)

Zip the collection together with one or more arrays.

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

Parameters

mixed $items

Return Value

Collection

in Collection at line 1694
Collection pad(int $size, mixed $value)

Pad collection to the specified length with a value.

Parameters

int $size
mixed $value

Return Value

Collection

in Collection at line 1704
array toArray()

Get the collection of items as a plain array.

Return Value

array

in Collection at line 1716
array jsonSerialize()

Convert the object into something JSON serializable.

Return Value

array

in Collection at line 1737
string toJson(int $options = 0)

Get the collection of items as JSON.

Parameters

int $options

Return Value

string

in Collection at line 1747
ArrayIterator getIterator()

Get an iterator for the items.

Return Value

ArrayIterator

in Collection at line 1758
CachingIterator getCachingIterator(int $flags = CachingIterator::CALL_TOSTRING)

Get a CachingIterator instance.

Parameters

int $flags

Return Value

CachingIterator

in Collection at line 1768
int count()

Count the number of items in the collection.

Return Value

int

in Collection at line 1778
Collection toBase()

Get a base Support collection instance from this collection.

Return Value

Collection

in Collection at line 1789
bool offsetExists(mixed $key)

Determine if an item exists at an offset.

Parameters

mixed $key

Return Value

bool

in Collection at line 1800
mixed offsetGet(mixed $key)

Get an item at a given offset.

Parameters

mixed $key

Return Value

mixed

in Collection at line 1812
void offsetSet(mixed $key, mixed $value)

Set the item at a given offset.

Parameters

mixed $key
mixed $value

Return Value

void

in Collection at line 1827
void offsetUnset(string $key)

Unset the item at a given offset.

Parameters

string $key

Return Value

void

in Collection at line 1837
string __toString()

Convert the collection to its string representation.

Return Value

string

in Collection at line 1848
protected array getArrayableItems(mixed $items)

Results array of items from Collection or Arrayable.

Parameters

mixed $items

Return Value

array

in Collection at line 1873
static void proxy(string $method)

Add a method to the list of proxied methods.

Parameters

string $method

Return Value

void

in Collection at line 1886
mixed __get(string $key)

Dynamically access collection proxies.

Parameters

string $key

Return Value

mixed

Exceptions

Exception

at line 34
protected array sortMiddleware(array $priorityMap, array $middlewares)

Sort the middlewares by the given priority map.

Each call to this method makes one discrete middleware movement if necessary.

Parameters

array $priorityMap
array $middlewares

Return Value

array

at line 76
protected array moveMiddleware(array $middlewares, int $from, int $to)

Splice a middleware into a new position and remove the old entry.

Parameters

array $middlewares
int $from
int $to

Return Value

array