\Cake\Collection\IteratorNestIterator

__construct()

__construct(array|\Traversable  $items, string|callable  $nestKey) 

Constructor

Parameters

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

count()

count() : integer

{@inheritDoc}

Returns

countKeys()

countKeys() : integer

{@inheritDoc}

Returns

__debugInfo()

__debugInfo() : array

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

Returns

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

getChildren()

getChildren() : \Traversable

Returns a traversable containing the children for the current item

Returns

hasChildren()

hasChildren() : boolean

Returns true if there is an array or a traversable object stored under the configured nestKey for the current item

Returns

optimizeUnwrap()

optimizeUnwrap() : \Traversable|array

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

Returns