PHP Class YupeModule

Inheritance: extends yupe\components\WebModule
Afficher le fichier Open project: yupe/yupe

Méthodes publiques

Свойство Type Description
$adminMenuOrder integer
$allowedIp
$availableLanguages string
$backendLayout string
$backendTheme
$cache
$coreCacheTime integer
$coreModuleId string
$defaultBackendLanguage string
$defaultLanguage string
$email
$emptyLayout string
$enableAssets
$hidePanelUrls integer
$logo string
$profileModel string
$siteDescription
$siteKeyWords
$siteName
$theme
$uploadPath string

Protected Properties

Свойство Type Description
$backEndFilters array

Méthodes publiques

Méthode Description
addBackendFilter ( $filter )
checkSelf ( ) : bool/mixed Проверка модуля на ошибки:
getAdminPageLink ( ) : mixed Возвращаем линк на админ панель:
getAllowedIp ( ) : array
getAuthItems ( ) : array
getAuthor ( ) : string Возвращаем автора модуля:
getAuthorEmail ( ) : string Возвращаем почту автора модуля:
getBackendFilters ( ) : array
getBackendLayoutAlias ( string $layoutName = '' ) : string Получает полный алиас нужного лайаута бэкенда с учетом темы
getCategory ( ) : string Возвращаем название категории модуля:
getDependencies ( ) : array Получаем массив с именами модулей, от которых зависит работа данного модуля
getDescription ( ) : string Возвращаем описание модуля:
getEditableParams ( ) : mixed Возвращаем редактируемые параметры:
getEditableParamsGroups ( ) : array массив групп параметров модуля, для группировки параметров на странице настроек
getIcon ( ) : string Возвращаем иконка модуля:
getIsInstallDefault ( ) : boolean Возвращаем статус, устанавливать ли галку для установки модуля в инсталяторе по умолчанию:
getIsNoDisable ( ) : boolean Возвращаем статус, возможно ли модуль отключать:
getLanguageSelectorArray ( ) : array Выдает массив для меню в административной панеле
getLanguagesList ( ) : mixed Возвращаем массив языков:
getLayoutsList ( ) : array
getLogo ( )
getName ( ) : string Возвращаем название модуля:
getNavigation ( ) : mixed Возвращаем массив меню:
getParamsLabels ( ) : mixed Возвращаем названия параметров:
getSubMenu ( array $menu ) : array Метод возвращает пункты, содержащие сабменю для заголовок групп
getThemeBaseUrl ( ) : string Выдает путь к стилям, определяет вкелючена тема или нет
getThemes ( boolean $backend = false ) : array Метод возвращает доступные темы оформления
getUrl ( ) : string Возвращаем адрес на сайт автора модуля:
getVersion ( ) : string Возвращаем версию:
poweredBy ( string $color = 'yellow', string $text = '' ) : string Генерация анкора PoweredBy
rules ( ) : array Возвращаем правила валидации для параметров модуля
setBackendFilters ( array $filters )

Method Details

addBackendFilter() public méthode

Since: 0.8 Добавить новый фильтр для контроллеров панели управления
public addBackendFilter ( $filter )
$filter

checkSelf() public méthode

Проверка модуля на ошибки:
public checkSelf ( ) : bool/mixed
Résultat bool/mixed

getAllowedIp() public méthode

public getAllowedIp ( ) : array
Résultat array

getAuthItems() public méthode

public getAuthItems ( ) : array
Résultat array

getAuthor() public méthode

Возвращаем автора модуля:
public getAuthor ( ) : string
Résultat string

getAuthorEmail() public méthode

Возвращаем почту автора модуля:
public getAuthorEmail ( ) : string
Résultat string

getBackendFilters() public méthode

Since: 0.8 Вернет массив фильтров для контроллеров панели управления
public getBackendFilters ( ) : array
Résultat array

getBackendLayoutAlias() public méthode

Получает полный алиас нужного лайаута бэкенда с учетом темы
Since: 0.4
public getBackendLayoutAlias ( string $layoutName = '' ) : string
$layoutName string Название лайаута, если не задан - берется по-умолчанию для бекенда
Résultat string Полный путь к лайауту

getCategory() public méthode

Возвращаем название категории модуля:
public getCategory ( ) : string
Résultat string

getDependencies() public méthode

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

getDescription() public méthode

Возвращаем описание модуля:
public getDescription ( ) : string
Résultat string

getEditableParams() public méthode

