Class: iHRIS Module ManageSalary: Difference between revisions
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
This article desrcibes the class '''iHRIS_Module_ManageSalary''' | This article desrcibes the class '''iHRIS_Module_ManageSalary'''. | ||
*Extends the class: [[Class: I2CE_Module | I2CE_Module]]. | |||
It is contained in the module [[iHRIS Module List#ihris-manage-Salary|ihris-manage-Salary]] in the package [https://launchpad.net/ihris-manage iHRIS Manage] | It is contained in the module [[iHRIS Module List#ihris-manage-Salary|ihris-manage-Salary]] in the package [https://launchpad.net/ihris-manage iHRIS Manage] | ||
| Line 27: | Line 28: | ||
been saved to the database. | been saved to the database. | ||
*Signature: protected function migrate() | *Signature: protected function migrate() | ||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean] | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | ||
===migrate326()=== | ===migrate326()=== | ||
Perform the migrate actions for this module from 3.2.5 to 3.2.6. | Perform the migrate actions for this module from 3.2.5 to 3.2.6. | ||
| Line 33: | Line 34: | ||
been saved to the database. | been saved to the database. | ||
*Signature: protected function migrate326() | *Signature: protected function migrate326() | ||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean] | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | ||
===post_update()=== | ===post_update()=== | ||
Post Update this module. | Post Update this module. | ||
*Signature: public function post_update($old_vers,$new_vers) | *Signature: public function post_update($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 | ||
===pre_migrate()=== | ===pre_migrate()=== | ||
Perform any pre migrate actions for this module. | Perform any pre migrate actions for this module. | ||
| Line 46: | Line 47: | ||
been saved to the database. | been saved to the database. | ||
*Signature: protected function pre_migrate() | *Signature: protected function pre_migrate() | ||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean] | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | ||
===pre_migrate326()=== | ===pre_migrate326()=== | ||
Perform any pre migrate actions for this module from 3.2.5 to 3.2.6. | Perform any pre migrate actions for this module from 3.2.5 to 3.2.6. | ||
| Line 52: | Line 53: | ||
been saved to the database. | been saved to the database. | ||
*Signature: protected function pre_migrate326() | *Signature: protected function pre_migrate326() | ||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean] | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | ||
===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) | ||
*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 | ||
==Inherited Fuzzy Methods== | ==Inherited Fuzzy Methods== | ||
Revision as of 22:27, 16 October 2009
This article desrcibes the class iHRIS_Module_ManageSalary.
- Extends the class: I2CE_Module.
It is contained in the module ihris-manage-Salary in the package iHRIS Manage
The class is defined in the file: modules/Salary/lib/iHRIS_Module_ManageSalary.php
iHRIS_Module_ManageSalary @subpackage Manage
- Author: Luke Duncan <lduncan@intrahealth.org>
- Since: 3.2.3
Variables
$do_migrate
A flag to determine if migrate needs to be called during post_update
- Type: protected n $do_migrate
$do_migrate326
A flag to determine if migrate326 needs to be called during post_update
- Type: protected n $do_migrate326
Methods
action_initialize()
Method called before the module is enabled for the first time. @param boolean -- returns true on success. false on error.
- Signature: public function action_initialize()
migrate()
Perform the migrate actions for this module. This is for going from pre 3.2 versions where benefit data has been saved to the database.
- Signature: protected function migrate()
- Returns: boolean
migrate326()
Perform the migrate actions for this module from 3.2.5 to 3.2.6. This is for going from pre 3.2 versions where benefit data has been saved to the database.
- Signature: protected function migrate326()
- Returns: boolean
post_update()
Post Update this module.
- Signature: public function post_update($old_vers,$new_vers)
- Returns: boolean
Parameters:
pre_migrate()
Perform any pre migrate actions for this module. This is for going from pre 3.2 versions where benefit data has been saved to the database.
- Signature: protected function pre_migrate()
- Returns: boolean
pre_migrate326()
Perform any pre migrate actions for this module from 3.2.5 to 3.2.6. This is for going from pre 3.2 versions where benefit data has been saved to the database.
- Signature: protected function pre_migrate326()
- Returns: boolean
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
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()
