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

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

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

Открытые члены
	__construct (\RS\Controller\AbstractModule $controller, $api=null,\RS\Http\Request $url=null, array $options=[])

	setApi ($api)

	setAppendModuleOptionsButton ($bool)

	controllerNameStr ()

	setViewAs ($what)

	setTable (Html\Table\Element $table, $id=null)

	getTableControl ()

	setPaginator ()

	getPaginatorControl ()

	setTopHelp ($help)

	getTopHelp ()

	setFilter (Html\Filter\Control $filter)

	getFilter ()

	setListFunction ($name)

	getListFunction ()

	setTreeListFunction ($name)

	getTreeListFunction ()

	setCategoryListFunction ($name)

	getCategoryListFunction ()

	setFormTemplate ($tpl)

	getFormTemplate ()

	setForm ($html)

	setTemplate ($tpl)

	getTemplate ()

	setBottomToolbar (Html\Toolbar\Element $toolbar=null)

	getBottomToolbar ()

	setTreeBottomToolbar (Html\Toolbar\Element $toolbar=null)

	getTreeBottomToolbar ()

	setCategoryBottomToolbar (Html\Toolbar\Element $toolbar=null)

	getCategoryBottomToolbar ()

	setTopToolbar (Html\Toolbar\Element $toolbar=null)

	getTopToolbar ()

	addCsvButton ($schema, $additional_export_params=[])

	setTreeFilter (Html\Filter\Control $filter)

	getTreeFilter ()

	setTree (Html\Tree\Element $tree, $api=null)

	getTreeControl ()

	setCategoryFilter (Html\Filter\Control $filter)

	getCategoryFilter ()

	setCategory (Html\Category\Element $category, $api=null)

	getCategoryControl ()

	setBeforeTableContent ($html)

	getBeforeTableContent ()

	setTopTitle ($form_title, $data=null)

	getFormTitle ()

	setFormSwitch ($alias)

	setFormObject (\RS\Orm\AbstractObject $form_object)

	getForm ()

	setMultieditMode ($bool)

	addHiddenFields (array $keyval)

	getHiddenFields ()

	getApi ($key=null)

	getFormErrors ()

	removeSection ($section)

	setHeaderHtml ($html)

	active ()

	getTreeViewType ()

	viewAsAny ()

	viewAsForm ()

	viewAsTable ()

	viewAsTableTree ()

	viewAsTableCategory ()

	viewAsTree ()

	offsetSet ($offset, $value)

	offsetExists ($offset)

	offsetUnset ($offset)

	offsetGet ($offset)

	setFilterContent ($content)

	getFilterContent ()

	getMainMenuIndex ()

	getController ()

Поля данных
const	VIEW_CAT_VAR = 'viewcat'

const	VIEW_CAT_LEFT = 'left'

const	VIEW_CAT_TOP = 'top'

	$other_api = []

	$url

	$appendModuleOptionsButton = true

	$controller

	$router

	$collection

Защищенные члены
	recursiveFindIndex ($node, $find_uri)

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

__construct	(	\RS\Controller\AbstractModule	$controller,
			$api = `null`,
		\RS\Http\Request	$url = `null`,
		array	$options = `[]`
	)

Методы

active ( )

Инициализирует страницу перед отображением

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

addCsvButton	(	$schema,
		$additional_export_params = `[]`
	)

Добавляет в верхний toolbar пункт Импорт/экспорт в CSV

Аргументы

string	$schema	- схема для экспорта и импорта
array	$additional_export_params	- массив дополнительных параметров для экспорт

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

addHiddenFields ( array $keyval )

Добавляет скрытые поля данных (input[type=hidden]) в форму на страницу

Аргументы

array $keyval

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

controllerNameStr ( )

getApi ( $key = null )

Возвращает объект API для нужного контекста

Аргументы

mixed $key - контекст

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

getBeforeTableContent ( )

getBottomToolbar ( )

Возвращает нижнюю панель инструментов

