\Cake\Collection\IteratorNoChildrenIterator

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.

Summary

Methods

Properties

Constants

__construct()
serialize()
unserialize()
count()
countKeys()
__debugInfo()
each()
filter()
reject()
every()
some()
contains()
map()
reduce()
extract()
max()
min()
avg()
median()
sortBy()
groupBy()
indexBy()
countBy()
sumOf()
shuffle()
sample()
take()
skip()
match()
firstMatch()
first()
last()
takeLast()
append()
appendItem()
prepend()
prependItem()
combine()
nest()
insert()
toArray()
toList()
jsonSerialize()
compile()
lazy()
buffered()
listNested()
stopWhen()
unfold()
through()
zip()
zipWith()
chunk()
chunkWithKeys()
isEmpty()
unwrap()
_unwrap()
cartesianProduct()
transpose()
hasChildren()
getChildren()

No public properties found

No constants found

optimizeUnwrap()

No protected properties found

N/A

No private methods found

No private properties found

N/A

File: vendor/cakephp/cakephp/src/Collection/Iterator/NoChildrenIterator.php
Package: Default
Class hierarchy: \IteratorIterator

\Cake\Collection\Collection

\Cake\Collection\Iterator\NoChildrenIterator
Implements

Methods

__construct()

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

serialize()

serialize() : string

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

Returns

string

unserialize()

unserialize(string  $collection) : void

Unserializes the passed string and rebuilds the Collection instance

Parameters

string

$collection

The serialized collection

count()

count() : integer

{@inheritDoc}

Returns

integer

countKeys()

countKeys() : integer

{@inheritDoc}

Returns

integer

__debugInfo()

__debugInfo() : array

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

Returns

array

each()

each(callable  $c)

{@inheritDoc}

Parameters

callable

filter()

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

{@inheritDoc}

Parameters

callable

Returns

\Cake\Collection\Iterator\FilterIterator

reject()

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

{@inheritDoc}

\Cake\Collection\Iterator\ReplaceIterator

reduce()

reduce(callable  $c,   $zero = null)

{@inheritDoc}

Parameters

callable	$c
	$zero

extract()

extract(  $matcher)

{@inheritDoc}

Parameters

$matcher

max()

max(  $callback,   $type = \SORT_NUMERIC)

{@inheritDoc}

Parameters

	$callback
	$type

min()

min(  $callback,   $type = \SORT_NUMERIC)

{@inheritDoc}

Parameters

	$callback
	$type

avg()

avg(  $matcher = null)

{@inheritDoc}

Parameters

$matcher

median()

median(  $matcher = null)

{@inheritDoc}

Parameters

$matcher

sortBy()

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

{@inheritDoc}

Parameters

	$callback
	$dir
	$type

groupBy()

groupBy(  $callback)

{@inheritDoc}

Parameters

$callback

indexBy()

indexBy(  $callback)

{@inheritDoc}

Parameters

$callback

countBy()

countBy(  $callback)

{@inheritDoc}

Parameters

$callback

sumOf()

sumOf(  $matcher = null)

{@inheritDoc}

Parameters

$matcher

shuffle()

shuffle()

{@inheritDoc}

sample()

sample(  $size = 10)

{@inheritDoc}

Parameters

$size

take()

take(  $size = 1,   $from)

{@inheritDoc}

Parameters

	$size
	$from

skip()

skip(  $howMany)

{@inheritDoc}

Parameters

$howMany

match()

match(array  $conditions)

{@inheritDoc}

Parameters

array

$conditions

firstMatch()

firstMatch(array  $conditions)

{@inheritDoc}

Parameters

array

$conditions

first()

first()

{@inheritDoc}

last()

last()

{@inheritDoc}

takeLast()

takeLast(  $howMany)

{@inheritDoc}

Parameters

$howMany

append()

append(  $items)

{@inheritDoc}

Parameters

$items

appendItem()

appendItem(  $item,   $key = null)

{@inheritDoc}

Parameters

	$item
	$key

prepend()

prepend(  $items)

{@inheritDoc}

Parameters

$items

prependItem()

prependItem(  $item,   $key = null)

{@inheritDoc}

Parameters

	$item
	$key

combine()

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

{@inheritDoc}

Parameters

	$keyPath
	$valuePath
	$groupPath

nest()

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

{@inheritDoc}

Parameters

	$idPath
	$parentPath
	$nestingKey

insert()

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

{@inheritDoc}

Parameters

	$path
	$values

Returns

\Cake\Collection\Iterator\InsertIterator

toArray()

toArray(  $preserveKeys = true)

{@inheritDoc}

Parameters

$preserveKeys

toList()

toList()

{@inheritDoc}

jsonSerialize()

jsonSerialize()

{@inheritDoc}

compile()

compile(  $preserveKeys = true)

{@inheritDoc}

Parameters

$preserveKeys

lazy()

lazy()

{@inheritDoc}

buffered()

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

{@inheritDoc}

Returns

\Cake\Collection\Iterator\BufferedIterator

listNested()

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

{@inheritDoc}

Parameters

	$dir
	$nestingKey

Returns

\Cake\Collection\Iterator\TreeIterator

stopWhen()

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

{@inheritDoc}

Parameters

$condition

Returns

\Cake\Collection\Iterator\StoppableIterator

unfold()

unfold(callable  $transformer = null)

{@inheritDoc}

Parameters

callable

$transformer

through()

through(callable  $handler)

{@inheritDoc}

Parameters

callable

$handler

zip()

zip(  $items)

{@inheritDoc}

Parameters

$items

zipWith()

zipWith(  $items,   $callable)

{@inheritDoc}

Parameters

	$items
	$callable

chunk()

chunk(  $chunkSize)

{@inheritDoc}

Parameters

$chunkSize

chunkWithKeys()

chunkWithKeys(  $chunkSize,   $preserveKeys = true)

{@inheritDoc}

Parameters

	$chunkSize
	$preserveKeys

isEmpty()

isEmpty()

{@inheritDoc}

unwrap()

unwrap()

{@inheritDoc}

_unwrap()

_unwrap()

cartesianProduct()

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

Parameters

callable\|null	$operation	Operation
callable\|null	$filter	Filter

Throws

\LogicException

Returns

\Cake\Collection\CollectionInterface

transpose()

transpose() : \Cake\Collection\CollectionInterface

{@inheritDoc}

Throws

\LogicException

Returns

\Cake\Collection\CollectionInterface

hasChildren()

hasChildren() : boolean

Returns false as there are no children iterators in this collection

Returns

boolean

getChildren()

getChildren() : null

Returns null as there are no children for this iteration level

Returns

null

optimizeUnwrap()

optimizeUnwrap() : \Traversable|array

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

Returns

\Traversable|array