Class: iHRIS Module Facility: Difference between revisions
From IHRIS Wiki
No edit summary |
No edit summary |
||
| Line 8: | Line 8: | ||
==Methods== | ==Methods== | ||
===pre_upgrade()=== | ===pre_upgrade()=== | ||
Run the pre upgrade for this module. This can use the old config data before it | Run the pre upgrade for this module. This can use the old config data before it has been changed from the config. | ||
has been changed from the config. | |||
*Signature: public function pre_upgrade($old_vers,$new_vers,$new_storage) | *Signature: public function pre_upgrade($old_vers,$new_vers,$new_storage) | ||
*Parameters: | |||
** [http://www.php.net/manual/en/language.types.string.php string ] $old_vers | |||
** [http://www.php.net/manual/en/language.types.string.php string ] $new_vers | |||
** [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $new_storage | |||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | ||
===upgrade()=== | ===upgrade()=== | ||
Upgrade this module if necessary | Upgrade this module if necessary | ||
*Signature: public function upgrade($old_vers,$new_vers) | *Signature: public function upgrade($old_vers,$new_vers) | ||
*Parameters: | |||
** [http://www.php.net/manual/en/language.types.string.php string ] $old_vers | |||
** [http://www.php.net/manual/en/language.types.string.php string ] $new_vers | |||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | ||
==Inherited Fuzzy Methods== | ==Inherited Fuzzy Methods== | ||
===launchBackgroundProcess()=== | ===launchBackgroundProcess()=== | ||
Revision as of 22:40, 16 October 2009
This article desrcibes the class iHRIS_Module_Facility.
- Extends the class: I2CE_Module.
- Location: Part of the module Facility in the package iHRIS Common
- Source: Defined in the file modules/Facility/lib/iHRIS_Module_Facility.php
- Author: Luke Duncan <lduncan@intrahealth.org>
- Since: 3.2.3
I2CE_Module_Facility
Methods
pre_upgrade()
Run the pre upgrade for this module. This can use the old config data before it has been changed from the config.
- Signature: public function pre_upgrade($old_vers,$new_vers,$new_storage)
- Parameters:
- string $old_vers
- string $new_vers
- I2CE_MagicDataNode $new_storage
- Returns: boolean
upgrade()
Upgrade this module if necessary
- Signature: public function upgrade($old_vers,$new_vers)
- Parameters:
- Returns: boolean
Inherited Fuzzy Methods
launchBackgroundProcess()
This method is inherited from I2CE_Module->launchBackgroundProcess()
launchBackgroundPHPScript()
This method is inherited from I2CE_Module->launchBackgroundPHPScript()
launchBackgroundPage()
This method is inherited from I2CE_Module->launchBackgroundPage()
userMessage()
This method is inherited from I2CE_Fuzzy->userMessage()
