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

Inheritance diagram for Legacy_ModuleUpdateAction:

Public Member Functions
	prepare (&$controller, &$xoopsUser)

	_setupActionForm ()

&	_getInstaller ()

	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)

	__construct ($adminFlag=false)

	hasPermission (&$controller, &$xoopsUser)

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

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

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

Data Fields
	$mUpdateSuccess = null

	$mUpdateFail = null

	$mXoopsModule = null

	$mInstaller = null

Data Fields inherited from Legacy_Action
	$_mAdminFlag = false

Protected Attributes
	$mActionForm

	$mErrorMessages

	$mModuleObjects

Detailed Description

Module Update function having possibility to extend by module developers.

The precondition is that the specified module has been installed.

The custom-update-installer

Module developers can use their own custom-update-installer in this action. This function uses Legacy_ModulePhasedUpgrader to update modules. But, this class can't smart update modules correctly & automatically, because the module update function bases on XOOPS2 JP spec. We have no rules to declare modules strictly.

To solve it, module developers should use the custom-update-installer, because module developers know detail changelog of their module.

Convention

See Legacy_ModuleUpdateAction\_getInstaller().

$modversion['legacy_installer']['updater']['class'] = {classname};
$modversion['legacy_installer']['updater']['namespace'] = {namespace}; (Optional)
$modversion['legacy_installer']['updater']['filepath'] = {filepath}; (Optional)

You must declare your sub-class of Legacy_ModulePhasedUpgrader 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']['updater']['class'] = "Updater";

You must declare News_Updater in XOOPS_ROOT_PATH . "/modules/news/admin/class/Updater.class.php".

In the case where you specify the filepath, take care to describe the filepath with absolute path.

Install Process

Gets an instance of the update installer class through Legacy_ModuleUpdateAction\_getInstaller().
Sets the current XoopsModule to the instance.
Builds the target XoopsModule from xoops_version, and sets it to the instance.
Sets a value indicating whether an administrator hopes the force-mode, to the instance.
Calls executeUpgrade().