PHP Класс yupe\components\ModuleManager

Наследование: extends CApplicationComponent
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$category
$categoryIcon
$categorySort
$otherCategoryName

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

Метод Описание
getCreateModule ( array $name ) : array Подгружает модуль
getModules ( boolean $navigationOnly = false, boolean $disableModule = false ) : mixed Возвращаем список модулей:
getModulesConfig ( boolean $module = false ) : string Получаем путь к папке или файлу с конфигурацией модуля(-ей)
getModulesConfigBack ( string $module = '' ) : string Получаем путь к папке или файлу с резервной конфигурацией модуля(-ей)
getModulesConfigDefault ( string $module = '' ) : string Получаем путь к папке c дефолтной конфигурацией модуля
getModulesDisabled ( array $enableModule = [] ) : array Подгружает и выдает список отключенных модулей
isValidModule ( string $module ) : boolean Метод проверяет является ли каталог валидным модулем Yii/Yupe
updateModuleConfig ( WebModule $module ) : boolean Обновить конфигурационный файл модуля

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

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

Подгружает модуль
С версии: 0.5
public getCreateModule ( array $name ) : array
$name array - имя модуля
Результат array класс модуля

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

Возвращаем список модулей:
public getModules ( boolean $navigationOnly = false, boolean $disableModule = false ) : mixed
$navigationOnly boolean - только навигация
$disableModule boolean - отключённые модули
Результат mixed

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

Получаем путь к папке или файлу с конфигурацией модуля(-ей)
С версии: 0.5
public getModulesConfig ( boolean $module = false ) : string
$module boolean - Имя модуля
Результат string путь к папке или файлу с конфигурацией модуля(-ей)

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

Получаем путь к папке или файлу с резервной конфигурацией модуля(-ей)
С версии: 0.5
public getModulesConfigBack ( string $module = '' ) : string
$module string Имя модуля
Результат string путь к папке или файлу с резервной конфигурацией модуля(-ей)

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

Получаем путь к папке c дефолтной конфигурацией модуля
С версии: 0.5
public getModulesConfigDefault ( string $module = '' ) : string
$module string Имя модуля
Результат string путь к папке c дефолтной конфигурацией модуля или путь к модулям

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

Подгружает и выдает список отключенных модулей
С версии: 0.5
public getModulesDisabled ( array $enableModule = [] ) : array
$enableModule array - список активных модулей, по умолчанию array()
Результат array список отключенных модулей

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

Метод проверяет является ли каталог валидным модулем Yii/Yupe
С версии: 0.6
public isValidModule ( string $module ) : boolean
$module string - ID модуля
Результат boolean true - модуль валиде false - нет

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

Обновить конфигурационный файл модуля
С версии: 0.8
public updateModuleConfig ( WebModule $module ) : boolean
$module WebModule
Результат boolean

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

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

public $category

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

public $categoryIcon

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

public $categorySort

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

public $otherCategoryName