Summary
- File
- Package hierarchy PHPBoost\Module
- Class hierarchy \ModulesManager
This class enables you to manages the PHPBoost packages which are nothing else than the modules.
Class ModulesManager
Methods
get_installed_modules_map()
get_installed_modules_map() : \Module[string]
Returns
\Module[string]
—
the Modules map (name => module) of the installed modules (activated or not)
static
- Inherited from \ModulesManager
Tags
| None found |
get_activated_modules_map()
get_activated_modules_map() : \Module[string]
Returns
\Module[string]
—
the Modules map (name => module) of the installed modules (and activated )
static
- Inherited from \ModulesManager
Tags
| None found |
get_uninstalled_modules_map()
get_uninstalled_modules_map() : \Module[string]
Returns
\Module[string]
—
the Modules map (name => module) of the uninstalled modules (activated or not)
static
- Inherited from \ModulesManager
Tags
| None found |
get_installed_modules_map_sorted_by_localized_name()
get_installed_modules_map_sorted_by_localized_name() : \Module[string]
Returns
\Module[string]
—
the Modules map (name => module) of the installed modules (activated or not) sorted by name
static
- Inherited from \ModulesManager
Tags
| None found |
get_activated_modules_map_sorted_by_localized_name()
get_activated_modules_map_sorted_by_localized_name() : \Module[string]
Returns
\Module[string]
—
the Modules map (name => module) of the installed modules (and activated) sorted by name
static
- Inherited from \ModulesManager
Tags
| None found |
callback_sort_modules_by_name()
callback_sort_modules_by_name(\Module $module1, \Module $module2)
Parameters
static
- Inherited from \ModulesManager
Tags
| None found |
get_installed_modules_ids_list()
get_installed_modules_ids_list() : array<mixed,string>
Returns
array<mixed,string>
—
the names list of the installed modules (activated or not)
static
- Inherited from \ModulesManager
Tags
| None found |
get_activated_modules_ids_list()
get_activated_modules_ids_list() : array<mixed,string>
Returns
array<mixed,string>
—
the names list of the installed modules (and activated)
static
- Inherited from \ModulesManager
Tags
| None found |
get_activated_feature_modules()
get_activated_feature_modules( $feature_id) : array<mixed,string>
Parameters
| $feature_id |
Returns
array<mixed,string>
static
- Inherited from \ModulesManager
Tags
| None found |
get_module()
get_module( $module_id) : \ModuleReturns the requested module
Parameters
| $module_id | the id of the module |
Returns
\Module
—
the requested module
static
- Inherited from \ModulesManager
Tags
| None found |
is_module_installed()
is_module_installed( $module_id) : booleantells whether the requested module is installed (activated or not)
Parameters
| $module_id |
Returns
boolean
—
true if the requested module is installed
static
- Inherited from \ModulesManager
Tags
| None found |
is_module_activated()
is_module_activated( $module_id) : booleantells whether the requested module is activated
Parameters
| $module_id |
Returns
boolean
—
true if the requested module is activated
static
- Inherited from \ModulesManager
Tags
| None found |
install_module()
install_module(string $module_identifier, boolean $enable_module = true, $generate_cache = true) : integer
Parameters
| string | $module_identifier | Module identifier (name of its folder) |
| boolean | $enable_module | true if you want the module to be enabled, otherwise false. |
| $generate_cache |
Returns
integer
—
One of the following error codes:
- MODULE_INSTALLED: the installation succeded
- MODULE_ALREADY_INSTALLED: the module is already installed
- UNEXISTING_MODULE: the module you want to install doesn't exist
- PHP_VERSION_CONFLICT: the server PHP version is two old to be able to run the module code (config set in the config.ini module file)
- CONFIG_CONFLICT: the configuration field is already used
static
- Inherited from \ModulesManager
Tags
| static |
Installs a module. |
uninstall_module()
uninstall_module(integer $module_id, boolean $drop_files = false, $generate_cache = true) : integer
Parameters
| integer | $module_id | Module id (in the DB_TABLE_MODULES table) |
| boolean | $drop_files | true if you want the module files to be dropped, otherwise false. |
| $generate_cache |
Returns
integer
—
One of the following error codes:
- MODULE_FILES_COULD_NOT_BE_DROPPED: the module files couldn't be deleted (probably due to an authorization issue) but it has been uninstalled .
- MODULE_UNINSTALLED: the module was successfully uninstalled.
- NOT_INSTALLED_MODULE: the module to uninstall doesn't exist!
static
- Inherited from \ModulesManager
Tags
| static |
Uninstalls a module. |
upgrade_module()
upgrade_module( $module_identifier, $generate_cache = true)
Parameters
| $module_identifier | ||
| $generate_cache |
static
- Inherited from \ModulesManager
Tags
| None found |
module_is_upgradable()
module_is_upgradable( $module_identifier)
Parameters
| $module_identifier |
static
- Inherited from \ModulesManager
Tags
| None found |
update_module()
update_module( $module_id, $activated, $generate_cache = true)
Parameters
| $module_id | ||
| $activated | ||
| $generate_cache |
static
- Inherited from \ModulesManager
Tags
| None found |
set_module_activation()
set_module_activation( $module_id, \bool $activated)
Parameters
| $module_id | ||
| \bool | $activated |
static
- Inherited from \ModulesManager
Tags
| None found |
generate_unauthorized_module_option()
generate_unauthorized_module_option( $type) : array<mixed,string>
Parameters
| $type |
Returns
array<mixed,string>
—
the names list of the modules for unauthorized FormFieldSelectChoiceOption
static
- Inherited from \ModulesManager
Tags
| None found |
execute_module_installation()
execute_module_installation( $module_id)
Parameters
| $module_id |
static
- Inherited from \ModulesManager
Tags
| None found |
execute_module_uninstallation()
execute_module_uninstallation( $module_id)
Parameters
| $module_id |
static
- Inherited from \ModulesManager
Tags
| None found |
execute_module_upgrade()
execute_module_upgrade( $module_id, $installed_version)
Parameters
| $module_id | ||
| $installed_version |
static
- Inherited from \ModulesManager
Tags
| None found |
get_module_setup()
get_module_setup(string $module_id) : \ModuleSetup
Parameters
| string | $module_id |
Returns
static
- Inherited from \ModulesManager
Tags
| None found |
module_setup_exists()
module_setup_exists( $module_setup_classname)
Parameters
| $module_setup_classname |
static
- Inherited from \ModulesManager
Tags
| None found |
update_class_list()
update_class_list()
static
- Inherited from \ModulesManager
Tags
| None found |
Constants
GENERATE_CACHE_AFTER_THE_OPERATION
GENERATE_CACHE_AFTER_THE_OPERATION = true
Tags
| None found |
DO_NOT_GENERATE_CACHE_AFTER_THE_OPERATION
DO_NOT_GENERATE_CACHE_AFTER_THE_OPERATION = false
Tags
| None found |
MODULE_UNINSTALLED
MODULE_UNINSTALLED = 0
Tags
| None found |
MODULE_INSTALLED
MODULE_INSTALLED = 1
Tags
| None found |
UNEXISTING_MODULE
UNEXISTING_MODULE = 2
Tags
| None found |
MODULE_ALREADY_INSTALLED
MODULE_ALREADY_INSTALLED = 3
Tags
| None found |
CONFIG_CONFLICT
CONFIG_CONFLICT = 4
Tags
| None found |
NOT_INSTALLED_MODULE
NOT_INSTALLED_MODULE = 5
Tags
| None found |
MODULE_FILES_COULD_NOT_BE_DROPPED
MODULE_FILES_COULD_NOT_BE_DROPPED = 6
Tags
| None found |
PHP_VERSION_CONFLICT
PHP_VERSION_CONFLICT = 7
Tags
| None found |
PHPBOOST_VERSION_CONFLICT
PHPBOOST_VERSION_CONFLICT = 8
Tags
| None found |
MODULE_NOT_UPGRADABLE
MODULE_NOT_UPGRADABLE = 9
Tags
| None found |
UPGRADE_FAILED
UPGRADE_FAILED = 10
Tags
| None found |
MODULE_UPDATED
MODULE_UPDATED = 11
Tags
| None found |