Версия: 6.x
burger close
Класс AbstractTreeListIterator
Граф наследования:AbstractTreeListIterator:
TreeListCategoryOrmIterator TreeListEmptyIterator TreeListFakeIterator TreeListOrmIterator

Подробное описание

Абстрактный итератор древовидного списка

Открытые члены

 getItems ()
 
 current ()
 
 next ()
 
 key ()
 
 valid ()
 
 rewind ()
 
 offsetExists ($offset)
 
 offsetGet ($offset)
 
 offsetSet ($offset, $value)
 
 offsetUnset ($offset)
 
 count ()
 
 getPathFromRoot ($node_id)
 
 getFirstElements ()
 
 setFirstElements (array $first_elements)
 

Поля данных

const ATTRIBUTE_MULTIPLE = 'multiple'
 
const ATTRIBUTE_DISALLOW_SELECT_BRANCHES = 'disallowSelectBranches'
 

Защищенные члены

 loadList ()
 
 getSelfItems ()
 
 unsetList ()
 

Защищенные данные

 $items = null
 
 $first_elements = []
 

Методы

count ( )
final

Возвращает количество элементов

Возвращает
int
current ( )
final

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

Возвращает
AbstractTreeListNode
getFirstElements ( )

Возвращает список узлов, которые будет добавлен в начало списка дочерних элементов

Возвращает
AbstractTreeListNode[]
getItems ( )
final

Возвращает список элементов

Возвращает
AbstractTreeListNode[]
getPathFromRoot (   $node_id)
abstract

Возвращает список узлов, составляющих путь к указанному элементу от корня

Аргументы
string | int$node_id- идентификатор целевого узла
Возвращает
AbstractTreeListNode[]
getSelfItems ( )
abstractprotected

Возвращает список дочерних элементов

Возвращает
AbstractTreeListNode[]
key ( )
final

Возвращает ключ текущего элемента

Возвращает
int|null
loadList ( )
finalprotected

Формирует итоговый список дочерних элементов

Возвращает
void
next ( )
final

Перемещает указатель на следуйщий элемент

Возвращает
void
offsetExists (   $offset)
final

Проверяет наличие значения по ключу

Аргументы
mixed$offset- ключ
Возвращает
bool
offsetGet (   $offset)
final

Возвращает значение по ключу

Аргументы
mixed$offset- ключ
Возвращает
AbstractTreeListNode|null
offsetSet (   $offset,
  $value 
)
final

Устанавливает значение по ключу

Аргументы
mixed$offset- ключ
AbstractTreeListNode$value- значение
Возвращает
void
Исключения
Exception
offsetUnset (   $offset)
final

Удаляет значение по ключу

Аргументы
mixed$offset- ключ
Возвращает
void
rewind ( )
final

Перемещает указатель на первый элемент

Возвращает
void
setFirstElements ( array  $first_elements)

Устанавливает список узлов, которые будет добавлен в начало списка дочерних элементов

Аргументы
AbstractTreeListNode[]$first_elements - узлы, которые будет добавлен в начало списка детей
Возвращает
void
Исключения
Exception
unsetList ( )
finalprotected

Очищает список дочерних элементов

Возвращает
void
valid ( )
final

Проверяет корректность текущей позиции

Возвращает
bool

Поля

$first_elements = []
protected
$items = null
protected
const ATTRIBUTE_DISALLOW_SELECT_BRANCHES = 'disallowSelectBranches'
const ATTRIBUTE_MULTIPLE = 'multiple'