Класс TreeIterator

__construct()source public

__construct( RecursiveIterator $items , integer $mode Cake\Collection\Iterator\RecursiveIteratorIterator::SELF_FIRST , integer $flags 0 )

Конструктор

Параметры

RecursiveIterator $items

Итератор для сплющивания.

integer $mode optional Cake\Collection\Iterator\RecursiveIteratorIterator::SELF_FIRST

Режим итератора.

integer $flags optional 0

Флаги итератора.

Переопределяет

RecursiveIteratorIterator::__construct()

printer()source public

printer( string|callable $valuePath , string|callable|null $keyPath null , string $spacer '__' )

Возвращает другой итератор, который вернёт значения, готовые для отображения пользователю. Это делается путем извлечения одного свойства из каждого элемента и добавления его префикса пробелом, чтобы можно было визуализировать относительное положение в дереве.

Как $valuePath, так и $keyPath могут быть строкой с именем свойства для извлечения или точкой, разделённой путём свойств, которым нужно следовать, чтобы получить последнее в пути.

Кроме того, $valuePath и $keyPath могут быть вызываемыми функциями. Они получат текущий элемент в качестве первого параметра, текущий ключ итерации - как второй параметр, и экземпляр итератора - как третий аргумент.

Пример

$printer = (new Collection($treeStructure))->listNested()->printer('name');

Использование замыкания:

$printer = (new Collection($treeStructure))
     ->listNested()
     ->printer(function ($item, $key, $iterator) {
         return $item->name;
     });

Параметры

string|callable $valuePath

Свойство для извлечения или вызываемая функция для возвращения значения отображения

string|callable|null $keyPath optional null

Свойство, используемое в качестве ключа итерации, или вызываемая функция, возвращающая значение ключа.

string $spacer optional '__'

Строка, используемая для добавления префикса к значениям в соответствии с их глубиной в дереве

Возвращает

Cake\Collection\Iterator\TreePrinter

_unwrap()source public

_unwrap( )

append()source public

append( $items )

avg()source public

avg( $matcher null )

buffered()source public

buffered( )

Возвращает

Cake\Collection\Iterator\BufferedIterator

cartesianProduct()source public

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

Возвращает

Cake\Collection\CollectionInterface

chunk()source public

chunk( $chunkSize )

chunkWithKeys()source public

chunkWithKeys( $chunkSize , $preserveKeys true )

combine()source public

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

compile()source public

compile( $preserveKeys true )

contains()source public

contains( $value )

countBy()source public

countBy( $callback )

each()source public

each( callable $c )

every()source public

every( callable $c )

extract()source public

extract( $matcher )

filter()source public

filter( callable $c null )

Возвращает

Cake\Collection\Iterator\FilterIterator

first()source public

first( )

firstMatch()source public

firstMatch( array $conditions )

groupBy()source public

groupBy( $callback )

indexBy()source public

indexBy( $callback )

insert()source public

insert( $path , $values )

Возвращает

Cake\Collection\Iterator\InsertIterator

isEmpty()source public

isEmpty( )

jsonSerialize()source public

jsonSerialize( )

last()source public

last( )

listNested()source public

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

Возвращает

Cake\Collection\Iterator\TreeIterator

map()source public

map( callable $c )

Возвращает

Cake\Collection\Iterator\ReplaceIterator

match()source public

match( array $conditions )

max()source public

max( $callback , $type SORT_NUMERIC )

median()source public

median( $matcher null )

min()source public

min( $callback , $type SORT_NUMERIC )

nest()source public

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

optimizeUnwrap()source protected

optimizeUnwrap( )

Распаковывает этот итератор и возвращает самый простой перебираемый объект, который можно использовать для извлечения данных

Возвращает

Traversable|массив

reduce()source public

reduce( callable $c , $zero null )

reject()source public

reject( callable $c )

Возвращает

Cake\Collection\Iterator\FilterIterator

sample()source public

sample( $size 10 )

shuffle()source public

shuffle( )

skip()source public

skip( $howMany )

some()source public

some( callable $c )

sortBy()source public

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

stopWhen()source public

stopWhen( $condition )

Возвращает

Cake\Collection\Iterator\StoppableIterator

sumOf()source public

sumOf( $matcher null )

take()source public

take( $size 1 , $from 0 )

through()source public

through( callable $handler )

toArray()source public

toArray( $preserveKeys true )

toList()source public

toList( )

transpose()source public

transpose( )

Возвращает

Cake\Collection\CollectionInterface

unfold()source public

unfold( callable $transformer null )

unwrap()source public

unwrap( )

zip()source public

zip( $items )

zipWith()source public

zipWith( $items , $callable )