Legacy_ModuleUninstallAction Class Reference
Module Uninstall function having possibility to extend by module developers.
More...
List of all members.
Detailed Description
Module Uninstall function having possibility to extend by module developers.
The precondition is that the specified module has been installed && none-actived.
Module developers can use their own custom-uninstaller in this action. Unlike the module update function, the standard uninstaller in this action is perhaps no problems. But, duplicatable modules or some modules with the special framework may need the custom-uninstaller.
See Legacy_ModuleUninstallAction::_getInstaller().
- $modversion['legacy_installer']['uninstaller']['class'] = {classname};
- $modversion['legacy_installer']['uninstaller']['namespace'] = {namespace}; (Optional)
- $modversion['legacy_installer']['uninstaller']['filepath'] = {filepath}; (Optional)
You must declare your sub-class of Legacy_ModuleUninstaller as {namespace}_{classname} in {filepath}. You must specify classname. Others are decided by the naming convention without your descriptions. Namespace is ucfirst(dirname). Filepath is "admin/class/{classname}.class.php".
For example, "news" module.
$modversion['legacy_installer']['uninstaller']['class'] = "Uninstaller";
You must declare News_Uninstaller in XOOPS_ROOT_PATH . "/modules/news/admin/class/Uninstallerr.class.php".
In the case where you specify the filepath, take care you describe the filepath with absolute path.
- Gets a instance of the uninstaller class through Legacy_ModuleUninstallAction::_getInstaller().
- Sets the current XoopsModule to the instance.
- Sets a value indicating whether an administrator hopes the force-mode, to the instance.
- Calls executeUninstall().
- See also:
- Legacy_ModuleUninstallAction::_getInstaller()
Legacy_ModuleUninstaller
Legacy_ModuleInstallUtils
- Todo:
- These classes are good to abstract again.
The documentation for this class was generated from the following file:
- C:/cube_beta/html/modules/legacy/admin/actions/ModuleUninstallAction.class.php
Generated on Thu Nov 2 00:27:13 2006 for XOOPS Cube Legacy by
1.5.1