ModulesManager
in package
Class ModulesManager
Tags
Table of Contents
- SETTINGS_TABLE_NAME = 'modules_settings'
- TABLE_NAME = 'modules'
- $container : Container
- $database : Context
- $enabledModules : array<string|int, mixed>
- $localModules : LocalModules
- $routerList : RouteList
- $systemNotificationsManager : SystemNotificationsManager
- $updateManager : UpdateManager
- __construct() : mixed
- addRoute() : mixed
- Добавляет путь
- checkDependencies() : array<string|int, mixed>
- список модулей, мешающих работе модуля (не включенных, устаревших, не установленных)
- findAll() : array<string|int, mixed>
- Ищет все локальные модули
- findEnabledFromDb() : mixed
- Возвращает список включенных модулей из базы данных
- findInstalledFromDb() : mixed
- Возвращает список установленных модулей из базы данных
- getInfo() : ModuleInfo
- Возвращает информацию о модуле
- getInstance() : mixed
- Возвращает модуль по имени
- installModule() : array<string|int, mixed>
- Устанавливает модуль
- setEnable() : void
- Задает значение параметр включаем или выключен в таблицу
- uninstallModule() : bool
- Удаляет модуль из таблицы модулей
- updateModule() : bool
- updateVersionFromDB() : void
- Добавляет модуль в базу как установленный
- activatedModuleRecursive() : void
- включает все необходимые модуля для работы искомого (модули должны быть установленны)
- deactivateModuleList() : void
- отключает модули из списка
- dependencies() : array<string|int, mixed>
- Проверяет есть ли у модуля зависимости
- getTitleList() : array<string|int, mixed>
- список с namespace переводит в пользовательские названия
- initializationModuleAndDependencies() : void
- Инициализирует модуль и зависимости
- initializeModules() : mixed
- Инициализирует модули
- installModuleRecursive() : void
- Установлка всех модулей необходимых для работы $name
- installToDb() : mixed
- Добавляет запись о модуле в базу данных
- moduleIsEnabled() : bool
- модуль включен
- moduleIsInstall() : bool
- модуль установлен
- uninstallFromDb() : mixed
- Удаляет модуль из базы данных
- uninstallModulesList() : void
- просто удаляет модули по списку (понятно что они должны быть в правильном порядке, иначе может быть ошибка)
- updateModuleRecursive() : void
- обновляет все модули, если обновление необходимы, для работы $name
Constants
SETTINGS_TABLE_NAME
public
string
SETTINGS_TABLE_NAME
= 'modules_settings'
TABLE_NAME
public
string
TABLE_NAME
= 'modules'
Properties
$container
private
Container
$container
$database
private
Context
$database
$enabledModules
private
array<string|int, mixed>
$enabledModules
$localModules
private
LocalModules
$localModules
$routerList
private
RouteList
$routerList
$systemNotificationsManager
private
SystemNotificationsManager
$systemNotificationsManager
$updateManager
private
UpdateManager
$updateManager
Methods
__construct()
public
__construct(Container $container) : mixed
Parameters
- $container : Container
Tags
Return values
mixed —addRoute()
Добавляет путь
public
addRoute(string $mask[, array<string|int, mixed> $metadata = [] ], int $flags) : mixed
Parameters
- $mask : string
- $metadata : array<string|int, mixed> = []
- $flags : int
Return values
mixed —checkDependencies()
список модулей, мешающих работе модуля (не включенных, устаревших, не установленных)
public
checkDependencies(string $name) : array<string|int, mixed>
Parameters
- $name : string
Tags
Return values
array<string|int, mixed> —findAll()
Ищет все локальные модули
public
findAll() : array<string|int, mixed>
Return values
array<string|int, mixed> —findEnabledFromDb()
Возвращает список включенных модулей из базы данных
public
findEnabledFromDb() : mixed
Return values
mixed —findInstalledFromDb()
Возвращает список установленных модулей из базы данных
public
findInstalledFromDb() : mixed
Return values
mixed —getInfo()
Возвращает информацию о модуле
public
getInfo(string $name) : ModuleInfo
Parameters
- $name : string
-
Название модуля
Return values
ModuleInfo —getInstance()
Возвращает модуль по имени
public
getInstance(string $name) : mixed
Parameters
- $name : string
-
Название модуля
Tags
Return values
mixed —installModule()
Устанавливает модуль
public
installModule(string $name, bool $enable_after_install) : array<string|int, mixed>
Parameters
- $name : string
-
Название модуля
- $enable_after_install : bool
-
Флаг включать модуль после установки или нет
Tags
Return values
array<string|int, mixed> —setEnable()
Задает значение параметр включаем или выключен в таблицу
public
setEnable(string $name, bool $enabled) : void
Parameters
- $name : string
-
Название модуля
- $enabled : bool
-
Включен или выключен
Tags
Return values
void —uninstallModule()
Удаляет модуль из таблицы модулей
public
uninstallModule(string $name, bool $remove_settings, bool $remove_data[, bool $recursive = false ]) : bool
Parameters
- $name : string
-
Название модуля
- $remove_settings : bool
-
Удалять настройки или нет
- $remove_data : bool
-
Удалять данные или нет
- $recursive : bool = false
-
Удалять рекурсивно
Tags
Return values
bool —updateModule()
public
updateModule( $name) : bool
Parameters
Tags
Return values
bool —updateVersionFromDB()
Добавляет модуль в базу как установленный
public
updateVersionFromDB( $module_name) : void
Parameters
Tags
Return values
void —activatedModuleRecursive()
включает все необходимые модуля для работы искомого (модули должны быть установленны)
private
activatedModuleRecursive(string $name[, array<string|int, mixed> &$activatedList = array() ]) : void
Parameters
- $name : string
-
- название модуля
- $activatedList : array<string|int, mixed> = array()
-
- будет содержать список включенных модулей
Tags
Return values
void —deactivateModuleList()
отключает модули из списка
private
deactivateModuleList(array<string|int, mixed> $listModules) : void
Parameters
- $listModules : array<string|int, mixed>
-
- список с названиями модулей
Tags
Return values
void —dependencies()
Проверяет есть ли у модуля зависимости
private
dependencies(string $name) : array<string|int, mixed>
Parameters
- $name : string
-
Название модуля
Return values
array<string|int, mixed> —getTitleList()
список с namespace переводит в пользовательские названия
private
getTitleList(array<string|int, mixed> $moduleNames) : array<string|int, mixed>
Parameters
- $moduleNames : array<string|int, mixed>
Return values
array<string|int, mixed> —initializationModuleAndDependencies()
Инициализирует модуль и зависимости
private
initializationModuleAndDependencies(IModule $moduleInstance) : void
Parameters
- $moduleInstance : IModule
Tags
Return values
void —initializeModules()
Инициализирует модули
private
initializeModules() : mixed
Tags
Return values
mixed —installModuleRecursive()
Установлка всех модулей необходимых для работы $name
private
installModuleRecursive(string $name[, array<string|int, mixed> &$installList = array() ]) : void
Parameters
- $name : string
-
устанавливаемый модуль
- $installList : array<string|int, mixed> = array()
-
- будет содержать список установленных модулей
Tags
Return values
void —installToDb()
Добавляет запись о модуле в базу данных
private
installToDb( $name, $version, $enabled) : mixed
Parameters
Return values
mixed —moduleIsEnabled()
модуль включен
private
moduleIsEnabled(string $moduleMame) : bool
Parameters
- $moduleMame : string
Return values
bool —moduleIsInstall()
модуль установлен
private
moduleIsInstall(string $moduleMame) : bool
Parameters
- $moduleMame : string
Return values
bool —uninstallFromDb()
Удаляет модуль из базы данных
private
uninstallFromDb(string $name, bool $remove_settings) : mixed
Parameters
- $name : string
-
Название модуля
- $remove_settings : bool
-
Флаг удалять настройки модуля или оставить
Return values
mixed —uninstallModulesList()
просто удаляет модули по списку (понятно что они должны быть в правильном порядке, иначе может быть ошибка)
private
uninstallModulesList(array<string|int, mixed> $listModules[, bool $remove_settings = true ][, bool $remove_data = true ]) : void
Parameters
- $listModules : array<string|int, mixed>
-
- список названий модулей
- $remove_settings : bool = true
-
- Удалять настройки
- $remove_data : bool = true
-
- удалять данные
Tags
Return values
void —updateModuleRecursive()
обновляет все модули, если обновление необходимы, для работы $name
private
updateModuleRecursive(string $name[, array<string|int, mixed> &$updateList = array() ]) : void
Parameters
- $name : string
-
- модуль для которого проводяться обновления
- $updateList : array<string|int, mixed> = array()
-
- будет содержать список обновленных модулей