Class Legacy_ModulePhasedUpgrader
Legacy_ModuleInstallUtils
Brief: The framework for the phased update.
Section: Description You can make your own custom-update-installer for your modules with the sub-class of this class. It's easy to make by many utility functions. You can write your sub-class as well as batch files. 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".
Section: Convention Module Update function build the current-$xoopsModule from DB, and then sets it to this class through setCurrentXoopsModule(). Basically, you can access it by $this->_mCurrentXoopsModule. And, that function build the target-$xoopsModule from xoops_version, and then set it to this class through setTargetXoopsModule(). Also you can access it by $this->_mTargetXoopsModule.
Located at html/modules/legacy/admin/class/ModuleUpdater.class.php
public
|
|
public
|
|
public
|
#
setCurrentXoopsModule(
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. |
public
|
|
public
|
#
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
integer
|
|
public
|
#
getTargetPhase( )
Gets the target varsion number at this time. In the case where there are milestones, gets the nearest value from the current version. |
public
|
|
public
boolean
|
|
public
boolean
|
#
isLatestUpgrade( )
Gets a valude indicating whether this process is upgrade for the latest version. |
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
boolean
|
#
executeAutomaticUpgrade( )
This method executes upgrading automatically by the diff of xoops_version. |
public
array
|
$_mMilestone | array() |
#
This is an array of milestone version informations. Key is a version number. Value is a method name called by execute(). |
public
|
$mLog | null |
#
This instance is prepared automatically in the constructor. |
public
|
$_mCurrentXoopsModule |
|
|
public
integer
|
$_mCurrentVersion |
|
|
public
|
$_mTargetXoopsModule |
|
|
public
integer
|
$_mTargetVersion |
|
|
public
boolean
|
$_mForceMode | false |