Граф наследования:Api:

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

Класс содержит функции для работы со списком меню

Открытые члены
	__construct ()

	getAccessFilter ()

	setCheckAccess ($checkAccess)

	getCurrentMenuItem ()

	moveElement ($from, $to, $flag, OrmRequest $extra_expr=null, $new_parent_id=null)

	getAdminMenu ($cache=true)

	deleteItem ($alias, $parent_alias, $menutype)

	getMenuItems ($root, $cache=true)

Открытые члены унаследованные от TreeCookieList
	__construct (AbstractObject $orm_element, array $options=[])

	getOpenedElements ()

	getClosedElement ()

Открытые члены унаследованные от TreeList
	setDeleteChild ($bool)

	isDeleteChild ()

	setParentField ($field)

	getParentField ()

	getPathToFirst ($id, $cache=true)

	getParentIds ($ids, $cache=true)

	getByAlias ($alias, $parent=null)

	getTreeList ($parent_id=0, array $first_elements=[])

	getSelectList ($parent_id=0, array $first=[])

	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=[])

	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=[])

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

	getOneItem ($id)

	getById ($id, $request=null)

	getElement ()

	setElement ($object)

	getElementClass ()

	getNewElement ()

	save ($id=null, array $user_post=[])

	addFilterControl (\RS\Html\Filter\Control $filter_control)

	addTableControl (\RS\Html\Table\Control $table_control)

	del (array $ids)

	multiDelete ($ids)

	getSelectList ($first=[])

	multieditFormView ($tpl_path, $formfile, array $addparam=[])

	multiUpdate (array $data, $ids=[])

	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)

	__set ($name, $value)

	__get ($name)

	__isset ($name)

	__unset ($name)

Открытые члены унаследованные от BaseModel
	addError ($message, $fieldname=null, $form=null)

	hasError ()

	getErrors ()

	cleanErrors ()

	getDisplayErrors ()

	getErrorsStr ()

	getFormErrors ($form, $separator= ', ')

	getNonFormErrors ($separator= ', ')

	exportErrors ()

	importErrors ($data)

Открытые статические члены
static	selectList ()

static	getHref ($item)

static	getMenuTypesNames ($only_visible=true)

static	getMenuTypeDescriptions ($only_visible=true)

Открытые статические члены унаследованные от TreeList
static	staticTreeList ($parent_id=0, $first_elements=[])

static	staticSelectList ($parent_id=0, $first=[])

static	FindSubFolder (array $list)

static	getChildsId ($ids)

Открытые статические члены унаследованные от EntityList
static	getInstance ($key= 'default')

static	staticSelectList ($first=[])

static	getSavedRequest ($key, $default=null)

Поля данных
const	TYPELINK_LINK = 'link'

Поля данных унаследованные от TreeCookieList
	$uniq

Поля данных унаследованные от EntityList
const	WHERE_CONDITION_VAR = 'where_conditions'

Поля данных унаследованные от BaseModel
	$form_fieldname = []

	$errors_by_form = []

	$errors_non_form = []

	$errors = []

Защищенные данные
	$sort_field = 'sortn'

	$checkAccess = true

	$accessFilters = null

Защищенные данные унаследованные от TreeCookieList
	$opened_elements = null

Защищенные данные унаследованные от TreeList
	$parent_field

	$enable_tree_preload = true

	$delete_child = 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 = []

	$parsePrefixes = ['&' => 'AND'

	$cache_alias = []

	$options = []

	$q

Защищенные данные унаследованные от BaseModel
	$default_error_fieldname = 'Информация'

Дополнительные унаследованные члены
Защищенные члены унаследованные от TreeList
	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)

Защищенные статические члены унаследованные от TreeList
static	recursiveGetChildIdsFromTree (array $tree, $id)

Статические защищенные данные унаследованные от EntityList
static	$instance = []

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

__construct ( )

Методы

deleteItem	(	$alias,
		$parent_alias,
		$menutype
	)

Удаляет пункт меню

Аргументы

mixed	$alias
mixed	$parent_alias
string	$menutype	- тип меню

Возвращает: bool

Исключения

DbException
OrmException

getAccessFilter ( )

Возвращает массив с инструкциями для установки фильтра пунктов меню по ID, согласно правам доступа текущего пользователя к этим пунктам

Возвращает: array | bool(false) - Возвращает false в случае, если имеется полный доступ ко всем пунктам меню

getAdminMenu ( $cache = true )

Получает меню для админки

Аргументы

bool $cache - использовать кэш

Возвращает: array

Исключения

\RS\Event\Exception

getCurrentMenuItem ( )

Возвращает текущий пункт меню. В случае успешного обнаружения объект будет загружен (id>0)

Возвращает: Orm

static getHref ( $item )

static

Возвращает URL в зависимости от типа пункта меню

Аргументы

array $item - массив со сведениями о пункте меню

Возвращает: string

getMenuItems	(	$root,
		$cache = `true`
	)

Возвращает пункты меню для заданного root

Аргументы

integer \| string	$root	ID или ALIAS корневого элемента
bool	$cache	- если true, то

Возвращает: array ['root' => корневой элемент, 'items' => [пункт меню, пункт меню, ...]]

Исключения

OrmException
RSException

static getMenuTypeDescriptions ( $only_visible = true )

static

Возвращает описание всех типов меню

Аргументы

bool $only_visible - только видимые

Возвращает: string

static getMenuTypesNames ( $only_visible = true )

static

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

Аргументы

bool $only_visible - только видимые

Возвращает: array

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

Исключения

\RS\Db\Exception

static selectList ( )

static

setCheckAccess ( $checkAccess )

Переключает флаг $this->checkAccess

Аргументы

bool $checkAccess - если true, то будут возвращены только те пункты меню, к которым есть доступ

Возвращает: void

Поля

$accessFilters = null

protected

$checkAccess = true

protected

$sort_field = 'sortn'

protected

const TYPELINK_LINK = 'link'

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

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

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

Поля данных

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

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

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

Методы

Поля