Class: iHRIS Module PersonEmployment: 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 Common Module List#PersonEmployment|PersonEmployment]] in the package [https://launchpad.net/ihris-common iHRIS Common] | *Location: Part of the module [[iHRIS Common Module List#PersonEmployment|PersonEmployment]] in the package [https://launchpad.net/ihris-common iHRIS Common] | ||
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0. | *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0.2-release/annotate/head:/modules/Person/modules/Employment/lib/iHRIS_Module_PersonEmployment.php#L33 modules/Person/modules/Employment/lib/iHRIS_Module_PersonEmployment.php] on line 33 | ||
*Author: Carl Leitner <litlfred@ibiblio.org> | *Author: Carl Leitner <litlfred@ibiblio.org> | ||
*Since: v3.2 | *Since: v3.2 | ||
| Line 9: | Line 9: | ||
===$do_migrate=== | ===$do_migrate=== | ||
A flag to determine if migrate needs to be called during the upgrade method. | A flag to determine if migrate needs to be called during the upgrade method. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0.2-release/annotate/head:/modules/Person/modules/Employment/lib/iHRIS_Module_PersonEmployment.php#L38 common/modules/Person/modules/Employment/lib/iHRIS_Module_PersonEmployment.php] on line 38 | |||
*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 | ||
==Methods== | ==Methods== | ||
===action_employment()=== | ===action_employment()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0.2-release/annotate/head:/modules/Person/modules/Employment/lib/iHRIS_Module_PersonEmployment.php#L48 common/modules/Person/modules/Employment/lib/iHRIS_Module_PersonEmployment.php] on line 48 | |||
*Signature: public function action_employment($obj) | *Signature: public function action_employment($obj) | ||
*Parameters: | *Parameters: | ||
| 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-common/4.0.2-release/annotate/head:/modules/Person/modules/Employment/lib/iHRIS_Module_PersonEmployment.php#L96 common/modules/Person/modules/Employment/lib/iHRIS_Module_PersonEmployment.php] on line 96 | |||
*Signature: public function action_initialize() | *Signature: public function action_initialize() | ||
===getMethods()=== | ===getMethods()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0.2-release/annotate/head:/modules/Person/modules/Employment/lib/iHRIS_Module_PersonEmployment.php#L41 common/modules/Person/modules/Employment/lib/iHRIS_Module_PersonEmployment.php] on line 41 | |||
*Signature: static public function getMethods() | *Signature: static public function getMethods() | ||
===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-common/4.0.2-release/annotate/head:/modules/Person/modules/Employment/lib/iHRIS_Module_PersonEmployment.php#L77 common/modules/Person/modules/Employment/lib/iHRIS_Module_PersonEmployment.php] on line 77 | |||
*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 ] | ||
===post_update()=== | ===post_update()=== | ||
Upgrade this module if necessary | Upgrade this module if necessary | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0.2-release/annotate/head:/modules/Person/modules/Employment/lib/iHRIS_Module_PersonEmployment.php#L147 common/modules/Person/modules/Employment/lib/iHRIS_Module_PersonEmployment.php] on line 147 | |||
*Signature: public function post_update($old_vers,$new_vers) | *Signature: public function post_update($old_vers,$new_vers) | ||
*Parameters: | *Parameters: | ||
| Line 34: | Line 40: | ||
===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-common/4.0.2-release/annotate/head:/modules/Person/modules/Employment/lib/iHRIS_Module_PersonEmployment.php#L63 common/modules/Person/modules/Employment/lib/iHRIS_Module_PersonEmployment.php] on line 63 | |||
*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_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-common/4.0.2-release/annotate/head:/modules/Person/modules/Employment/lib/iHRIS_Module_PersonEmployment.php#L127 common/modules/Person/modules/Employment/lib/iHRIS_Module_PersonEmployment.php] on line 127 | |||
*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_PersonEmployment.
- Extends the class: I2CE_Module.
- Location: Part of the module PersonEmployment in the package iHRIS Common
- Source: Defined in the file modules/Person/modules/Employment/lib/iHRIS_Module_PersonEmployment.php on line 33
- Author: Carl Leitner <litlfred@ibiblio.org>
- Since: v3.2
@filesource Class iHRIS_Module_PersonEmployment
Variables
$do_migrate
A flag to determine if migrate needs to be called during the upgrade method.
- Defined in common/modules/Person/modules/Employment/lib/iHRIS_Module_PersonEmployment.php on line 38
- Type: protected boolean $do_migrate
Methods
action_employment()
- Defined in common/modules/Person/modules/Employment/lib/iHRIS_Module_PersonEmployment.php on line 48
- Signature: public function action_employment($obj)
- Parameters:
- $obj
action_initialize()
Method called before the module is enabled for the first time. @param boolean -- returns true on success. false on error.
- Defined in common/modules/Person/modules/Employment/lib/iHRIS_Module_PersonEmployment.php on line 96
- Signature: public function action_initialize()
getMethods()
- Defined in common/modules/Person/modules/Employment/lib/iHRIS_Module_PersonEmployment.php on line 41
- Signature: static public function getMethods()
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 common/modules/Person/modules/Employment/lib/iHRIS_Module_PersonEmployment.php on line 77
- Signature: protected function migrate()
- Returns: boolean
post_update()
Upgrade this module if necessary
- Defined in common/modules/Person/modules/Employment/lib/iHRIS_Module_PersonEmployment.php on line 147
- 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 common/modules/Person/modules/Employment/lib/iHRIS_Module_PersonEmployment.php on line 63
- Signature: protected function pre_migrate()
- 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 common/modules/Person/modules/Employment/lib/iHRIS_Module_PersonEmployment.php on line 127
- 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()
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()
