Версия: 5.x
Класс TreeList
Граф наследования:TreeList:
EntityList BaseModel TreeCookieList RegionApi AffiliateApi CatApi DirApi Api UserStatusApi

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

Класс для работы с древовидными списками. (с полной загрузкой списка в массив)

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

 setParentField ($field)
 
 getParentField ()
 
 getPathToFirst ($id, $cache=true)
 
 getParentIds ($ids, $cache=true)
 
 getByAlias ($alias, $parent=null)
 
 getTreeList ($parent_id=0, array $first_elements=array())
 
 getSelectList ($parent_id=0, array $first=array())
 
 del (array $ids)
 
 queryParents ($id)
 
 queryGetChilds ($parent_id, $order=null)
 
 moveElement ($from, $to, $flag, OrmRequest $extra_expr=null, $new_parent_id=null)
 
 multiEditCheck ($element, $post, $ids)
 
 addFilterControl (FilterControl $filter_control)
 
 isEnableTreePreload ()
 
 setEnableTreePreload ($enable_tree_preload)
 
- Открытые члены унаследованные от EntityList
 __construct (AbstractObject $orm_element, array $options=array())
 
 setDefaultOrder ($order)
 
 getNameField ()
 
 setNameField ($field)
 
 setAliasField ($field)
 
 setSortField ($field)
 
 setIdField ($field)
 
 getIdField ()
 
 getSiteIdField ()
 
 setLoadOnDelete ($bool)
 
 setSiteContext ($site_id=null)
 
 getSiteContext ()
 
 setMultisite ($bool)
 
 isMultisite ()
 
 resetQueryObject ()
 
 getCleanQueryObject ()
 
 queryObj ()
 
 setQueryObj (\RS\Orm\Request $q)
 
 defAlias ()
 
 setFilter ($key, $value=null, $type= '=', $prefix= 'AND', array $options=array())
 
 clearFilter ()
 
 getList ($page=null, $page_size=null, $order=null)
 
 getListAsArray ($page=0, $page_size=0, $order= '')
 
 getListAsResource ($page=0, $page_size=0, $order= '')
 
 getPagedList ($page_size)
 
 loadAssocList ($key_field, $value=null)
 
 getAssocList ($key_field, $value=null)
 
 setOrder ($order=null, array $values=null)
 
 setGroup ($group=null)
 
 getListCount ()
 
 getFirst ($order= '')
 
 getOneItem ($id)
 
 getById ($id)
 
 getElement ()
 
 setElement ($object)
 
 getElementClass ()
 
 getNewElement ()
 
 save ($id=null, array $user_post=array())
 
 addFilterControl (\RS\Html\Filter\Control $filter_control)
 
 addTableControl (\RS\Html\Table\Control $table_control)
 
 del (array $ids)
 
 multiDelete ($ids)
 
 getSelectList ($first=array())
 
 multieditFormView ($tpl_path, $formfile, array $addparam=array())
 
 multiUpdate (array $data, $ids=array())
 
 moveElement ($from, $to, $flag,\RS\Orm\Request $extra_expr=null)
 
 noWriteRights ($right=DefaultModuleRights::RIGHT_UPDATE)
 
 getIdByAlias ($alias_or_id, $alias_field=null)
 
 saveRequest ($key)
 
 getIdsByRequest (\RS\Orm\Request $request)
 
- Открытые члены унаследованные от BaseModel
 addError ($message, $fieldname=null, $form=null)
 
 hasError ()
 
 getErrors ()
 
 cleanErrors ()
 
 getDisplayErrors ()
 
 getErrorsStr ()
 
 getFormErrors ($form, $separator= ', ')
 
 getNonFormErrors ($separator= ', ')
 
 exportErrors ()
 
 importErrors ($data)
 

Открытые статические члены

static staticTreeList ($parent_id=0, $first_elements=array())
 
static staticSelectList ($parent_id=0, $first=array())
 
static FindSubFolder (array $list)
 
static getChildsId ($ids)
 
