Class: iHRIS Module ManageSalary (Development): Difference between revisions
(Created page with '{{otherversions|Class: iHRIS_Module_ManageSalary}} This article describes the class ''iHRIS_Module_ManageSalary'' . *Extends the class: [[Class: I2CE_Module (Development) | I2CE_…') |
No edit summary |
||
Line 2: | Line 2: | ||
This article describes the class ''iHRIS_Module_ManageSalary'' . | This article describes the class ''iHRIS_Module_ManageSalary'' . | ||
*Extends the class: [[Class: I2CE_Module (Development) | I2CE_Module]]. | *Extends the class: [[Class: I2CE_Module (Development) | I2CE_Module]]. | ||
*Location: Part of the module [[iHRIS Manage Module List (Development)#ihris-manage-Salary|ihris-manage-Salary]] in the package [https://launchpad.net/ihris-manage iHRIS Manage] 4. | *Location: Part of the module [[iHRIS Manage Module List (Development)#ihris-manage-Salary|ihris-manage-Salary]] in the package [https://launchpad.net/ihris-manage iHRIS Manage] 4.1-dev | ||
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4. | *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php#L31 modules/ManagePersonPosition/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 10: | Line 10: | ||
===$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. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php#L187 manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php] on line 187 | ||
*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. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php#L191 manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php] on line 191 | ||
*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 21: | Line 21: | ||
===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. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php#L271 manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php] on line 271 | ||
*Signature: public function action_initialize() | *Signature: public function action_initialize() | ||
===depart_position_save()=== | |||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php#L46 manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php] on line 46 | |||
*Signature: public function depart_position_save($personPosition) | |||
*Parameters: | |||
**$personPosition | |||
===getHooks()=== | |||
Return the array of hooks available in this module. | |||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php#L37 manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php] on line 37 | |||
*Signature: static public function getHooks() | |||
*Returns: [http://www.php.net/manual/en/language.types.array.php array ] | |||
===getLastSalary()=== | |||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php#L104 manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php] on line 104 | |||
*Signature: public function getLastSalary($formObj) | |||
*Parameters: | |||
**$formObj | |||
===getMethods()=== | |||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php#L96 manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php] on line 96 | |||
*Signature: static public function getMethods() | |||
===getSalaryGradeID()=== | |||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php#L122 manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php] on line 122 | |||
*Signature: public function getSalaryGradeID($formObj) | |||
*Parameters: | |||
**$formObj | |||
===make_offer_display()=== | |||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php#L61 manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php] on line 61 | |||
*Signature: public function make_offer_display($page,$person_position) | |||
*Parameters: | |||
**$page | |||
**$person_position | |||
===make_promotion_save()=== | |||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php#L79 manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php] on line 79 | |||
*Signature: public function make_promotion_save($old_person_position,$new_person_position) | |||
*Parameters: | |||
**$old_person_position | |||
**$new_person_position | |||
===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. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php#L230 manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php] on line 230 | ||
*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. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php#L252 manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php] on line 252 | ||
*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 ] | ||
===person_position_action_salary()=== | |||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php#L137 manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php] on line 137 | |||
*Signature: public function person_position_action_salary($page) | |||
*Parameters: | |||
**$page | |||
===post_update()=== | ===post_update()=== | ||
Post Update this module. | Post Update this module. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php#L330 manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php] on line 330 | ||
*Signature: public function post_update($old_vers,$new_vers) | *Signature: public function post_update($old_vers,$new_vers) | ||
*Parameters: | *Parameters: | ||
Line 43: | Line 83: | ||
===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. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php#L201 manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php] on line 201 | ||
*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. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php#L214 manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php] on line 214 | ||
*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. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php#L302 manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php] on line 302 | ||
*Signature: public function pre_upgrade($old_vers,$new_vers,$new_storage) | *Signature: public function pre_upgrade($old_vers,$new_vers,$new_storage) | ||
*Parameters: | *Parameters: | ||
Line 72: | Line 112: | ||
===action_enable()=== | ===action_enable()=== | ||
This public method is inherited from [[Class: I2CE_Module (Development)#action_enable() | I2CE_Module->action_enable()]] | This public method is inherited from [[Class: I2CE_Module (Development)#action_enable() | I2CE_Module->action_enable()]] | ||
===getCLIMethods()=== | ===getCLIMethods()=== | ||
Line 81: | Line 118: | ||
===getConfig()=== | ===getConfig()=== | ||
This public method is inherited from [[Class: I2CE_Module (Development)#getConfig() | I2CE_Module->getConfig()]] | This public method is inherited from [[Class: I2CE_Module (Development)#getConfig() | I2CE_Module->getConfig()]] | ||
===upgrade()=== | ===upgrade()=== |
Latest revision as of 09:26, 6 May 2015
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 4.1-dev
- Source: Defined in the file modules/ManagePersonPosition/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/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php on line 187
- Type: protected boolean $do_migrate
$do_migrate326
A flag to determine if migrate326 needs to be called during post_update
- Defined in manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php on line 191
- 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/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php on line 271
- Signature: public function action_initialize()
depart_position_save()
- Defined in manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php on line 46
- Signature: public function depart_position_save($personPosition)
- Parameters:
- $personPosition
getHooks()
Return the array of hooks available in this module.
- Defined in manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php on line 37
- Signature: static public function getHooks()
- Returns: array
getLastSalary()
- Defined in manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php on line 104
- Signature: public function getLastSalary($formObj)
- Parameters:
- $formObj
getMethods()
- Defined in manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php on line 96
- Signature: static public function getMethods()
getSalaryGradeID()
- Defined in manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php on line 122
- Signature: public function getSalaryGradeID($formObj)
- Parameters:
- $formObj
make_offer_display()
- Defined in manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php on line 61
- Signature: public function make_offer_display($page,$person_position)
- Parameters:
- $page
- $person_position
make_promotion_save()
- Defined in manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php on line 79
- Signature: public function make_promotion_save($old_person_position,$new_person_position)
- Parameters:
- $old_person_position
- $new_person_position
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/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php on line 230
- 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/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php on line 252
- Signature: protected function migrate326()
- Returns: boolean
person_position_action_salary()
- Defined in manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php on line 137
- Signature: public function person_position_action_salary($page)
- Parameters:
- $page
post_update()
Post Update this module.
- Defined in manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php on line 330
- 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/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php on line 201
- 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/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php on line 214
- 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/ManagePersonPosition/modules/Salary/lib/iHRIS_Module_ManageSalary.php on line 302
- 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()
getCLIMethods()
This public method is inherited from I2CE_Module->getCLIMethods()
getConfig()
This public method is inherited from I2CE_Module->getConfig()
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()