Legacy_ModuleUpdateAction Class Reference
Module Update function having possibility to extend by module developers.
More...
List of all members.
Detailed Description
Module Update function having possibility to extend by module developers.
The precondition is that the specified module has been installed.
Module developers can use their own custom-update-installer in this action. This function uses Legacy_ModulePhasedUpgrader to update moudles. But, this class can't smart update modules correctly & automatically, because the module updat 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.
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 you describe the filepath with absolute path.
- Gets a 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().
- See also:
- Legacy_ModuleUpdateAction::_getInstaller()
Legacy_ModulePhasedUpgrader
Legacy_ModuleInstallUtils
Member Function Documentation
Legacy_ModuleUpdateAction::_getInstaller |
( |
|
) |
|
Creates a instance of the upgrade installer to mInstaller. And returns it.
The precondition is the existence of mXoopsModule.
The documentation for this class was generated from the following file:
- C:/cube_beta/html/modules/legacy/admin/actions/ModuleUpdateAction.class.php
Generated on Thu Nov 2 00:27:13 2006 for XOOPS Cube Legacy by
1.5.1