PHP 클래스 YupeModule

상속: extends yupe\components\WebModule
파일 보기 프로젝트 열기: yupe/yupe

공개 프로퍼티들

프로퍼티 타입 설명
$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

보호된 프로퍼티들

프로퍼티 타입 설명
$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