- Открытые статические члены унаследованные от EntityList
static getInstance ($key= 'default')
 
static staticSelectList ($first=array())
 
static getSavedRequest ($key, $default=null)
 

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

 getAllParentIdsArray ($cache=true)
 
 getFakeNodesFromStringArray ($items)
 
 recursiveConvertTreeToSelectList (array $tree, $parent_id, $level=0)
 
- Защищенные члены унаследованные от EntityList
 parseArrayFilter ($filters)
 
 filterLike ($key, $value, $type, $prefix, $options)
 
 filterIs ($key, $value, $type, $prefix, $options)
 
 filterFullText ($key, $value, $type, $prefix, $options)
 
 filterIn ($key, $value, $type, $prefix, $options)
 
 filterNotin ($key, $value, $type, $prefix, $options)
 
 filterDefault ($key, $value, $type, $prefix, $options)
 
 setPage ($page, $pageSize)
 
 moveArrayUp ($arr)
 
 moveArrayDown ($arr)
 

Защищенные статические члены

static recursiveGetChildIdsFromTree (array $tree, $id)
 

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

 $parent_field
 
 $enable_tree_preload = true
 
- Защищенные данные унаследованные от EntityList
 $default_order
 
 $load_on_delete = false
 
 $id_field = 'id'
 
 $alias_field
 
 $sort_field
 
 $name_field
 
 $site_id_field = 'site_id'
 
 $is_multisite = false
 
 $site_context
 
 $def_table_alias = 'A'
 
 $obj
 
 $obj_instance
 
 $filter_active = false
 
 $multiedit_template = '%system%/coreobject/multiedit_form.tpl'
 
 $assocPlainList = array()
 
 $parsePrefixes = array('&' => 'AND', '|' => 'OR', '' => '')
 
 $q
 
- Защищенные данные унаследованные от BaseModel
 $default_error_fieldname = 'Информация'
 

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

- Поля данных унаследованные от EntityList
const WHERE_CONDITION_VAR = 'where_conditions'
 
- Поля данных унаследованные от BaseModel
 $form_fieldname = array()
 
 $errors_by_form = array()
 
 $errors_non_form = array()
 
 $errors = array()
 
- Статические защищенные данные унаследованные от EntityList
static $instance = []
 

Методы

addFilterControl ( FilterControl  $filter_control)

Устанавливает фильтры, от компонента

Аргументы
FilterControl$filter_control- объект фильтра
Возвращает
EntityList
Исключения
DbException
del ( array  $ids)

Удаляет список объектов по id, включая дочерние элементы

Аргументы
array$ids- массив ID объектов
Возвращает
bool
Исключения
DbException
RSException
static FindSubFolder ( array  $list)
static
Аргументы
string[]|int[]$list - список ID элементов, для которых необходимо найти дочерние ID
Возвращает
string[]|int[]
Исключения
DbException
RSException
getAllParentIdsArray (   $cache = true)
protected

Возвращает массив [ID => ID родителя] для всех элементов

Аргументы
bool$cacheЕсли true, то будет использован кэш
Возвращает
array
getByAlias (   $alias,
  $parent = null 
)

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

Аргументы
string$alias- псевдоним
int | string$parent- ID родителя, если уникальность псевдонима в рамках родительского элемента
Возвращает
AbstractObject|false
Исключения
OrmException
DbException
static getChildsId (   $ids)
static

Дополняет список идентификаторами всех дочерних элементов

Аргументы
int|string|int[]|string[]$ids - список ID элементов, для которых необходимо найти дочерние ID
Возвращает
int[]|string[]
Исключения
DbException
RSException
getFakeNodesFromStringArray (   $items)
protected

Возвращает список фейковых узлов на основе списка названий

Аргументы
string[]$items - список названий
Возвращает
TreeListFakeNode[]
getParentField ( )

Возвращает поле, в котором хранится ссылка на ID родителя записи

Возвращает
string
getParentIds (   $ids,
  $cache = true 
)

