PHP Класс yupe\components\WebModule

Наследование: extends CWebModul\CWebModule
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$adminMenuOrder порядок следования модуля в меню панели управления (сортировка)
$allowedExtensions string
$assetsPath string Путь к ресурсам модуля, например application.modules.yupe.views.assets
$coreCacheTime некоторые компоненты Юпи! автоматически кэширует, если время жизни кэша не указано - берется это значение
$docPath каталог с документацией внутри модуля
$editor - id редактора
$mainCategory категория для контента модуля
$maxSize integer
$mimeTypes string
$profileModel boolean | string | string Имя модели, которая является профилем пользователя для конкретного модуля
$visualEditors - массив редакторов

Защищенные свойства (Protected)

Свойство Тип Описание
$panelWidgets array
$visualEditor - класс редактора

Открытые методы

Метод Описание
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 Метод удаляющий БД модуля

Описание методов

canActivate() публичный Метод

Можно ли включить модуль
public canActivate ( ) : boolean
Результат boolean

checkSelf() публичный Метод

В этом методе необходимо выполнить все проверки.
public checkSelf ( ) : array
Результат array или false

getActivate() публичный Метод

Метод включает модуль - копирует файл с конфигурацией
С версии: 0.5
public getActivate ( boolean $noDependent = false ) : boolean
$noDependent boolean - не проверять на зависимости от других модулей
Результат boolean статус включения модуля

getAdminMenuOrder() публичный Метод

порядок следования модуля в меню панели управления (сортировка)
public getAdminMenuOrder ( ) : integer
Результат integer

getAdminPageLinkNormalize() публичный Метод

ссылка которая будет отображена в панели управления как правило, ведет на страничку для администрирования модуля
public getAdminPageLinkNormalize ( ) : string
Результат string

getAssetsUrl() публичный Метод

С версии: 0.8 Возвращает ссылку на опубликованную папку ресурсов
public getAssetsUrl ( ) : string | null
Результат string | null

getAuthItems() публичный Метод

С версии: 0.8
public getAuthItems ( ) : array
Результат array

getAuthor() публичный Метод

имя автора модуля
public getAuthor ( ) : string
Результат string

getAuthorEmail() публичный Метод

контактный email автора модуля
public getAuthorEmail ( ) : string
Результат string

getCategory() публичный Метод

каждый модуль должен принадлежать одной категории, именно по категориям делятся модули в панели управления
public getCategory ( ) : string
Результат string

getCategoryList() публичный Метод

список категорий
public getCategoryList ( )

getChoice() публичный Метод

метод-хелпер именно для многих параметров модуля, где необходимо вывести варианты выбора да или нет
public getChoice ( ) : array
Результат array для многих параметров модуля необходимо вывести варианты выбора да или нет - метод-хелпер именно для этого

getDeActivate() публичный Метод

Метод выключает модуль - удаляет файл конфигурации модуля
С версии: 0.5
public getDeActivate ( boolean $noDependent = false ) : boolean
$noDependent boolean - не проверять на зависимости от других модулей
Результат boolean статус включения модуля

getDefaultParamsLabels() публичный Метод

массив лейблов для параметров (свойств) модуля. Используется на странице настроек модуля в панели управления.
public getDefaultParamsLabels ( ) : array
Результат array

getDependencies() публичный Метод

Массив с именами модулей, от которых зависит работа данного модуля
С версии: 0.5
public getDependencies ( ) : array
Результат array

getDependenciesAll() публичный Метод

Массив с именами модулей и их зависимостями
С версии: 0.5
public getDependenciesAll ( ) : array
Результат array

getDependent() публичный Метод

Массив с именами модулей которые зависят от текущего модуля
С версии: 0.5
public getDependent ( ) : array
Результат array

getDependents() публичный Метод

Массив с зависимостями модулей
С версии: 0.5
public getDependents ( ) : array
Результат array

getEditableParams() публичный Метод

массив параметров модуля, которые можно редактировать через панель управления (GUI)
public getEditableParams ( ) : array
Результат array

getEditableParamsGroups() публичный Метод

массив групп параметров модуля, для группировки параметров на странице настроек
public getEditableParamsGroups ( ) : array
Результат array

getEditableParamsKey() публичный Метод

получение имен параметров из getEditableParams()
public getEditableParamsKey ( ) : array
Результат array

getEditors() публичный Метод

Метод возвращает список доступных для использования в панели управления визуальных редакторов
С версии: 0.4
public getEditors ( ) : array
Результат array

getExtendedNavigation() публичный Метод

Расширенное меню модуля, формат такой же, как и у {@see getNavigation()}
public getExtendedNavigation ( ) : array
Результат array

getIcon() публичный Метод

название иконки для меню админки, например 'user'
public getIcon ( ) : string
Результат string

getInstall() публичный Метод

Метод устанавливающий модуль
С версии: 0.5
public getInstall ( ) : boolean
Результат boolean статус установки модуля

getIsActive() публичный Метод

Метод определяет включен ли модуль
С версии: 0.5
public getIsActive ( ) : boolean
Результат boolean

getIsInstallDefault() публичный Метод

устанавливает checkbox включенным по умолчанию при установке Yupe
С версии: 0.5
public getIsInstallDefault ( ) : boolean
Результат boolean

getIsInstalled() публичный Метод

