PHP Class yupe\components\WebModule

Inheritance: extends CWebModul\CWebModule
Show file Open project: yupe/yupe Class Usage Examples

Public Properties

Property Type Description
$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 Properties

Property Type Description
$panelWidgets array
$visualEditor - класс редактора

Public Methods

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

Method Details

canActivate() public method

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

checkSelf() public method

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

getActivate() public method

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

getAdminMenuOrder() public method

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

getAdminPageLinkNormalize() public method

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

getAssetsUrl() public method

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

getAuthItems() public method

Since: 0.8
public getAuthItems ( ) : array
return array

getAuthor() public method

имя автора модуля
public getAuthor ( ) : string
return string

getAuthorEmail() public method

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

getCategory() public method

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

getCategoryList() public method

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

getChoice() public method

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

getDeActivate() public method

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

getDefaultParamsLabels() public method

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

getDependencies() public method

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

getDependenciesAll() public method

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

getDependent() public method

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

getDependents() public method

Массив с зависимостями модулей
Since: 0.5
public getDependents ( ) : array
return array

getEditableParams() public method

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

getEditableParamsGroups() public method

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

getEditableParamsKey() public method

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

getEditors() public method

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

getExtendedNavigation() public method

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

getIcon() public method

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

getInstall() public method

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

getIsActive() public method

Метод определяет включен ли модуль
Since: 0.5
public getIsActive ( ) : boolean
return boolean

getIsInstallDefault() public method

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

getIsInstalled() public method

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

getIsNoDisable() public method

разрешено ли выключение
Since: 0.5
public getIsNoDisable ( ) : boolean
return boolean

getIsShowInAdminMenu() public method

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

getModulesNoDisable() public method

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

getNavigation() public method

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

getPanelWidgets() public method

Since: 0.8
public getPanelWidgets ( ) : array
return array

getParamsLabels() public method

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

getProfileModel() public method

Since: 0.7
public getProfileModel ( ) : boolean | string
return boolean | string

getRulesForParam() public method

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

getSettings() public method

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

getSettingsUrl() public method

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

getUnInstall() public method

Метод удаляющий модуль
Since: 0.5
public getUnInstall ( ) : boolean
return boolean статус удаления модуля

getUrl() public method

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

getVersion() public method

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

getVisualEditor() public method

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

init() public method

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

installDB() public method

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

isConfigNeedUpdate() public method

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

isMultiLang() public method

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

isNeedUninstall() public method

Необходимо ли удаление
public isNeedUninstall ( ) : boolean
return boolean

rules() public method

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

setPanelWidgets() public method

Since: 0.8
public setPanelWidgets ( array $widgets )
$widgets array

uninstallDB() public method

Метод удаляющий БД модуля
Since: 0.5
public uninstallDB ( ) : boolean
return boolean статус удаления БД модуля

Property Details

$adminMenuOrder public property

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

$allowedExtensions public property

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

$assetsPath public property

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

$coreCacheTime public property

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

$docPath public property

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

$editor public property

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

$mainCategory public property

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

$maxSize public property

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

$mimeTypes public property

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

$panelWidgets protected property

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

$profileModel public property

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

$visualEditor protected property

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

$visualEditors public property

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