Возвращаем редактируемые параметры:
public getEditableParams ( ) : mixed
Résultat mixed

getEditableParamsGroups() public méthode

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

getIcon() public méthode

Возвращаем иконка модуля:
public getIcon ( ) : string
Résultat string

getIsInstallDefault() public méthode

Возвращаем статус, устанавливать ли галку для установки модуля в инсталяторе по умолчанию:
public getIsInstallDefault ( ) : boolean
Résultat boolean

getIsNoDisable() public méthode

Возвращаем статус, возможно ли модуль отключать:
public getIsNoDisable ( ) : boolean
Résultat boolean

getLanguageSelectorArray() public méthode

Выдает массив для меню в административной панеле
Since: 0.5
public getLanguageSelectorArray ( ) : array
Résultat array массив меню

getLanguagesList() public méthode

Возвращаем массив языков:
public getLanguagesList ( ) : mixed
Résultat mixed

getLayoutsList() public méthode

public getLayoutsList ( ) : array
Résultat array

getName() public méthode

Возвращаем название модуля:
public getName ( ) : string
Résultat string

getNavigation() public méthode

Возвращаем массив меню:
public getNavigation ( ) : mixed
Résultat mixed

getParamsLabels() public méthode

Возвращаем названия параметров:
public getParamsLabels ( ) : mixed
Résultat mixed

getSubMenu() public méthode

Метод возвращает пункты, содержащие сабменю для заголовок групп
Since: 0.5
public getSubMenu ( array $menu ) : array
$menu array - список пунктов
Résultat array преобразованный список пунктов

getThemeBaseUrl() public méthode

Выдает путь к стилям, определяет вкелючена тема или нет
Since: 0.5
public getThemeBaseUrl ( ) : string
Résultat string путь к директории

getThemes() public méthode

Для добавления новой темы необходимо: Прочитать http://yiiframework.ru/doc/guide/ru/topics.theming Скопировать тему в каталог WebRoot/themes или аналогичный (настройки themeManager) Название каталога с темой для панели управления должно начинаться с префикса "backend_", например "backend_bootstrap"
Since: 0.4
public getThemes ( boolean $backend = false ) : array
$backend boolean - если установлен в true - вернет темы оформления для панели управления, иначе - для публичной части сайта
Résultat array список доступных тем

getUrl() public méthode

Возвращаем адрес на сайт автора модуля:
public getUrl ( ) : string
Résultat string

getVersion() public méthode

Возвращаем версию:
public getVersion ( ) : string
Résultat string

poweredBy() public méthode

Генерация анкора PoweredBy
public poweredBy ( string $color = 'yellow', string $text = '' ) : string
$color string - цвет
$text string - текст
Résultat string poweredBy

rules() public méthode

Возвращаем правила валидации для параметров модуля
public rules ( ) : array
Résultat array Правила валидации для параметров модуля

setBackendFilters() public méthode

Since: 0.8
public setBackendFilters ( array $filters )
$filters array Устанавливает массив фильтров для контроллеров панели управления

Property Details

$adminMenuOrder public_oe property

public int $adminMenuOrder
Résultat integer

$allowedIp public_oe property

public $allowedIp

$availableLanguages public_oe property

public string $availableLanguages
Résultat string

$backEndFilters protected_oe property

Since: 0.8 Массив фильтров для контроллеров панели управления
protected array $backEndFilters
Résultat array

$backendLayout public_oe property

public string $backendLayout
Résultat string

$backendTheme public_oe property

public $backendTheme

$cache public_oe property

public $cache

$coreCacheTime public_oe property

public int $coreCacheTime
Résultat integer

$coreModuleId public_oe property

public string $coreModuleId
Résultat string

$defaultBackendLanguage public_oe property

public string $defaultBackendLanguage
Résultat string

$defaultLanguage public_oe property

public string $defaultLanguage
Résultat string

$email public_oe property

public $email

$emptyLayout public_oe property

public string $emptyLayout
Résultat string

$enableAssets public_oe property

public $enableAssets

$hidePanelUrls public_oe property

public int $hidePanelUrls
Résultat integer

$profileModel public_oe property

public string $profileModel
Résultat string

$siteDescription public_oe property

public $siteDescription

$siteKeyWords public_oe property

public $siteKeyWords

$siteName public_oe property

public $siteName

$theme public_oe property

public $theme

$uploadPath public_oe property

public string $uploadPath
Résultat string