Используется для организации элементов на стандартных страницах административной панели. Содержит список визуальных объектов, которые будут находиться на странице, организовывает их взаимодействие
Поля данных | |
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 | ( | ) |
Инициализирует страницу перед отображением
addCsvButton | ( | $schema, | |
$additional_export_params = [] |
|||
) |
Добавляет в верхний toolbar пункт Импорт/экспорт в CSV
string | $schema | - схема для экспорта и импорта |
array | $additional_export_params | - массив дополнительных параметров для экспорт |
addHiddenFields | ( | array | $keyval | ) |
Добавляет скрытые поля данных (input[type=hidden]) в форму на страницу
array | $keyval |
controllerNameStr | ( | ) |
getApi | ( | $key = null | ) |
Возвращает объект API для нужного контекста
mixed | $key | - контекст |
getBeforeTableContent | ( | ) |
getBottomToolbar | ( | ) |
Возвращает нижнюю панель инструментов
getCategoryBottomToolbar | ( | ) |
Возвращает нижнюю панель инструментов для списка категорий
getCategoryControl | ( | ) |
Возвращает объект управления списком категорий
getCategoryFilter | ( | ) |
Возвращает фильтр для списка категорий
getCategoryListFunction | ( | ) |
Возвращает имя функции из API, которая будет вызвана для получения данных для списка категорий
getController | ( | ) |
Возвращает связанный объект контроллера
getFilter | ( | ) |
Возвращает фильтр, установленный на странице
getFilterContent | ( | ) |
Возвращает произвольный HTML для зоны фильтра
getForm | ( | ) |
Возвращает форму ORM объекта
getFormErrors | ( | ) |
Возвращает ошибки для отобажения в форме
getFormTemplate | ( | ) |
Возвращает имя шаблона, который будет использован для генерации формы ORM объекта
getFormTitle | ( | ) |
Возвращает заголовок формы
getHiddenFields | ( | ) |
Возвращает скрытые поля
getListFunction | ( | ) |
Возвращает имя функции из API, которая будет вызвана для получения данных для таблицы
getMainMenuIndex | ( | ) |
Возвращает порядковый номер корневого пункта меню, в котором мы сейчас находимся
getPaginatorControl | ( | ) |
Возвращает объект управления пагинатором
getTableControl | ( | ) |
Возвращает объект управления таблицей
getTemplate | ( | ) |
Возвращает шаблон, который используется для сборки страницы
getTopHelp | ( | ) |
Возвращает подсказку для текущей страницы
getTopToolbar | ( | ) |
Возвращает верхнюю панель инструментов
getTreeBottomToolbar | ( | ) |
Возвращает нижнюю панель инструментов для древовидного списка
getTreeControl | ( | ) |
Возвращает объект управления деревом
getTreeFilter | ( | ) |
Возвращает фильтр для древовидного списка
getTreeListFunction | ( | ) |
Возвращает имя функции из API, которая будет вызвана для получения данных для древовидного списка
getTreeViewType | ( | ) |
Возвращает тип отображения дерева относительно таблицы
offsetExists | ( | $offset | ) |
ArrayAccess
offsetGet | ( | $offset | ) |
ArrayAccess
offsetSet | ( | $offset, | |
$value | |||
) |
ArrayAccess
offsetUnset | ( | $offset | ) |
ArrayAccess
|
protected |
Рекурсивно ищет порядковый номер корневого элемента меню, в котором мы сейчас находимся.
TreeListFakeIterator | $node | |
string | $find_uri |
removeSection | ( | $section | ) |
setApi | ( | $api | ) |
Устанавливает объект API, который будет использоваться для вывода табличных данных
mixed | $api |
setAppendModuleOptionsButton | ( | $bool | ) |
Устанавливает, добавлять ли к topToolbar кнопку с настройкой модуля
mixed | $bool |
setBeforeTableContent | ( | $html | ) |
setBottomToolbar | ( | Html\Toolbar\Element | $toolbar = null | ) |
Устанавливает нижнюю строку инструментов
\RS\Html\Toolbar\Element | $toolbar |
setCategory | ( | Html\Category\Element | $category, |
$api = null |
|||
) |
Устанавливает список категорий для страницы
\RS\Html\Category\Element | $category | - |
mixed | $api |
setCategoryBottomToolbar | ( | Html\Toolbar\Element | $toolbar = null | ) |
Устанавливает нижнюю строку инструментов для списка категорий
\RS\Html\Toolbar\Element | $toolbar |
setCategoryFilter | ( | Html\Filter\Control | $filter | ) |
Устанавливает фильтр для списка категорий
\RS\Html\Filter\Control | $filter |
setCategoryListFunction | ( | $name | ) |
Устанавливает имя функции из API, которая будет вызвана для получения данных для списка категорий
string | $name | - имя функции |
setFilter | ( | Html\Filter\Control | $filter | ) |
setFilterContent | ( | $content | ) |
Устанавливает произвольный HTML для зоны фильтра
string | $content |
setForm | ( | $html | ) |
setFormObject | ( | \RS\Orm\AbstractObject | $form_object | ) |
Устанавливает объект, из которого будет сгенерирована форма
\RS\Orm\AbstractObject | $form_object |
setFormSwitch | ( | $alias | ) |
Переключает на новый шаблон, в который войдут свойства aliasVisible имеющие значение true
string | $alias |
setFormTemplate | ( | $tpl | ) |
Устанавливает имя шаблона, который будет использован для генерации формы ORM объекта
string | $tpl |
setHeaderHtml | ( | $html | ) |
setListFunction | ( | $name | ) |
Устанавливает имя функции из API, которая будет вызвана для получения данных для таблицы
string | $name |
setMultieditMode | ( | $bool | ) |
Устанавливает, какую форму генерировать методу getForm. В режиме мультиредактирования форма отличается от обычной
mixed | $bool |
setPaginator | ( | ) |
Добавляет пагинатор на страницу
setTable | ( | Html\Table\Element | $table, |
$id = null |
|||
) |
Устанавливает таблицу в отображение
\RS\Html\Table\Element | $table | |
mixed | $id |
setTemplate | ( | $tpl | ) |
Устанавливает шаблон, который используется для сборки страницы
string | $tpl |
setTopHelp | ( | $help | ) |
setTopTitle | ( | $form_title, | |
$data = null |
|||
) |
Устанавливает заголовок
string | $form_title | - заголовок |
array | null | $data | - массив со значениями для замены |
setTopToolbar | ( | Html\Toolbar\Element | $toolbar = null | ) |
Устанавливает верхнюю строку инструментов
\RS\Html\Toolbar\Element | $toolbar |
setTree | ( | Html\Tree\Element | $tree, |
$api = null |
|||
) |
Устанавливает древовидный список для страницы
\RS\Html\Tree\Element | $tree | |
mixed | $api |
setTreeBottomToolbar | ( | Html\Toolbar\Element | $toolbar = null | ) |
Устанавливает нижнюю строку инструментов для древовидного списка
\RS\Html\Toolbar\Element | $toolbar |
setTreeFilter | ( | Html\Filter\Control | $filter | ) |
Устанавливает фильтр для древовидного списка
\RS\Html\Filter\Control | $filter |
setTreeListFunction | ( | $name | ) |
Устанавливает имя функции из API, которая будет вызвана для получения данных для древовидного списка
string | $name | - имя функции |
setViewAs | ( | $what | ) |
Устанавливает как будет выглядеть страница. В виде таблицы, формы, древовидного списка? Вид меняется установкой соответствующего шаблона
string | $what |
viewAsAny | ( | ) |
Отображать страницу в виде произвольной страницы с данными
viewAsForm | ( | ) |
Отображать страницу в виде формы ORM объекта
viewAsTable | ( | ) |
Отображать страницу в виде таблицы с данными
viewAsTableCategory | ( | ) |
Отображать страницу в виде таблицы с данными и списка категорий
viewAsTableTree | ( | ) |
Отображать страницу в виде таблицы с данными и дерева категорий (дерево категорий свернуто)
viewAsTree | ( | ) |
Отображать страницу в виде дерева
$appendModuleOptionsButton = true |
$collection |
$controller |
$other_api = [] |
$router |
$url |
const VIEW_CAT_LEFT = 'left' |
const VIEW_CAT_TOP = 'top' |
const VIEW_CAT_VAR = 'viewcat' |