Class TreePrinter

Iterator for flattening elements in a tree structure while adding some visual markers for their relative position in the tree

RecursiveIteratorIterator implements Iterator, Traversable, OuterIterator

Cake\Collection\Iterator\TreePrinter uses Cake\Collection\CollectionTrait

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

Inherited Constants

CATCH_GET_CHILD, CHILD_FIRST, LEAVES_ONLY, SELF_FIRST

Properties summary

$_current protected

mixed

Cached value for the current iteration element
$_key protected

callable

A callable to generate the iteration key
$_spacer protected

string

The string to use for prefixing the values according to their depth in the tree.
$_value protected

callable

A callable to extract the display value

Method Summary

__construct() public

Constructor
_fetchCurrent() protected

Returns the current iteration element and caches its value
current() public

Returns the current iteration value
key() public

Returns the current iteration key
next() public

Advances the cursor one position

Method Detail

__construct() public ¶

__construct( RecursiveIterator $items , string|callable $valuePath , string|callable $keyPath , string $spacer , integer $mode Cake\Collection\Iterator\RecursiveIteratorIterator::SELF_FIRST )

Constructor

Parameters

RecursiveIterator $items: The iterator to flatten.
string|callable $valuePath: The property to extract or a callable to return the display value.
string|callable $keyPath: The property to use as iteration key or a callable returning the key value.
string $spacer: The string to use for prefixing the values according to their depth in the tree.
integer $mode optional Cake\Collection\Iterator\RecursiveIteratorIterator::SELF_FIRST: Iterator mode.

Overrides

RecursiveIteratorIterator::__construct()

_fetchCurrent() protected ¶

_fetchCurrent( )

Returns the current iteration element and caches its value

Returns

mixed

current() public ¶

current( )

Returns the current iteration value

Returns

string

Overrides

RecursiveIteratorIterator::current()

key() public ¶

key( )

Returns the current iteration key

Returns

mixed

Overrides

RecursiveIteratorIterator::key()

next() public ¶

next( )

Advances the cursor one position

Overrides

RecursiveIteratorIterator::next()

Methods used from Cake\Collection\CollectionTrait

_unwrap() public ¶

_unwrap( )

append() public ¶

append( $items )

appendItem() public ¶

appendItem( $item , $key null )

avg() public ¶

avg( $matcher null )

buffered() public ¶

buffered( )

Returns

Cake\Collection\Iterator\BufferedIterator

cartesianProduct() public ¶

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

Parameters

callable $operation optional null: Operation
callable $filter optional null: Filter

Returns

Cake\Collection\CollectionInterface

Throws

LogicException

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 )

count() public ¶

count( )

Returns

integer

countBy() public ¶

countBy( $callback )

countKeys() public ¶

countKeys( )

Returns

integer

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( )

lazy() public ¶

lazy( )

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

prepend() public ¶

prepend( $items )

prependItem() public ¶

prependItem( $item , $key null )

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 )

takeLast() public ¶

takeLast( $howMany )

through() public ¶

through( callable $handler )

toArray() public ¶

toArray( $preserveKeys true )

toList() public ¶

toList( )

transpose() public ¶

transpose( )

Returns

Cake\Collection\CollectionInterface

Throws

LogicException

unfold() public ¶

unfold( callable $transformer null )

unwrap() public ¶

unwrap( )

zip() public ¶

zip( $items )

zipWith() public ¶

zipWith( $items , $callable )

Properties detail

`$_current` ¶

protected mixed

Cached value for the current iteration element

`$_key` ¶

protected callable

A callable to generate the iteration key

`$_spacer` ¶

protected string

The string to use for prefixing the values according to their depth in the tree.

`$_value` ¶

protected callable

A callable to extract the display value

Namespaces

Classes

Class TreePrinter

Inherited Constants

Properties summary

Method Summary

__construct() public

_fetchCurrent() protected

current() public

key() public

next() public

Method Detail

__construct() public ¶

Parameters

Overrides

_fetchCurrent() protected ¶

Returns

current() public ¶

Returns

Overrides

key() public ¶

Returns

Overrides

next() public ¶

Overrides

Methods used from Cake\Collection\CollectionTrait

_unwrap() public ¶

append() public ¶

appendItem() public ¶

avg() public ¶

buffered() public ¶

Returns

cartesianProduct() public ¶

Parameters

Returns

Throws

chunk() public ¶

chunkWithKeys() public ¶

combine() public ¶

compile() public ¶

contains() public ¶

count() public ¶

Returns

countBy() public ¶

countKeys() public ¶

Returns

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 ¶

lazy() public ¶

listNested() public ¶

Returns

map() public ¶

Returns

match() public ¶

max() public ¶

median() public ¶

min() public ¶

nest() public ¶

optimizeUnwrap() protected ¶

Returns

prepend() public ¶

prependItem() public ¶

reduce() public ¶

reject() public ¶

Returns

sample() public ¶

shuffle() public ¶

skip() public ¶

`$_current` ¶

`$_key` ¶

`$_spacer` ¶

`$_value` ¶