Дерево печатников
Итератор для сплющивания элементов в структуре дерева, добавляя визуальные маркеры для их относительного положения в дереве
- RecursiveIteratorIterator реализует Iterator, Traversable, OuterIterator
-
Cake\Collection\Iterator\TreePrinter использует Cake\Collection\CollectionTrait
Подробное описание метода
__constructsource 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() _fetchCurrentsource protected
_fetchCurrent( )
Возвращает текущий элемент итерации и кэширует его значение
Возвращает
mixedmixed
currentsource public
current( )
Возвращает текущее значение итерации
Возвращает
stringstring
Переопределяет
RecursiveIteratorIterator::current() keysource public
key( )
Возвращает текущий ключ итерации
Возвращает
mixedmixed
Переопределяет
RecursiveIteratorIterator::key() nextsource public
next( )
Перемещает курсор на одну позицию вперед
Переопределяет
RecursiveIteratorIterator::next() Методы, используемые из Cake\Collection\CollectionTrait
_unwrapsource public
_unwrap( )
Обратный совместимый оболочка для unwrap()
Устарело
Возвращает
Iterator\Iterator
appendsource public
append( mixed $items )
bufferedsource public
buffered( )
Возвращает
Cake\Collection\Iterator\BufferedIterator\Cake\Collection\Iterator\BufferedIterator
chunksource public
chunk( mixed $chunkSize )
combinesource public
combine( mixed $keyPath , mixed $valuePath , mixed $groupPath null )
compilesource public
compile( mixed $preserveKeys true )
containssource public
contains( mixed $value )
countBysource public
countBy( mixed $callback )
eachsource public
each( callable $c )
everysource public
every( callable $c )
extractsource public
extract( mixed $matcher )
filtersource public
filter( callable $c null )
Возвращает
Cake\Collection\Iterator\FilterIterator\Cake\Collection\Iterator\FilterIterator
firstsource public
first( )
firstMatchsource public
firstMatch( array $conditions )
groupBysource public
groupBy( mixed $callback )
indexBysource public
indexBy( mixed $callback )
insertsource public
insert( mixed $path , mixed $values )
Возвращает
Cake\Collection\Iterator\InsertIterator\Cake\Collection\Iterator\InsertIterator
isEmptysource public
isEmpty( )
jsonSerializesource public
jsonSerialize( )
lastsource public
last( )
listNestedsource public
listNested( mixed $dir 'desc' , mixed $nestingKey 'children' )
Возвращает
Cake\Collection\Iterator\TreeIterator\Cake\Collection\Iterator\TreeIterator
mapsource public
map( callable $c )
Возвращает
Cake\Collection\Iterator\ReplaceIterator\Cake\Collection\Iterator\ReplaceIterator
matchsource public
match( array $conditions )
maxsource public
max( mixed $callback , mixed $type SORT_NUMERIC )
minsource public
min( mixed $callback , mixed $type SORT_NUMERIC )
nestsource public
nest( mixed $idPath , mixed $parentPath )
reducesource public
reduce( callable $c , mixed $zero null )
rejectsource public
reject( callable $c )
Результат
Cake\Collection\Iterator\FilterIterator\Cake\Collection\Iterator\FilterIterator
samplesource public
sample( mixed $size 10 )
shufflesource public
shuffle( )
skipsource public
skip( mixed $howMany )
somesource public
some( callable $c )
sortBysource public
sortBy( mixed $callback , mixed $dir SORT_DESC , mixed $type SORT_NUMERIC )
stopWhensource public
stopWhen( mixed $condition )
Результат
Cake\Collection\Iterator\StoppableIterator\Cake\Collection\Iterator\StoppableIterator
sumOfsource public
sumOf( mixed $matcher null )
takesource public
take( mixed $size 1 , mixed $from 0 )
throughsource public
through( callable $handler )
toArraysource public
toArray( mixed $preserveKeys true )
toListsource public
toList( )
unfoldsource public
unfold( callable $transformer null )
unwrapsource public
unwrap( )
zipsource public
zip( mixed $items )
zipWithsource public
zipWith( mixed $items , mixed $callable )
Методы, используемые из Cake\Collection\ExtractTrait
_createMatcherFiltersource protected
_createMatcherFilter( array $conditions )
Возвращает вызываемый объект, который принимает значение и возвращает, соответствует ли оно определённому условию.
Параметры
- массив
$conditions - Список пар «ключ-значение» условий для соответствия, где ключ — путь к свойству для получения из текущего элемента, а значение — значение для сравнения с элементом.
Результат
callableвызываемый объект
_extractsource protected
_extract( array|ArrayAccess $data , array $path )
Возвращает столбец из $data, который можно извлечь, перебирая имена столбцов, содержащихся в $path. Он будет возвращать массивы для элементов, представленных с помощью {*}
Параметры
- массив|ArrayAccess
$data - Данные.
- массив
$path - Путь для извлечения.
Результат
mixedсмешанное
_propertyExtractorsource protected
_propertyExtractor( string|callable $callback )
Возвращает вызываемый объект, который можно использовать для извлечения свойства или столбца из массива или объекта на основе пути, разделённого точками.
Параметры
- строка|вызываемый объект
$callback - Путь к столбцу, разделённый точками, чтобы можно было вернуть конечный или вызываемый объект, который позаботится об этом.
Результат
callableвызываемый объект
_simpleExtractsource protected
_simpleExtract( array|ArrayAccess $data , array $path )
Возвращает столбец из $data, который можно извлечь, перебирая имена столбцов, содержащихся в $path
Параметры
- массив|ArrayAccess
$data - Данные.
- массив
$path - Путь для извлечения.
Результат
mixedсмешанное
Константы, унаследованные от RecursiveIteratorIterator
CATCH_GET_CHILD, CHILD_FIRST, LEAVES_ONLY, SELF_FIRST |
Резюме свойств
© 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.1/class-Cake.Collection.Iterator.TreePrinter.html