PHP Class YupeModule

Inheritance: extends yupe\components\WebModule
Show file Open project: yupe/yupe

Public Properties

Property 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

Property Type Description
$backEndFilters array

Public Methods

Method 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 method

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

checkSelf() public method

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

getAllowedIp() public method

public getAllowedIp ( ) : array
return array

getAuthItems() public method

public getAuthItems ( ) : array
return array

getAuthor() public method

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

getAuthorEmail() public method

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

getBackendFilters() public method

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

getBackendLayoutAlias() public method

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

getCategory() public method

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

getDependencies() public method

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

getDescription() public method

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

getEditableParams() public method

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

getEditableParamsGroups() public method

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

getIcon() public method

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

getIsInstallDefault() public method

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

getIsNoDisable() public method

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

getLanguageSelectorArray() public method

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

getLanguagesList() public method

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

getLayoutsList() public method

public getLayoutsList ( ) : array
return array

getName() public method

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

getNavigation() public method

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

getParamsLabels() public method

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

getSubMenu() public method

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

getThemeBaseUrl() public method

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

getThemes() public method

Для добавления новой темы необходимо: Прочитать 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 - вернет темы оформления для панели управления, иначе - для публичной части сайта
return array список доступных тем

getUrl() public method

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

getVersion() public method

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

poweredBy() public method

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

rules() public method

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

setBackendFilters() public method

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

Property Details

$adminMenuOrder public property

public int $adminMenuOrder
return integer

$allowedIp public property

public $allowedIp

$availableLanguages public property

public string $availableLanguages
return string

$backEndFilters protected property

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

$backendLayout public property

public string $backendLayout
return string

$backendTheme public property

public $backendTheme

$cache public property

public $cache

$coreCacheTime public property

public int $coreCacheTime
return integer

$coreModuleId public property

public string $coreModuleId
return string

$defaultBackendLanguage public property

public string $defaultBackendLanguage
return string

$defaultLanguage public property

public string $defaultLanguage
return string

$email public property

public $email

$emptyLayout public property

public string $emptyLayout
return string

$enableAssets public property

public $enableAssets

$hidePanelUrls public property

public int $hidePanelUrls
return integer

$profileModel public property

public string $profileModel
return string

$siteDescription public property

public $siteDescription

$siteKeyWords public property

public $siteKeyWords

$siteName public property

public $siteName

$theme public property

public $theme

$uploadPath public property

public string $uploadPath
return string