| 메소드 |
설명 |
|
|
canActivate ( ) : boolean |
Можно ли включить модуль |
|
|
checkSelf ( ) : array |
Работоспособность модуля может зависеть от разных факторов: версия php, версия Yii, наличие определенных модулей и т.д. |
|
|
getActivate ( boolean $noDependent = false ) : boolean |
Метод включает модуль - копирует файл с конфигурацией |
|
|
getAdminMenuOrder ( ) : integer |
порядок следования модуля в меню панели управления (сортировка) |
|
|
getAdminPageLink ( ) : string |
ссылка которая будет отображена в панели управления
как правило, ведет на страничку для администрирования модуля |
|
|
getAdminPageLinkNormalize ( ) : string |
ссылка которая будет отображена в панели управления
как правило, ведет на страничку для администрирования модуля |
|
|
getAssetsUrl ( ) : string | null |
|
|
|
getAuthItems ( ) : array |
Формат:
Имя правила обязательно начинать с "Модуль." - начало имени используется для определения принадлежности правила модулю
array(
array(
'name' => 'Shop.Order.Management',
'description' => 'Управление заказами',
'type' => 1,
'bizrule' => '',
'items' => array(
array(
'name' => 'Shop.OrderBackend.Create',
'description' => 'Создание заказа',
'type' => 0,
'bizrule' => '',
),
),
)
) |
|
|
getAuthor ( ) : string |
имя автора модуля |
|
|
getAuthorEmail ( ) : string |
контактный email автора модуля |
|
|
getCategory ( ) : string |
каждый модуль должен принадлежать одной категории, именно по категориям делятся модули в панели управления |
|
|
getCategoryList ( ) |
список категорий |
|
|
getChoice ( ) : array |
метод-хелпер именно для многих параметров модуля, где
необходимо вывести варианты выбора да или нет |
|
|
getDeActivate ( boolean $noDependent = false ) : boolean |
Метод выключает модуль - удаляет файл конфигурации модуля |
|
|
getDefaultParamsLabels ( ) : array |
массив лейблов для параметров (свойств) модуля. Используется на странице настроек модуля в панели управления. |
|
|
getDependencies ( ) : array |
Массив с именами модулей, от которых зависит работа данного модуля |
|
|
getDependenciesAll ( ) : array |
Массив с именами модулей и их зависимостями |
|
|
getDependent ( ) : array |
Массив с именами модулей которые зависят от текущего модуля |
|
|
getDependents ( ) : array |
Массив с зависимостями модулей |
|
|
getEditableParams ( ) : array |
массив параметров модуля, которые можно редактировать через панель управления (GUI) |
|
|
getEditableParamsGroups ( ) : array |
массив групп параметров модуля, для группировки параметров на странице настроек |
|
|
getEditableParamsKey ( ) : array |
получение имен параметров из getEditableParams() |
|
|
getEditors ( ) : array |
Метод возвращает список доступных для использования в панели управления визуальных редакторов |
|
|
getExtendedNavigation ( ) : array |
Расширенное меню модуля, формат такой же, как и у {@see getNavigation()} |
|
|
getIcon ( ) : string |
название иконки для меню админки, например 'user' |
|
|
getInstall ( ) : boolean |
Метод устанавливающий модуль |
|
|
getIsActive ( ) : boolean |
Метод определяет включен ли модуль |
|
|
getIsInstallDefault ( ) : boolean |
устанавливает checkbox включенным по умолчанию при установке Yupe |
|
|
getIsInstalled ( ) : boolean |
Метод проверяет установлен ли модуль |
|
|
getIsNoDisable ( ) : boolean |
разрешено ли выключение |
|
|
getIsShowInAdminMenu ( ) : boolean |
показать или нет модуль в панели управления |
|
|
getModulesNoDisable ( ) : array |
Массив с именами модулей и их зависимостями |
|
|
getNavigation ( ) : array |
если модуль должен добавить несколько ссылок в панель управления - укажите массив |
|
|
getPanelWidgets ( ) : array |
|
|
|
getParamsLabels ( ) : array |
массив лейблов для параметров (свойств) модуля. Используется на странице настроек модуля в панели управления. |
|
|
getProfileModel ( ) : boolean | string |
|
|
|
getRulesForParam ( $param ) : array |
Метод формирующий из массива "правил валидации для модуля" правила для указаного параметра |
|
|
getSettings ( boolean $needReset = false ) : void |
Получаем настройки модуля: |
|
|
getSettingsUrl ( ) |
|
|
|
getUnInstall ( ) : boolean |
Метод удаляющий модуль |
|
|
getUrl ( ) : string |
веб-сайт разработчика модуля или страничка самого модуля |
|
|
getVersion ( ) : string |
текущая версия модуля |
|
|
getVisualEditor ( ) : string | null |
Возвращает класс виджета выбранного редактора |
|
|
init ( ) : void |
Инициализация модуля, считывание настроек из базы данных и их кэширование |
|
|
installDB ( $installed = [] ) : boolean |
Метод установки БД модуля |
|
|
isConfigNeedUpdate ( ) : boolean |
Проверяем настройки модуля, на необходимость обновления: |
|
|
isMultiLang ( ) : boolean |
статус работы мультиязычности в модуле |
|
|
isNeedUninstall ( ) : boolean |
Необходимо ли удаление |
|
|
rules ( ) : array |
Массив правил валидации для модуля |
|
|
setPanelWidgets ( array $widgets ) |
|
|
|
uninstallDB ( ) : boolean |
Метод удаляющий БД модуля |
|