modules
Packages
Interfaces
Classes
Files

Class: PackagesManager

Source Location: /modules/packages_manager.class.php [line 48]

Class Overview


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

Author(s):



Class Details

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

Tags:

[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]


Class Methods

static method install_module [line 65]

static int install_module( string $module_identifier, [bool $enable_module = true], [bool $generate_cache = GENERATE_CACHE_AFTER_THE_OPERATION])
Installs a module.

Tags:

  • return: 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</i>

Parameters:

string   $module_identifier   Module identifier (name of its folder)
bool   $enable_module   true if you want the module to be enabled, otherwise false.
bool   $generate_cache   GENERATE_CACHE_AFTER_THE_OPERATION if you want to regenerate the cache after the installation or DO_NOT_GENERATE_CACHE_AFTER_THE_OPERATION if you want to go on a new package operation.
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]

static method uninstall_module [line 191]

static int uninstall_module( int $module_id, bool $drop_files)
Uninstalls a module.

Tags:

  • return: 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!

Parameters:

int   $module_id   Module id (in the DB_TABLE_MODULES table)
bool   $drop_files   true if you want the module files to be dropped, otherwise false.
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]

Documentation generated on Tue, 28 Jul 2009 22:43:41 +0200 by phpDocumentor 1.4.1