Класс TreePrinter
Итератор для сплющивания элементов в структуре дерева, добавляя визуальные метки для их относительного положения в дереве
- RecursiveIteratorIterator реализует Iterator, Traversable, OuterIterator
-
Cake\Collection\Iterator\TreePrinter использует Cake\Collection\CollectionTrait
Унаследованные константы
-
CATCH_GET_CHILD,CHILD_FIRST,LEAVES_ONLY,SELF_FIRST
Краткое описание свойств
-
$_currentprotectedКэшированное значение для текущего элемента итерацииmixed -
$_keyprotectedВызываемый объект для генерации ключа итерацииcallable -
$_spacerprotectedСтрока, используемая для префикса значений в соответствии с их глубиной в дереве.string -
$_valueprotectedВызываемый объект для извлечения отображаемого значенияcallable
Краткое описание методов
- __construct() publicКонструктор
- _fetchCurrent() protectedВозвращает текущий элемент итерации и кэширует его значение
- current() publicВозвращает текущее значение итерации
- key() publicВозвращает текущий ключ итерации
- next() publicПеремещает курсор на одну позицию вперёд
Подробное описание методов
__construct()source public
__construct( RecursiveIterator $items , string|callable $valuePath , string|callable $keyPath , string $spacer , integer $mode Cake\Collection\Iterator\RecursiveIteratorIterator::SELF_FIRST )
Конструктор
Параметры
- RecursiveIterator
$items - Итератор для сплющивания.
- string|callable
$valuePath Свойство для извлечения или вызываемый объект для возвращения отображаемого значения.
- string|callable
$keyPath Свойство для использования в качестве ключа итерации или вызываемый объект, возвращающий значение ключа.
- string
$spacer Строка, используемая для префикса значений в соответствии с их глубиной в дереве.
- integer
$modeoptional Cake\Collection\Iterator\RecursiveIteratorIterator::SELF_FIRST - Режим итерации.
Переопределяет
RecursiveIteratorIterator::__construct() _fetchCurrent()source protected
_fetchCurrent( )
Возвращает текущий элемент итерации и кэширует его значение
Возвращает
mixedcurrent()source public
current( )
Возвращает текущее значение итерации
Возвращает
stringПереопределяет
RecursiveIteratorIterator::current() key()source public
key( )
Возвращает текущий ключ итерации
Возвращает
mixedПереопределяет
RecursiveIteratorIterator::key() next()source public
next( )
Перемещает курсор на одну позицию вперёд
Переопределяет
RecursiveIteratorIterator::next() Используемые методы из Cake\Collection\CollectionTrait
_unwrap()source public
_unwrap( )
Обработчик совместимости с предыдущими версиями для unwrap()
Устарело
Возвращает
Iteratorappend()source public
append( $items )
chunk()source public
chunk( $chunkSize )
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 )
first()source public
first( )
firstMatch()source public
firstMatch( array $conditions )
groupBy()source public
groupBy( $callback )
indexBy()source public
indexBy( $callback )
isEmpty()source public
isEmpty( )
jsonSerialize()source public
jsonSerialize( )
last()source public
last( )
listNested()source public
listNested( $dir 'desc' , $nestingKey 'children' )
Результат
Cake\Collection\Iterator\TreeIteratormatch()source public
match( array $conditions )
max()source public
max( $callback , $type SORT_NUMERIC )
min()source public
min( $callback , $type SORT_NUMERIC )
nest()source public
nest( $idPath , $parentPath )
reduce()source public
reduce( callable $c , $zero null )
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 )
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( )
unfold()source public
unfold( callable $transformer null )
unwrap()source public
unwrap( )
zip()source public
zip( $items )
zipWith()source public
zipWith( $items , $callable )
Подробное описание свойств
$_spacersource
protected string
Строка, используемая для префикса значений в соответствии с их глубиной в дереве.
© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/3.2/class-Cake.Collection.Iterator.TreePrinter.html