Class: iHRIS Module ManageSalary: Difference between revisions
From IHRIS Wiki
No edit summary |
No edit summary |
||
| Line 2: | Line 2: | ||
*Extends the class: [[Class: I2CE_Module | I2CE_Module]]. | *Extends the class: [[Class: I2CE_Module | I2CE_Module]]. | ||
*Location: Part of the module [[iHRIS Manage Module List#ihris-manage-Salary|ihris-manage-Salary]] in the package [https://launchpad.net/ihris-manage iHRIS Manage] | *Location: Part of the module [[iHRIS Manage Module List#ihris-manage-Salary|ihris-manage-Salary]] in the package [https://launchpad.net/ihris-manage iHRIS Manage] | ||
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0. | *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.2-release/annotate/head:/modules/Salary/lib/iHRIS_Module_ManageSalary.php#L31 modules/Salary/lib/iHRIS_Module_ManageSalary.php] on line 31 | ||
*Author: Luke Duncan <lduncan@intrahealth.org> | *Author: Luke Duncan <lduncan@intrahealth.org> | ||
*Since: 3.2.3 | *Since: 3.2.3 | ||
| Line 9: | Line 9: | ||
===$do_migrate=== | ===$do_migrate=== | ||
A flag to determine if migrate needs to be called during post_update | A flag to determine if migrate needs to be called during post_update | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.2-release/annotate/head:/modules/Salary/lib/iHRIS_Module_ManageSalary.php#L37 manage/modules/Salary/lib/iHRIS_Module_ManageSalary.php] on line 37 | |||
*Type: protected [http://www.php.net/manual/en/language.types.boolean.php boolean ] $do_migrate | *Type: protected [http://www.php.net/manual/en/language.types.boolean.php boolean ] $do_migrate | ||
===$do_migrate326=== | ===$do_migrate326=== | ||
A flag to determine if migrate326 needs to be called during post_update | A flag to determine if migrate326 needs to be called during post_update | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.2-release/annotate/head:/modules/Salary/lib/iHRIS_Module_ManageSalary.php#L41 manage/modules/Salary/lib/iHRIS_Module_ManageSalary.php] on line 41 | |||
*Type: protected [http://www.php.net/manual/en/language.types.boolean.php boolean ] $do_migrate326 | *Type: protected [http://www.php.net/manual/en/language.types.boolean.php boolean ] $do_migrate326 | ||
| Line 18: | Line 20: | ||
===action_initialize()=== | ===action_initialize()=== | ||
Method called before the module is enabled for the first time. @param boolean -- returns true on success. false on error. | Method called before the module is enabled for the first time. @param boolean -- returns true on success. false on error. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.2-release/annotate/head:/modules/Salary/lib/iHRIS_Module_ManageSalary.php#L121 manage/modules/Salary/lib/iHRIS_Module_ManageSalary.php] on line 121 | |||
*Signature: public function action_initialize() | *Signature: public function action_initialize() | ||
===migrate()=== | ===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. | 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. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.2-release/annotate/head:/modules/Salary/lib/iHRIS_Module_ManageSalary.php#L80 manage/modules/Salary/lib/iHRIS_Module_ManageSalary.php] on line 80 | |||
*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. This is for going from pre 3.2 versions where benefit data has been saved to the database. | 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. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.2-release/annotate/head:/modules/Salary/lib/iHRIS_Module_ManageSalary.php#L102 manage/modules/Salary/lib/iHRIS_Module_ManageSalary.php] on line 102 | |||
*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. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.2-release/annotate/head:/modules/Salary/lib/iHRIS_Module_ManageSalary.php#L180 manage/modules/Salary/lib/iHRIS_Module_ManageSalary.php] on line 180 | |||
*Signature: public function post_update($old_vers,$new_vers) | *Signature: public function post_update($old_vers,$new_vers) | ||
*Parameters: | *Parameters: | ||
| Line 36: | Line 42: | ||
===pre_migrate()=== | ===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. | 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. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.2-release/annotate/head:/modules/Salary/lib/iHRIS_Module_ManageSalary.php#L51 manage/modules/Salary/lib/iHRIS_Module_ManageSalary.php] on line 51 | |||
*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. This is for going from pre 3.2 versions where benefit data has been saved to the database. | 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. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.2-release/annotate/head:/modules/Salary/lib/iHRIS_Module_ManageSalary.php#L64 manage/modules/Salary/lib/iHRIS_Module_ManageSalary.php] on line 64 | |||
*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 has been changed from the config. | Run the pre upgrade for this module. This can use the old config data before it has been changed from the config. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.2-release/annotate/head:/modules/Salary/lib/iHRIS_Module_ManageSalary.php#L152 manage/modules/Salary/lib/iHRIS_Module_ManageSalary.php] on line 152 | |||
*Signature: public function pre_upgrade($old_vers,$new_vers,$new_storage) | *Signature: public function pre_upgrade($old_vers,$new_vers,$new_storage) | ||
*Parameters: | *Parameters: | ||
Revision as of 10:20, 10 November 2009
This article describes the class iHRIS_Module_ManageSalary.
- Extends the class: I2CE_Module.
- Location: Part of the module ihris-manage-Salary in the package iHRIS Manage
- Source: Defined in the file modules/Salary/lib/iHRIS_Module_ManageSalary.php on line 31
- Author: Luke Duncan <lduncan@intrahealth.org>
- Since: 3.2.3
iHRIS_Module_ManageSalary
Variables
$do_migrate
A flag to determine if migrate needs to be called during post_update
- Defined in manage/modules/Salary/lib/iHRIS_Module_ManageSalary.php on line 37
- Type: protected boolean $do_migrate
$do_migrate326
A flag to determine if migrate326 needs to be called during post_update
- Defined in manage/modules/Salary/lib/iHRIS_Module_ManageSalary.php on line 41
- Type: protected boolean $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.
- Defined in manage/modules/Salary/lib/iHRIS_Module_ManageSalary.php on line 121
- 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.
- Defined in manage/modules/Salary/lib/iHRIS_Module_ManageSalary.php on line 80
- 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.
- Defined in manage/modules/Salary/lib/iHRIS_Module_ManageSalary.php on line 102
- Signature: protected function migrate326()
- Returns: boolean
post_update()
Post Update this module.
- Defined in manage/modules/Salary/lib/iHRIS_Module_ManageSalary.php on line 180
- Signature: public function post_update($old_vers,$new_vers)
- Parameters:
- Returns: boolean
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.
- Defined in manage/modules/Salary/lib/iHRIS_Module_ManageSalary.php on line 51
- 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.
- Defined in manage/modules/Salary/lib/iHRIS_Module_ManageSalary.php on line 64
- 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.
- Defined in manage/modules/Salary/lib/iHRIS_Module_ManageSalary.php on line 152
- Signature: public function pre_upgrade($old_vers,$new_vers,$new_storage)
- Parameters:
- string $old_vers
- string $new_vers
- I2CE_MagicDataNode $new_storage
- Returns: boolean
Inherited Methods
__construct()
This public method is inherited from I2CE_Module->__construct()
action_configure()
This public method is inherited from I2CE_Module->action_configure()
action_disable()
This public method is inherited from I2CE_Module->action_disable()
action_enable()
This public method is inherited from I2CE_Module->action_enable()
conflict_external()
This public method is inherited from I2CE_Module->conflict_external()
getCLIHooks()
This public method is inherited from I2CE_Module->getCLIHooks()
getCLIMethods()
This public method is inherited from I2CE_Module->getCLIMethods()
getConfig()
This public method is inherited from I2CE_Module->getConfig()
getHooks()
This public method is inherited from I2CE_Module->getHooks()
getMethods()
This public method is inherited from I2CE_Module->getMethods()
requirement_external()
This public method is inherited from I2CE_Module->requirement_external()
upgrade()
This public method is inherited from I2CE_Module->upgrade()
_hasMethod()
This public method is inherited from I2CE_Fuzzy->_hasMethod()
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()
