Module Uninstall function having possibility to extend by module developers. More...

Inheritance diagram for Legacy_ModuleUninstallAction:

Public Member Functions
	__construct ($flag)

	prepare (&$controller, &$xoopsUser)

&	_getInstaller ()

	_setupActionForm ()

	getDefaultView (&$controller, &$xoopsUser)

	execute (&$controller, &$xoopsUser)

	executeViewSuccess (&$controller, &$xoopsUser, &$renderer)

	executeViewInput (&$controller, &$xoopsUser, &$renderer)

	executeViewCancel (&$controller, &$xoopsUser, &$renderer)

Public Member Functions inherited from Legacy_Action
	Legacy_Action ($adminFlag=false)

	hasPermission (&$controller, &$xoopsUser)

	executeViewError (&$controller, &$xoopsUser, &$render)

	executeViewIndex (&$controller, &$xoopsUser, &$render)

	executeViewPreview (&$controller, &$xoopsUser, &$render)

Data Fields
	$mUninstallSuccess = null

	$mUninstallFail = null

	$mXoopsModule = null

	$mInstaller = null

	$mActionForm = null

Data Fields inherited from Legacy_Action
	$_mAdminFlag = false

Detailed Description

Module Uninstall function having possibility to extend by module developers.

The precondition is that the specified module has been installed && none-actived.

The custom-uninstaller

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.

Convention

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.

Install Process

Gets an 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().