Метод проверяет установлен ли модуль
public getIsInstalled ( ) : boolean
Результат boolean состояние модуля

getIsNoDisable() публичный Метод

разрешено ли выключение
С версии: 0.5
public getIsNoDisable ( ) : boolean
Результат boolean

getIsShowInAdminMenu() публичный Метод

показать или нет модуль в панели управления
public getIsShowInAdminMenu ( ) : boolean
Результат boolean

getModulesNoDisable() публичный Метод

Массив с именами модулей и их зависимостями
С версии: 0.5
public getModulesNoDisable ( ) : array
Результат array

getNavigation() публичный Метод

если модуль должен добавить несколько ссылок в панель управления - укажите массив
public getNavigation ( ) : array
Результат array

getPanelWidgets() публичный Метод

С версии: 0.8
public getPanelWidgets ( ) : array
Результат array

getParamsLabels() публичный Метод

массив лейблов для параметров (свойств) модуля. Используется на странице настроек модуля в панели управления.
public getParamsLabels ( ) : array
Результат array

getProfileModel() публичный Метод

С версии: 0.7
public getProfileModel ( ) : boolean | string
Результат boolean | string

getRulesForParam() публичный Метод

Метод формирующий из массива "правил валидации для модуля" правила для указаного параметра
public getRulesForParam ( $param ) : array
$param Параметр для которого необходимо сформировать правила валидации
Результат array Массив с правилами валидации для $param

getSettings() публичный Метод

Получаем настройки модуля:
public getSettings ( boolean $needReset = false ) : void
$needReset boolean необходимо ли сбросить настройки
Результат void

getSettingsUrl() публичный Метод

С версии: 0.8 Возвращает Урл для странички настроек модуля Для того чтобы можно было переопределить
public getSettingsUrl ( )

getUnInstall() публичный Метод

Метод удаляющий модуль
С версии: 0.5
public getUnInstall ( ) : boolean
Результат boolean статус удаления модуля

getUrl() публичный Метод

веб-сайт разработчика модуля или страничка самого модуля
public getUrl ( ) : string
Результат string

getVersion() публичный Метод

текущая версия модуля
public getVersion ( ) : string
Результат string

getVisualEditor() публичный Метод

Возвращает класс виджета выбранного редактора
public getVisualEditor ( ) : string | null
Результат string | null

init() публичный Метод

Инициализация модуля, считывание настроек из базы данных и их кэширование
public init ( ) : void
Результат void

installDB() публичный Метод

Метод установки БД модуля
С версии: 0.5
public installDB ( $installed = [] ) : boolean
Результат boolean статус установки БД модуля

isConfigNeedUpdate() публичный Метод

Проверяем настройки модуля, на необходимость обновления:
public isConfigNeedUpdate ( ) : boolean
Результат boolean

isMultiLang() публичный Метод

статус работы мультиязычности в модуле
public isMultiLang ( ) : boolean
Результат boolean

isNeedUninstall() публичный Метод

Необходимо ли удаление
public isNeedUninstall ( ) : boolean
Результат boolean

rules() публичный Метод

Пример использования возвращаемого массива: 
array(
    array('adminMenuOrder', 'required'),
    array('someEditableParam1, someEditableParam2', 'length', 'min'=>3, 'max'=>12),
    array('anotherEditableParam', 'compare', 'compareAttribute'=>'password2', 'on'=>'register'),
);
public rules ( ) : array
Результат array

setPanelWidgets() публичный Метод

С версии: 0.8
public setPanelWidgets ( array $widgets )
$widgets array

uninstallDB() публичный Метод

Метод удаляющий БД модуля
С версии: 0.5
public uninstallDB ( ) : boolean
Результат boolean статус удаления БД модуля

Описание свойств

$adminMenuOrder публичное свойство

порядок следования модуля в меню панели управления (сортировка)
public $adminMenuOrder

$allowedExtensions публичное свойство

С версии: 0.7 Разрешенные расширения файлов для загрузки
public string $allowedExtensions
Результат string

$assetsPath публичное свойство

Путь к ресурсам модуля, например application.modules.yupe.views.assets
public string $assetsPath
Результат string

$coreCacheTime публичное свойство

некоторые компоненты Юпи! автоматически кэширует, если время жизни кэша не указано - берется это значение
public $coreCacheTime

$docPath публичное свойство

каталог с документацией внутри модуля
С версии: 0.5.1
public $docPath

$editor публичное свойство

- id редактора
public $editor

$mainCategory публичное свойство

категория для контента модуля
С версии: 0.6
public $mainCategory

$maxSize публичное свойство

С версии: 0.7 Максимальный размер загружаемых файлов - 5 MB
public int $maxSize
Результат integer

$mimeTypes публичное свойство

С версии: 0.7 Разрешенные mime types файлов для загрузки
public string $mimeTypes
Результат string

$panelWidgets защищенное свойство

С версии: 0.8 Содержит массив виджетов для отображения на главной странице панели управления Виджеты отображаются в порядке их перечисления
protected array $panelWidgets
Результат array

$profileModel публичное свойство

| string Имя модели, которая является профилем пользователя для конкретного модуля
public bool|string $profileModel
Результат boolean | string

$visualEditor защищенное свойство

- класс редактора
protected $visualEditor

$visualEditors публичное свойство

- массив редакторов
public $visualEditors