Public Member Functions | |
setForceMode ($isForceMode) | |
setCurrentXoopsModule (&$xoopsModule) | |
setTargetXoopsModule (&$xoopsModule) | |
executeUpgrade () | |
getCurrentVersion () | |
getTargetPhase () | |
hasUpgradeMethod () | |
_callUpgradeMethod () | |
isLatestUpgrade () | |
saveXoopsModule (&$module) | |
_updateModuleTemplates () | |
_updateBlocks () | |
_updatePreferences () | |
executeAutomaticUpgrade () | |
_upgradePreferences () | |
Public Attributes | |
$_mMilestone = array() |
On Legacy System module, upgrade is called when users try to update. So you must implement your sub-class for also correct update. For example, the custom-update-install have to update module templates & block templates, because users expect that the module-update function does it.
For the custom-update-install, Legacy_ModuleInstallUtils is good for you. Plus, this class has some usefull static methods for upgrade. Such functions have notes as "The utility method for the custom-update-installer".
And, this class as the template-pattern has some methods you may override. These methods have note as "You may do custom".
Legacy_ModulePhasedUpgrader::setForceMode | ( | $ | isForceMode | ) |
Sets a value indicating whether the force mode is on.
bool | $isForceMode |
Legacy_ModulePhasedUpgrader::setCurrentXoopsModule | ( | &$ | xoopsModule | ) |
Sets the current XoopsModule. This method creates the clone of this object to prevent cache of the module handler, and then keep it to the property. Plus, this method copies the version value of this object to the _mCurrentVersion as backup for the case where the value of this object is changed for updating.
XoopsModule | $xoopsModule |
Legacy_ModulePhasedUpgrader::setTargetXoopsModule | ( | &$ | xoopsModule | ) |
Sets the target XoopsModule.
public
XoopsModule | $xoopsModule |
Legacy_ModulePhasedUpgrader::executeUpgrade | ( | ) |
Execute upgrade. If the specific method for the milestone, this method calls the method. If such milestone doesn't exist, call the automatic upgrade method.
public
Legacy_ModulePhasedUpgrader::getCurrentVersion | ( | ) |
Gets the current version.
Legacy_ModulePhasedUpgrader::getTargetPhase | ( | ) |
Gets the target varsion number at this time. In the case where there are milestones, gets the nearest value from the current version.
Of course, this class is good to override by the sub-class.
Legacy_ModulePhasedUpgrader::hasUpgradeMethod | ( | ) |
Gets the valude indicating whether this class
Legacy_ModulePhasedUpgrader::_callUpgradeMethod | ( | ) |
Dispatches the callback upgrade program.
protected
Legacy_ModulePhasedUpgrader::isLatestUpgrade | ( | ) |
Gets a valude indicating whether this process is upgrade for the latest version.
Legacy_ModulePhasedUpgrader::saveXoopsModule | ( | &$ | module | ) |
Saves XoopsModule object to DB.
protected
Legacy_ModulePhasedUpgrader::_updateModuleTemplates | ( | ) |
Updates all of module templates.
protected
Legacy_ModulePhasedUpgrader::_updateBlocks | ( | ) |
Updates all of blocks.
protected
Legacy_ModulePhasedUpgrader::_updatePreferences | ( | ) |
Updates all of preferences & notifications.
protected
Legacy_ModulePhasedUpgrader::executeAutomaticUpgrade | ( | ) |
This method executes upgrading automatically by the diff of xoops_version.
1) Uninstall all of module templates 2) Install all of module templates
Legacy_ModulePhasedUpgrader::_upgradePreferences | ( | ) |
Tries to smart update all of preferences & notifications.
Legacy_ModulePhasedUpgrader::$_mMilestone = array() |
This is an array of milestone version informations. Key is a version number. Value is a method name called by execute().
Format: {version} => {methodName}
Example: var $_mMilestone = array('020' => 'update020', '025' => 'update025');
protected