Дополняет список идентификаторами родительских элементов

Аргументы
int|string|int[]|string[]$ids Список ID элементов
bool$cacheЕсли true, то будет использован локальный статический кэш
Возвращает
int[]|string[]
getPathToFirst (   $id,
  $cache = true 
)

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

Аргументы
int | string$id- id текущего элемента
bool$cacheЕсли true, то будет использован локальный статический кэш
Возвращает
AbstractObject[]
getSelectList (   $parent_id = 0,
array  $first = array() 
)
Аргументы
int$parent_id- id корневого элемента дерева
string[]$first - значения, которые нужно добавить в начало списка
Возвращает
string[]
Исключения
DbException
getTreeList (   $parent_id = 0,
array  $first_elements = array() 
)

Возвращает дерево элементов

Аргументы
int$parent_id- id родительского узла
AbstractTreeListNode[]$first_elements - узлы, которые нужно добавить в начало списка
Возвращает
TreeListOrmIterator
Исключения
RSException
isEnableTreePreload ( )

Возвращает разрешена ли предварительная загрузка дерева элементов

Возвращает
bool
moveElement (   $from,
  $to,
  $flag,
OrmRequest  $extra_expr = null,
  $new_parent_id = null 
)

Перемещает элемент from на место элемента to. Если flag = 'up', то до элемента to, иначе после

Аргументы
int$from- id элемента, который переносится
int$to- id ближайшего элемента, возле которого должен располагаться элемент
string$flag- up или down - флаг выше или ниже элемента $to должен располагаться элемент $from
OrmRequest$extra_expr- объект с установленными уточняющими условиями, для выборки объектов сортировки
int$new_parent_id- новый ID родительского элемента
Возвращает
bool
Исключения
DbException
RSException
EventException
multiEditCheck (   $element,
  $post,
  $ids 
)

Проверяет возможно ли множественное изменение с параметрами, переданными в POST

Аргументы
AbstractObject$element- orm объект
array$post- данные из POST
array$ids- список id редактируемых объектов
Возвращает
bool
Исключения
DbException
OrmException
RSException
queryGetChilds (   $parent_id,
  $order = null 
)

Возвращает список непосредственных детей элемента $id используя запросы к БД

Аргументы
mixed$parent_id- ID родителя
string$order- сортировка
Возвращает
array
Исключения
DbException
OrmException
RSException
queryParents (   $id)
Аргументы
mixed$id
Возвращает
AbstractObject[]
Исключения
DbException
OrmException
RSException
recursiveConvertTreeToSelectList ( array  $tree,
  $parent_id,
  $level = 0 
)
protected
Аргументы
array$tree- список
$parent_id- id корневого элемента дерева
int$level- технический параметр, уровень вложенности
Возвращает
string[]
static recursiveGetChildIdsFromTree ( array  $tree,
  $id 
)
staticprotected

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

Аргументы
array$tree- массив вида id => array(child_ids)
string | int$id- идентификатор узла
Возвращает
string[]|int[]
setEnableTreePreload (   $enable_tree_preload)

Устанавливает разрешение на предварительную загрузку дерева элементов

Аргументы
bool$enable_tree_preload- значение
Возвращает
void
setParentField (   $field)

Устанавливает поле, в котором хранится ссылка на ID родителя записи

Аргументы
string$field- поле ORM Объекта
Возвращает
TreeList
static staticSelectList (   $parent_id = 0,
  $first = array() 
)
static
Аргументы
int$parent_id= id корневого элемента дерева
array$first= значения, которые нужно добавить в начало списка
Возвращает
array
Исключения
DbException
static staticTreeList (   $parent_id = 0,
  $first_elements = array() 
)
static

Статический вызов метода getTreeList()

Аргументы
int$parent_id- id родительского узла
string[]$first_elements - значения, которые нужно добавить в начало списка
Возвращает
TreeListOrmIterator
Исключения
RSException

Поля

$enable_tree_preload = true
protected
$parent_field
protected