PHP Класс YupeModule

Наследование: extends yupe\components\WebModule
Показать файл Открыть проект

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

Свойство Тип Описание
$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)

Свойство Тип Описание
$backEndFilters array

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

Метод Описание
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 )

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

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

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

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

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

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

public getAllowedIp ( ) : array
Результат array

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

public getAuthItems ( ) : array
Результат array

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Выдает массив для меню в административной панеле
С версии: 0.5
public getLanguageSelectorArray ( ) : array
Результат array массив меню

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

Возвращаем массив языков:
public getLanguagesList ( ) : mixed
Результат mixed

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

public getLayoutsList ( ) : array
Результат array

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

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

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

Возвращаем массив меню:
public getNavigation ( ) : mixed
Результат mixed

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

public int $adminMenuOrder
Результат integer

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

public $allowedIp

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

public string $availableLanguages
Результат string

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

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

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

public string $backendLayout
Результат string

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

public $backendTheme

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

public $cache

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

public int $coreCacheTime
Результат integer

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

public string $coreModuleId
Результат string

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

public string $defaultBackendLanguage
Результат string

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

public string $defaultLanguage
Результат string

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

public $email

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

public string $emptyLayout
Результат string

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

public $enableAssets

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

public int $hidePanelUrls
Результат integer

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

public string $profileModel
Результат string

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

public $siteDescription

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

public $siteKeyWords

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

public $siteName

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

public $theme

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

public string $uploadPath
Результат string