Class: iHRIS Module Facility: Difference between revisions
From IHRIS Wiki
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
This article desrcibes the class '''iHRIS_Module_Facility''' | This article desrcibes the class '''iHRIS_Module_Facility'''. | ||
*Extends the class: [[Class: I2CE_Module | I2CE_Module]]. | |||
It is contained in the module [[iHRIS Module List#Facility|Facility]] in the package [https://launchpad.net/ihris-common iHRIS Common] | It is contained in the module [[iHRIS Module List#Facility|Facility]] in the package [https://launchpad.net/ihris-common iHRIS Common] | ||
| Line 13: | Line 14: | ||
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) | ||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean] | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | ||
Parameters: | 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 ] $old_vers | ||
* [http://www.php.net/manual/en/language.types.string.php string] $new_vers | * [http://www.php.net/manual/en/language.types.string.php string ] $new_vers | ||
* [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $new_storage | * [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $new_storage | ||
===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) | ||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean] | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | ||
Parameters: | 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 ] $old_vers | ||
* [http://www.php.net/manual/en/language.types.string.php string] $new_vers | * [http://www.php.net/manual/en/language.types.string.php string ] $new_vers | ||
==Inherited Fuzzy Methods== | ==Inherited Fuzzy Methods== | ||
===launchBackgroundProcess()=== | ===launchBackgroundProcess()=== | ||
Revision as of 22:24, 16 October 2009
This article desrcibes the class iHRIS_Module_Facility.
- Extends the class: I2CE_Module.
It is contained in the module Facility in the package iHRIS Common
The class is defined in the file: modules/Facility/lib/iHRIS_Module_Facility.php
I2CE_Module_Facility @subpackage Common
- Author: Luke Duncan <lduncan@intrahealth.org>
- Since: 3.2.3
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)
- Returns: boolean
Parameters:
- string $old_vers
- string $new_vers
- I2CE_MagicDataNode $new_storage
upgrade()
Upgrade this module if necessary
- Signature: public function upgrade($old_vers,$new_vers)
- Returns: boolean
Parameters:
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()