Возвращает: | null

getCategoryBottomToolbar ( )

Возвращает нижнюю панель инструментов для списка категорий

Возвращает: |null

getCategoryControl ( )

Возвращает объект управления списком категорий

Возвращает

getCategoryFilter ( )

Возвращает фильтр для списка категорий

Возвращает: | null

getCategoryListFunction ( )

Возвращает имя функции из API, которая будет вызвана для получения данных для списка категорий

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

getController ( )

Возвращает связанный объект контроллера

Возвращает

getFilter ( )

Возвращает фильтр, установленный на странице

Возвращает: | null

getFilterContent ( )

Возвращает произвольный HTML для зоны фильтра

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

getForm ( )

Возвращает форму ORM объекта

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

getFormErrors ( )

Возвращает ошибки для отобажения в форме

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

getFormTemplate ( )

Возвращает имя шаблона, который будет использован для генерации формы ORM объекта

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

getFormTitle ( )

Возвращает заголовок формы

getHiddenFields ( )

Возвращает скрытые поля

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

getListFunction ( )

Возвращает имя функции из API, которая будет вызвана для получения данных для таблицы

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

getMainMenuIndex ( )

Возвращает порядковый номер корневого пункта меню, в котором мы сейчас находимся

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

getPaginatorControl ( )

Возвращает объект управления пагинатором

Возвращает: | null

getTableControl ( )

Возвращает объект управления таблицей

Возвращает: | null

getTemplate ( )

Возвращает шаблон, который используется для сборки страницы

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

getTopHelp ( )

Возвращает подсказку для текущей страницы

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

getTopToolbar ( )

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

Возвращает

getTreeBottomToolbar ( )

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

Возвращает: | null

getTreeControl ( )

Возвращает объект управления деревом

Возвращает

getTreeFilter ( )

Возвращает фильтр для древовидного списка

Возвращает: | null

getTreeListFunction ( )

Возвращает имя функции из API, которая будет вызвана для получения данных для древовидного списка

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

getTreeViewType ( )

Возвращает тип отображения дерева относительно таблицы

offsetExists ( $offset )

ArrayAccess

offsetGet ( $offset )

ArrayAccess

offsetSet	(	$offset,
		$value
	)

ArrayAccess

offsetUnset ( $offset )

ArrayAccess

recursiveFindIndex	(	$node,
		$find_uri
	)

protected

Рекурсивно ищет порядковый номер корневого элемента меню, в котором мы сейчас находимся.

Аргументы

TreeListFakeIterator	$node
string	$find_uri

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

removeSection ( $section )

Удаляет секцию $section

Аргументы

string $section

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

setApi ( $api )

Устанавливает объект API, который будет использоваться для вывода табличных данных

Аргументы

mixed $api

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

setAppendModuleOptionsButton ( $bool )

Устанавливает, добавлять ли к topToolbar кнопку с настройкой модуля

Аргументы

mixed $bool

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

setBeforeTableContent ( $html )

setBottomToolbar ( Html\Toolbar\Element $toolbar = null )

Устанавливает нижнюю строку инструментов

Аргументы

\RS\Html\Toolbar\Element $toolbar

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

setCategory	(	Html\Category\Element	$category,
			$api = `null`
	)

Устанавливает список категорий для страницы

Аргументы

\RS\Html\Category\Element	$category	-
mixed	$api

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

setCategoryBottomToolbar ( Html\Toolbar\Element $toolbar = null )

Устанавливает нижнюю строку инструментов для списка категорий

Аргументы

\RS\Html\Toolbar\Element $toolbar

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

setCategoryFilter ( Html\Filter\Control $filter )

Устанавливает фильтр для списка категорий

Аргументы

\RS\Html\Filter\Control $filter

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

setCategoryListFunction ( $name )

Устанавливает имя функции из API, которая будет вызвана для получения данных для списка категорий

Аргументы

string $name - имя функции

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

