Класс 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
$modeнеобязательно 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( )
append()source public
append( $items )
appendItem()source public
appendItem( $item , $key = null )
avg()source public
avg( $matcher = null )
cartesianProduct()source public
cartesianProduct( callable $operation = null , callable $filter = null )
Параметры
- callable
$operationнеобязательно null - Операция
- callable
$filterнеобязательно null - Фильтр
Возвращает
Cake\Collection\CollectionInterfaceВызывает
LogicExceptionchunk()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\FilterIteratorfirst()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( )
lazy()source public
lazy( )
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 )
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\CollectionInterfaceoptimizeUnwrap()source protected
optimizeUnwrap( )
Разворачивает этот итератор и возвращает самый простой перебираемый объект, который может использоваться для получения данных.
Возвращает
Traversable|массивprepend()source public
prepend( $items )
prependItem()source public
prependItem( $item , $key = null )
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 )
stopWhen()source public
stopWhen( $condition )
Возвращает
Cake\Collection\Iterator\StoppableIteratorsumOf()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Исключения
LogicExceptionunfold()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–present 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.
https://api.cakephp.org/3.8/class-Cake.Collection.Iterator.TreePrinter.html