Класс TreeIterator

__construct()source public

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

Конструктор

Параметры

RecursiveIterator $items

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

целое число $mode необязательно Cake\Collection\Iterator\RecursiveIteratorIterator::SELF_FIRST

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

целое число $flags необязательно 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;
     });

Параметры

строка|вызываемая функция $valuePath

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

строка|вызываемая функция|null $keyPath необязательно null

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

строка $spacer необязательно '__'

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

Возвращает

Cake\Collection\Iterator\TreePrinter

_unwrap()source public

_unwrap( )

append()source public

append( $items )

appendItem()source public

appendItem( $item , $key = null )

avg()source public

avg( $matcher = null )

buffered()source public

buffered( )

Возвращает

Cake\Collection\Iterator\BufferedIterator

cartesianProduct()source public

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

Параметры

вызываемая функция $operation необязательно null

Операция

вызываемая функция $filter необязательно null

Фильтр

Возвращает

Cake\Collection\CollectionInterface

Исключения

LogicException

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 )

count()source public

count( )

Возвращает

целое число

countBy()source public

countBy( $callback )

countKeys()source public

countKeys( )

Возвращает

целое число

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

lazy()source public

lazy( )

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

newCollection()source protected

newCollection( ... $args )

Возвращает новую коллекцию.

Позволяет классам, использующим этот тред, определять собственный тип возвращаемого интерфейса коллекции

Параметры

... $args

$args Аргументы конструктора.

Возвращает

Cake\Collection\CollectionInterface

optimizeUnwrap()source protected

optimizeUnwrap( )

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

Возвращает

Traversable|массив

prepend()source public

prepend( $items )

prependItem()source public

prependItem( $item , $key = null )

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 )

takeLast()source public

takeLast( $howMany )

through()source public

through( callable $handler )

toArray()source public

toArray( $preserveKeys = true )

toList()source public

toList( )

transpose()source public

transpose( )

Возвращает

Cake\Collection\CollectionInterface

Исключение

LogicException

unfold()source public

unfold( callable $transformer = null )

unwrap()source public

unwrap( )

zip()source public

zip( $items )

zipWith()source public

zipWith( $items , $callable )