Spec-Zone.ru › CakePHP 3.8

Класс TreePrinter

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

RecursiveIteratorIterator реализует Iterator, Traversable, OuterIterator
Расширен Cake\Collection\Iterator\TreePrinter использует Cake\Collection\CollectionTrait
Пространство имён: Cake\Collection\Iterator
Расположение: Collection/Iterator/TreePrinter.php

Унаследованные константы

  • CATCH_GET_CHILD, CHILD_FIRST, LEAVES_ONLY, SELF_FIRST

Резюме свойств

  • $_current protected
    mixed
    Кэшированное значение для текущего элемента итерации
  • $_key protected
    callable
    Вызываемый объект для генерации ключа итерации
  • $_spacer protected
    string
    Строка, используемая для добавления префикса к значениям в зависимости от их глубины в дереве.
  • $_value protected
    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( )

Возвращает текущий элемент итерации и кэширует его значение

Возвращает

mixed

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

buffered()source public

buffered( )

Возвращает

Cake\Collection\Iterator\BufferedIterator

cartesianProduct()source public

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

Параметры

callable $operation необязательно null
Операция
callable $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( )

Возвращает

integer

countBy()source public

countBy( $callback )

countKeys()source public

countKeys( )

Возвращает

integer

each()source public

each( callable $c )

every()source public

every( callable $c )
END_OF_DOCUMENT_MARKER

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 )

Подробное описание свойств

$_currentsource

protected mixed

Кэшированное значение для текущего элемента итерации

$_keysource

protected callable

Вызов для генерации ключа итерации

$_spacersource

protected string

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

$_valuesource

protected callable

Вызов для извлечения отображаемого значения

© 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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API