Class NoChildrenIterator

An iterator that can be used as an argument for other iterators that require a RecursiveIterator but do not want children. This iterator will always behave as having no nested items.

IteratorIterator implements Iterator, Traversable, OuterIterator

Cake\Collection\Collection implements Cake\Collection\CollectionInterface, Serializable uses Cake\Collection\CollectionTrait

Cake\Collection\Iterator\NoChildrenIterator implements RecursiveIterator

Namespace: Cake\Collection\Iterator
Location: Collection/Iterator/NoChildrenIterator.php

Method Summary

getChildren() public

Returns null as there are no children for this iteration level
hasChildren() public

Returns false as there are no children iterators in this collection

Method Detail

getChildren() public ¶

getChildren( )

Returns null as there are no children for this iteration level

Returns

null

Implementation of

RecursiveIterator::getChildren()

hasChildren() public ¶

hasChildren( )

Returns false as there are no children iterators in this collection

Returns

boolean

Implementation of

RecursiveIterator::hasChildren()

Methods inherited from Cake\Collection\Collection

__construct() public ¶

__construct( array|Traversable $items )

Constructor. You can provide an array or any traversable object

Parameters

array|Traversable $items: Items.

Throws

InvalidArgumentException
If passed incorrect type for items.

Overrides

IteratorIterator::__construct()

__debugInfo() public ¶

__debugInfo( )

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

Returns

array

count() public ¶

count( )

Throws an exception.

Issuing a count on a Collection can have many side effects, some making the Collection unusable after the count operation.

Throws

LogicException

serialize() public ¶

serialize( )

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

Returns

string

Implementation of

Serializable::serialize()

unserialize() public ¶

unserialize( string $collection )

Unserializes the passed string and rebuilds the Collection instance

Parameters

string $collection: The serialized collection

Implementation of

Serializable::unserialize()

Methods used from Cake\Collection\CollectionTrait

_unwrap() public ¶

_unwrap( )

append() public ¶

append( $items )

avg() public ¶

avg( $matcher null )

buffered() public ¶

buffered( )

Returns

Cake\Collection\Iterator\BufferedIterator

cartesianProduct() public ¶

cartesianProduct( callable $operation null , callable $filter null )

Returns

Cake\Collection\CollectionInterface

chunk() public ¶

chunk( $chunkSize )

chunkWithKeys() public ¶

chunkWithKeys( $chunkSize , $preserveKeys true )

combine() public ¶

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

compile() public ¶

compile( $preserveKeys true )

contains() public ¶

contains( $value )

countBy() public ¶

countBy( $callback )

each() public ¶

each( callable $c )

every() public ¶

every( callable $c )

extract() public ¶

extract( $matcher )

filter() public ¶

filter( callable $c null )

Returns

Cake\Collection\Iterator\FilterIterator

first() public ¶

first( )

firstMatch() public ¶

firstMatch( array $conditions )

groupBy() public ¶

groupBy( $callback )

indexBy() public ¶

indexBy( $callback )

insert() public ¶

insert( $path , $values )

Returns

Cake\Collection\Iterator\InsertIterator

isEmpty() public ¶

isEmpty( )

jsonSerialize() public ¶

jsonSerialize( )

last() public ¶

last( )

listNested() public ¶

listNested( $dir 'desc' , $nestingKey 'children' )

Returns

Cake\Collection\Iterator\TreeIterator

map() public ¶

map( callable $c )

Returns

Cake\Collection\Iterator\ReplaceIterator

match() public ¶

match( array $conditions )

max() public ¶

max( $callback , $type SORT_NUMERIC )

median() public ¶

median( $matcher null )

min() public ¶

min( $callback , $type SORT_NUMERIC )

nest() public ¶

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

optimizeUnwrap() protected ¶

optimizeUnwrap( )

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

Returns

Traversable|array

reduce() public ¶

reduce( callable $c , $zero null )

reject() public ¶

reject( callable $c )

Returns

Cake\Collection\Iterator\FilterIterator

sample() public ¶

sample( $size 10 )

shuffle() public ¶

shuffle( )

skip() public ¶

skip( $howMany )

some() public ¶

some( callable $c )

sortBy() public ¶

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

stopWhen() public ¶

stopWhen( $condition )

Returns

Cake\Collection\Iterator\StoppableIterator

sumOf() public ¶

sumOf( $matcher null )

take() public ¶

take( $size 1 , $from 0 )

through() public ¶

through( callable $handler )

toArray() public ¶

toArray( $preserveKeys true )

toList() public ¶

toList( )

transpose() public ¶

transpose( )

Returns

Cake\Collection\CollectionInterface

unfold() public ¶

unfold( callable $transformer null )

unwrap() public ¶

unwrap( )

zip() public ¶

zip( $items )

zipWith() public ¶

zipWith( $items , $callable )

Namespaces

Classes

Class NoChildrenIterator

Method Summary

getChildren() public

hasChildren() public

Method Detail

getChildren() public ¶

Returns

Implementation of

hasChildren() public ¶

Returns

Implementation of

Methods inherited from Cake\Collection\Collection

__construct() public ¶

Parameters

Throws

Overrides

__debugInfo() public ¶

Returns

count() public ¶

Throws

serialize() public ¶

Returns

Implementation of

unserialize() public ¶

Parameters

Implementation of

Methods used from Cake\Collection\CollectionTrait

_unwrap() public ¶

append() public ¶

avg() public ¶

buffered() public ¶

Returns

cartesianProduct() public ¶

Returns

chunk() public ¶

chunkWithKeys() public ¶

combine() public ¶

compile() public ¶

contains() public ¶

countBy() public ¶

each() public ¶

every() public ¶

extract() public ¶

filter() public ¶

Returns

first() public ¶

firstMatch() public ¶

groupBy() public ¶

indexBy() public ¶

insert() public ¶

Returns

isEmpty() public ¶

jsonSerialize() public ¶

last() public ¶

listNested() public ¶

Returns

map() public ¶

Returns

match() public ¶

max() public ¶

median() public ¶

min() public ¶

nest() public ¶

optimizeUnwrap() protected ¶

Returns

reduce() public ¶

reject() public ¶

Returns

sample() public ¶

shuffle() public ¶

skip() public ¶

some() public ¶

sortBy() public ¶

stopWhen() public ¶

Returns

sumOf() public ¶

take() public ¶

through() public ¶