setFilter ( Html\Filter\Control $filter )

Устанавливает фильтр на страницу

Аргументы

\RS\Html\Filter\Control $filter

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

setFilterContent ( $content )

Устанавливает произвольный HTML для зоны фильтра

Аргументы

string $content

Возвращает: $this

setForm ( $html )

Устанавливает произвольный шаблон формы

Аргументы

string $html шаблон

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

setFormObject ( \RS\Orm\AbstractObject $form_object )

Устанавливает объект, из которого будет сгенерирована форма

Аргументы

\RS\Orm\AbstractObject $form_object

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

setFormSwitch ( $alias )

Переключает на новый шаблон, в который войдут свойства aliasVisible имеющие значение true

Аргументы

string $alias

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

setFormTemplate ( $tpl )

Устанавливает имя шаблона, который будет использован для генерации формы ORM объекта

Аргументы

string $tpl

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

setHeaderHtml ( $html )

Установка дополнительного текста вверху страницы

Аргументы

string $html

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

setListFunction ( $name )

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

Аргументы

string $name

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

setMultieditMode ( $bool )

Устанавливает, какую форму генерировать методу getForm. В режиме мультиредактирования форма отличается от обычной

Аргументы

mixed $bool

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

setPaginator ( )

Добавляет пагинатор на страницу

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

setTable	(	Html\Table\Element	$table,
			$id = `null`
	)

Устанавливает таблицу в отображение

Аргументы

\RS\Html\Table\Element	$table
mixed	$id

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

setTemplate ( $tpl )

Устанавливает шаблон, который используется для сборки страницы

Аргументы

string $tpl

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

setTopHelp ( $help )

Устанавливает текст подсказки для текущей страницы

Аргументы

string $help

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

setTopTitle	(	$form_title,
		$data = `null`
	)

Устанавливает заголовок

Аргументы

string	$form_title	- заголовок
array \| null	$data	- массив со значениями для замены

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

setTopToolbar ( Html\Toolbar\Element $toolbar = null )

Устанавливает верхнюю строку инструментов

Аргументы

\RS\Html\Toolbar\Element $toolbar

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

setTree	(	Html\Tree\Element	$tree,
			$api = `null`
	)

Устанавливает древовидный список для страницы

Аргументы

\RS\Html\Tree\Element	$tree
mixed	$api

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

setTreeBottomToolbar ( Html\Toolbar\Element $toolbar = null )

Устанавливает нижнюю строку инструментов для древовидного списка

Аргументы

\RS\Html\Toolbar\Element $toolbar

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

setTreeFilter ( Html\Filter\Control $filter )

Устанавливает фильтр для древовидного списка

Аргументы

\RS\Html\Filter\Control $filter

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

setTreeListFunction ( $name )

Устанавливает имя функции из API, которая будет вызвана для получения данных для древовидного списка

Аргументы

string $name - имя функции

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

setViewAs ( $what )

Устанавливает как будет выглядеть страница. В виде таблицы, формы, древовидного списка? Вид меняется установкой соответствующего шаблона

Аргументы

string $what

viewAsAny ( )

Отображать страницу в виде произвольной страницы с данными

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

viewAsForm ( )

Отображать страницу в виде формы ORM объекта

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

viewAsTable ( )

Отображать страницу в виде таблицы с данными

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

viewAsTableCategory ( )

Отображать страницу в виде таблицы с данными и списка категорий

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

viewAsTableTree ( )

Отображать страницу в виде таблицы с данными и дерева категорий (дерево категорий свернуто)

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

viewAsTree ( )

Отображать страницу в виде дерева

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

Поля

$appendModuleOptionsButton = true

$collection

Инициализатор

= [

'filter' => null

$controller

$other_api = []

$router

$url

const VIEW_CAT_LEFT = 'left'

const VIEW_CAT_TOP = 'top'

const VIEW_CAT_VAR = 'viewcat'

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

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

Поля данных

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

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

Методы

Поля