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

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

Итератор древовидного списка с orm-узлами

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

 __construct (TreeList $api, $parent_id=0)
 
 getPathFromRoot ($node_id)
 
 getPreLoader ()
 
 setPreLoader (TreeListOrmPreLoader $pre_loader)
 
 getApi ()
 
- Открытые члены унаследованные от AbstractTreeListIterator
 getItems ()
 
 current ()
 
 next ()
 
 key ()
 
 valid ()
 
 rewind ()
 
 offsetExists ($offset)
 
 offsetGet ($offset)
 
 offsetSet ($offset, $value)
 
 offsetUnset ($offset)
 
 count ()
 
 getPathFromRoot ($node_id)
 
 getFirstElements ()
 
 setFirstElements (array $first_elements)
 

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

 getSelfItems ()
 
 getClonedQueryObj ()
 
 setApi ($api)
 
 getParentId ()
 
 setParentId ($parent_id)
 
- Защищенные члены унаследованные от AbstractTreeListIterator
 loadList ()
 
 getSelfItems ()
 
 unsetList ()
 

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

 $api
 
 $parent_id
 
 $pre_loader
 
- Защищенные данные унаследованные от AbstractTreeListIterator
 $items = null
 
 $first_elements = []
 

Дополнительные унаследованные члены

- Поля данных унаследованные от AbstractTreeListIterator
const ATTRIBUTE_MULTIPLE = 'multiple'
 
const ATTRIBUTE_DISALLOW_SELECT_BRANCHES = 'disallowSelectBranches'
 

Конструктор(ы)

__construct ( TreeList  $api,
  $parent_id = 0 
)

TreeListIterator constructor.

Аргументы
TreeList$api- api для выборки объектов
int$parent_id- id родительского узла

Методы

getApi ( )

Возвращает объект api

Возвращает
TreeList
getClonedQueryObj ( )
protected

Возвращает копию api для сохранения установленных фильтров

Возвращает
OrmRequest
getParentId ( )
protected

Возвращает id родительского узла

Возвращает
int
getPathFromRoot (   $node_id)

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

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

Возвращает объект предворительной загрузки

Возвращает
TreeListOrmPreLoader|null
getSelfItems ( )
protected

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

Возвращает
TreeListOrmNode[]
setApi (   $api)
protected

Устанавливает объект api

Аргументы
TreeList$api- объект api
Возвращает
void
setParentId (   $parent_id)
protected

Устанавливает id родительского узла

Аргументы
int$parent_id- id родительского узла
Возвращает
void
setPreLoader ( TreeListOrmPreLoader  $pre_loader)

Устанавливает объект предворительной загрузки

Аргументы
TreeListOrmPreLoader$pre_loader
Возвращает
void

Поля

$api
protected
$parent_id
protected
$pre_loader
protected