PHPBoost Framework A.P.I.

ModulesManager

Package: PHPBoost\Module Copyright: © 2005-2019 PHPBoost License: GNU/GPL-3.0 Author: Benoit SAUTEL ben.popeye@phpboost.com Version: PHPBoost 5.2 - last update: 2019 01 12 Since: PHPBoost 2.0 - 2008 10 12 Contributor: Kevin MASSY reidlos@phpboost.com Contributor: Julien BRISWALTER j1.seth@phpboost.com Contributor: Arnaud GENET elenwii@phpboost.com Located at: phpboost/module/ModulesManager.class.php

This class enables you to manages the PHPBoost packages which are nothing else than the modules.

Methods summary
`public static Module[string]`	# `get_installed_modules_map( )` Returns Module[string] the Modules map (name => module) of the installed modules (activated or not)
`public static Module[string]`	# `get_activated_modules_map( )` Returns Module[string] the Modules map (name => module) of the installed modules (and activated )
`public static Module[string]`	# `get_uninstalled_modules_map( )` Returns Module[string] the Modules map (name => module) of the uninstalled modules (activated or not)
`public static Module[string]`	# `get_installed_modules_map_sorted_by_localized_name( )` Returns Module[string] the Modules map (name => module) of the installed modules (activated or not) sorted by name
`public static Module[string]`	# `get_activated_modules_map_sorted_by_localized_name( )` Returns Module[string] the Modules map (name => module) of the installed modules (and activated) sorted by name
`public static`	# `callback_sort_modules_by_name( Module $module1, Module $module2 )`
`public static string[]`	# `get_installed_modules_ids_list( )` Returns string[] the names list of the installed modules (activated or not)
`public static string[]`	# `get_activated_modules_ids_list( )` Returns string[] the names list of the installed modules (and activated)
`public static string[]`	# `get_activated_feature_modules( $feature_id )` Returns string[]
`public static Module`	# `get_module( $module_id )` Returns the requested module Returns the requested module Parameters `$module_id` id of the module Returns `Module` the requested module
`public static boolean`	# `is_module_installed( $module_id )` tells whether the requested module is installed (activated or not) tells whether the requested module is installed (activated or not) Returns boolean true if the requested module is installed
`public static boolean`	# `is_module_activated( $module_id )` tells whether the requested module is activated tells whether the requested module is activated Returns boolean true if the requested module is activated
`public static integer`	# `install_module( string $module_identifier, boolean $enable_module = true, $generate_cache = true )` Parameters `$module_identifier` Module identifier (name of its folder) `$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
`public static integer`	# `uninstall_module( integer $module_id, boolean $drop_files = false, $generate_cache = true )` Parameters `$module_id` Module id (in the DB_TABLE_MODULES table) `$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!
`public static`	# `upgrade_module( $module_identifier, $generate_cache = true )`
`public static`	# `module_is_upgradable( $module_identifier )`
`public static`	# `update_module( $module_id, $activated, $generate_cache = true )`
`public static`	# `set_module_activation( $module_id, boolean $activated )`
`public static string[]`	# `generate_unauthorized_module_option( $type )` Returns string[] the names list of the modules for unauthorized FormFieldSelectChoiceOption

Constants summary
`boolean`	`GENERATE_CACHE_AFTER_THE_OPERATION`	# `true`
`boolean`	`DO_NOT_GENERATE_CACHE_AFTER_THE_OPERATION`	# `false`
`integer`	`MODULE_UNINSTALLED`	# `0`
`integer`	`MODULE_INSTALLED`	# `1`
`integer`	`UNEXISTING_MODULE`	# `2`
`integer`	`MODULE_ALREADY_INSTALLED`	# `3`
`integer`	`CONFIG_CONFLICT`	# `4`
`integer`	`NOT_INSTALLED_MODULE`	# `5`
`integer`	`MODULE_FILES_COULD_NOT_BE_DROPPED`	# `6`
`integer`	`PHP_VERSION_CONFLICT`	# `7`
`integer`	`PHPBOOST_VERSION_CONFLICT`	# `8`
`integer`	`MODULE_NOT_UPGRADABLE`	# `9`
`integer`	`UPGRADE_FAILED`	# `10`
`integer`	`MODULE_UPDATED`	# `11`

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns