\Cake\CollectionCollection

each()

each(callable  $c) 

{@inheritDoc}

Parameters

filter()

filter(callable  $c = null) : \Cake\Collection\Iterator\FilterIterator

{@inheritDoc}

Parameters

Returns

reject()

reject(callable  $c) : \Cake\Collection\Iterator\FilterIterator

{@inheritDoc}

Parameters

Returns

every()

every(callable  $c) 

{@inheritDoc}

Parameters

some()

some(callable  $c) 

{@inheritDoc}

Parameters

contains()

contains(  $value) 

{@inheritDoc}

Parameters

map()

map(callable  $c) : \Cake\Collection\Iterator\ReplaceIterator

{@inheritDoc}

Parameters

Returns

reduce()

reduce(callable  $c,   $zero = null) 

{@inheritDoc}

Parameters

extract()

extract(  $matcher) 

{@inheritDoc}

Parameters

max()

max(  $callback,   $type = \SORT_NUMERIC) 

{@inheritDoc}

Parameters

min()

min(  $callback,   $type = \SORT_NUMERIC) 

{@inheritDoc}

Parameters

avg()

avg(  $matcher = null) 

{@inheritDoc}

Parameters

median()

median(  $matcher = null) 

{@inheritDoc}

Parameters

sortBy()

sortBy(  $callback,   $dir = \SORT_DESC,   $type = \SORT_NUMERIC) 

{@inheritDoc}

Parameters

groupBy()

groupBy(  $callback) 

{@inheritDoc}

Parameters

indexBy()

indexBy(  $callback) 

{@inheritDoc}

Parameters

countBy()

countBy(  $callback) 

{@inheritDoc}

Parameters

sumOf()

sumOf(  $matcher = null) 

{@inheritDoc}

Parameters

shuffle()

shuffle() 

{@inheritDoc}

sample()

sample(  $size = 10) 

{@inheritDoc}

Parameters

take()

take(  $size = 1,   $from) 

{@inheritDoc}

Parameters

skip()

skip(  $howMany) 

{@inheritDoc}

Parameters

match()

match(array  $conditions) 

{@inheritDoc}

Parameters

firstMatch()

firstMatch(array  $conditions) 

{@inheritDoc}

Parameters

first()

first() 

{@inheritDoc}

last()

last() 

{@inheritDoc}

takeLast()

takeLast(  $howMany) 

{@inheritDoc}

Parameters

append()

append(  $items) 

{@inheritDoc}

Parameters

appendItem()

appendItem(  $item,   $key = null) 

{@inheritDoc}

Parameters

prepend()

prepend(  $items) 

{@inheritDoc}

Parameters

prependItem()

prependItem(  $item,   $key = null) 

{@inheritDoc}

Parameters

combine()

combine(  $keyPath,   $valuePath,   $groupPath = null) 

{@inheritDoc}

Parameters

nest()

nest(  $idPath,   $parentPath,   $nestingKey = 'children') 

{@inheritDoc}

Parameters

insert()

insert(  $path,   $values) : \Cake\Collection\Iterator\InsertIterator

{@inheritDoc}

Parameters

Returns

toArray()

toArray(  $preserveKeys = true) 

{@inheritDoc}

Parameters

toList()

toList() 

{@inheritDoc}

jsonSerialize()

jsonSerialize() 

{@inheritDoc}

compile()

compile(  $preserveKeys = true) 

{@inheritDoc}

Parameters

lazy()

lazy() 

{@inheritDoc}

buffered()

buffered() : \Cake\Collection\Iterator\BufferedIterator

{@inheritDoc}

Returns

listNested()

listNested(  $dir = 'desc',   $nestingKey = 'children') : \Cake\Collection\Iterator\TreeIterator

{@inheritDoc}

Parameters

Returns

stopWhen()

stopWhen(  $condition) : \Cake\Collection\Iterator\StoppableIterator

{@inheritDoc}

Parameters

Returns

unfold()

unfold(callable  $transformer = null) 

{@inheritDoc}

Parameters

through()

through(callable  $handler) 

{@inheritDoc}

Parameters

zip()

zip(  $items) 

{@inheritDoc}

Parameters

zipWith()

zipWith(  $items,   $callable) 

{@inheritDoc}

Parameters

chunk()

chunk(  $chunkSize) 

{@inheritDoc}

Parameters

chunkWithKeys()

chunkWithKeys(  $chunkSize,   $preserveKeys = true) 

{@inheritDoc}

Parameters

isEmpty()

isEmpty() 

{@inheritDoc}

unwrap()

unwrap() 

{@inheritDoc}

_unwrap()

_unwrap() 

cartesianProduct()

cartesianProduct(callable|null  $operation = null, callable|null  $filter = null) : \Cake\Collection\CollectionInterface

Parameters

Throws

\LogicException

Returns

transpose()

transpose() : \Cake\Collection\CollectionInterface

{@inheritDoc}

Throws

\LogicException

Returns

count()

count() : integer

Returns the amount of elements in the collection.

WARNINGS:

Consumes all elements for NoRewindIterator collections:

On certain type of collections, calling this method may render unusable afterwards. That is, you may not be able to get elements out of it, or to iterate on it anymore.

Specifically any collection wrapping a Generator (a function with a yield statement) or a unbuffered database cursor will not accept any other function calls after calling count() on it.

Create a new collection with buffered() method to overcome this problem.

Can report more elements than unique keys:

Any collection constructed by appending collections together, or by having internal iterators returning duplicate keys, will report a larger amount of elements using this functions than the final amount of elements when converting the collections to a keyed array. This is because duplicate keys will be collapsed into a single one in the final array, whereas this count method is only concerned by the amount of elements after converting it to a plain list.

If you need the count of elements after taking the keys in consideration (the count of unique keys), you can call countKeys()

Will change the current position of the iterator:

Calling this method at the same time that you are iterating this collections, for example in a foreach, will result in undefined behavior. Avoid doing this.

Returns

countKeys()

countKeys() : integer

Returns the number of unique keys in this iterator. This is, the number of elements the collection will contain after calling `toArray()`

This method comes with a number of caveats. Please refer to CollectionInterface::count() for details.

Returns

__construct()

__construct(array|\Traversable  $items) 

Constructor. You can provide an array or any traversable object

Parameters

Throws

\InvalidArgumentException

If passed incorrect type for items.

serialize()

serialize() : string

Returns a string representation of this object that can be used to reconstruct it

Returns

unserialize()

unserialize(string  $collection) : void

Unserializes the passed string and rebuilds the Collection instance

Parameters

__debugInfo()

__debugInfo() : array

Returns an array that can be used to describe the internal state of this object.

Returns

optimizeUnwrap()

optimizeUnwrap() : \Traversable|array

Unwraps this iterator and returns the simplest traversable that can be used for getting the data out

Returns