Class: iHRIS Module PersonPosition: 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-PersonPosition|ihris-manage-PersonPosition]] in the package [https://launchpad.net/ihris-manage iHRIS Manage]
*Location: Part of the module [[iHRIS Manage Module List#ihris-manage-PersonPosition|ihris-manage-PersonPosition]] 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.1-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_Module_PersonPosition.php modules/ManagePersonPosition/lib/iHRIS_Module_PersonPosition.php]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.2-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_Module_PersonPosition.php#L33 modules/ManagePersonPosition/lib/iHRIS_Module_PersonPosition.php] on line 33
*Author: Carl Leitner <litlfred@ibiblio.org>
*Author: Carl Leitner <litlfred@ibiblio.org>
*Since: v3.2.6
*Since: v3.2.6
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-manage/4.0.2-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_Module_PersonPosition.php#L38 manage/modules/ManagePersonPosition/lib/iHRIS_Module_PersonPosition.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


===$do_migrate3212===
===$do_migrate3212===
A flag to determine if migrate3212 needs to be called during the upgrade method.
A flag to determine if migrate3212 needs to be called during the upgrade method.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.2-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_Module_PersonPosition.php#L42 manage/modules/ManagePersonPosition/lib/iHRIS_Module_PersonPosition.php] on line 42
*Type: protected [http://www.php.net/manual/en/language.types.boolean.php boolean ] $do_migrate3212
*Type: protected [http://www.php.net/manual/en/language.types.boolean.php boolean ] $do_migrate3212


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/ManagePersonPosition/lib/iHRIS_Module_PersonPosition.php#L162 manage/modules/ManagePersonPosition/lib/iHRIS_Module_PersonPosition.php] on line 162
*Signature: public function action_initialize()
*Signature: public function action_initialize()
===action_person_position()===
===action_person_position()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.2-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_Module_PersonPosition.php#L335 manage/modules/ManagePersonPosition/lib/iHRIS_Module_PersonPosition.php] on line 335
*Signature: public function action_person_position($page)
*Signature: public function action_person_position($page)
*Parameters:
*Parameters:
Line 25: Line 29:
===getLastPosition()===
===getLastPosition()===
Find and return the most recent position held by this person.
Find and return the most recent position held by this person.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.2-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_Module_PersonPosition.php#L313 manage/modules/ManagePersonPosition/lib/iHRIS_Module_PersonPosition.php] on line 313
*Signature: public function getLastPosition($person)
*Signature: public function getLastPosition($person)
*Parameters:
*Parameters:
Line 30: Line 35:
*Returns: [[Class: I2CE_Form | I2CE_Form]]<br/>or null
*Returns: [[Class: I2CE_Form | I2CE_Form]]<br/>or null
===getMethods()===
===getMethods()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.2-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_Module_PersonPosition.php#L264 manage/modules/ManagePersonPosition/lib/iHRIS_Module_PersonPosition.php] on line 264
*Signature: static public function getMethods()
*Signature: static public function getMethods()
===isActive_Person()===
===isActive_Person()===
Checks to see if the most recent position for this person is still active and doesn't have an end date for his/her position. @see getLastPosition()
Checks to see if the most recent position for this person is still active and doesn't have an end date for his/her position. @see getLastPosition()
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.2-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_Module_PersonPosition.php#L280 manage/modules/ManagePersonPosition/lib/iHRIS_Module_PersonPosition.php] on line 280
*Signature: public function isActive_Person($person)
*Signature: public function isActive_Person($person)
*Parameters:
*Parameters:
Line 39: Line 46:
===isActive_PersonPosition()===
===isActive_PersonPosition()===
Checks to see if the most recent position for this person is still active and doesn't have an end date for his/her position. @see getLastPosition()
Checks to see if the most recent position for this person is still active and doesn't have an end date for his/her position. @see getLastPosition()
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.2-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_Module_PersonPosition.php#L292 manage/modules/ManagePersonPosition/lib/iHRIS_Module_PersonPosition.php] on line 292
*Signature: public function isActive_PersonPosition($pers_pos)
*Signature: public function isActive_PersonPosition($pers_pos)
*Parameters:
*Parameters:
Line 45: Line 53:
===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/ManagePersonPosition/lib/iHRIS_Module_PersonPosition.php#L82 manage/modules/ManagePersonPosition/lib/iHRIS_Module_PersonPosition.php] on line 82
*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 ]
===migrate3212()===
===migrate3212()===
Perform the migrate actions for this module from 3.2.10 to 3.2.12 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.10 to 3.2.12 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/ManagePersonPosition/lib/iHRIS_Module_PersonPosition.php#L143 manage/modules/ManagePersonPosition/lib/iHRIS_Module_PersonPosition.php] on line 143
*Signature: protected function migrate3212()
*Signature: protected function migrate3212()
*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-manage/4.0.2-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_Module_PersonPosition.php#L246 manage/modules/ManagePersonPosition/lib/iHRIS_Module_PersonPosition.php] on line 246
*Signature: public function post_update($old_vers,$new_vers)
*Signature: public function post_update($old_vers,$new_vers)
*Parameters:
*Parameters:
Line 60: Line 71:
===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/ManagePersonPosition/lib/iHRIS_Module_PersonPosition.php#L51 manage/modules/ManagePersonPosition/lib/iHRIS_Module_PersonPosition.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_migrate3212()===
===pre_migrate3212()===
Perform any pre migrate actions for this module from 3.2.10 to 3.2.12 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.10 to 3.2.12 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/ManagePersonPosition/lib/iHRIS_Module_PersonPosition.php#L66 manage/modules/ManagePersonPosition/lib/iHRIS_Module_PersonPosition.php] on line 66
*Signature: protected function pre_migrate3212()
*Signature: protected function pre_migrate3212()
*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/ManagePersonPosition/lib/iHRIS_Module_PersonPosition.php#L193 manage/modules/ManagePersonPosition/lib/iHRIS_Module_PersonPosition.php] on line 193
*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 76: Line 90:
===upgrade()===
===upgrade()===
Run the upgrade function for this module.
Run the upgrade function for this module.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.2-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_Module_PersonPosition.php#L222 manage/modules/ManagePersonPosition/lib/iHRIS_Module_PersonPosition.php] on line 222
*Signature: public function upgrade($old_vers,$new_vers)
*Signature: public function upgrade($old_vers,$new_vers)
*Parameters:
*Parameters:

Revision as of 09:20, 10 November 2009

This article describes the class iHRIS_Module_PersonPosition.

@filesource Class iHRIS_Module_PersonPosition

Variables

$do_migrate

A flag to determine if migrate needs to be called during the upgrade method.

$do_migrate3212

A flag to determine if migrate3212 needs to be called during the upgrade method.

Methods

action_initialize()

Method called before the module is enabled for the first time. @param boolean -- returns true on success. false on error.

action_person_position()

getLastPosition()

Find and return the most recent position held by this person.

getMethods()

isActive_Person()

Checks to see if the most recent position for this person is still active and doesn't have an end date for his/her position. @see getLastPosition()

isActive_PersonPosition()

Checks to see if the most recent position for this person is still active and doesn't have an end date for his/her position. @see getLastPosition()

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.

migrate3212()

Perform the migrate actions for this module from 3.2.10 to 3.2.12 This is for going from pre 3.2 versions where benefit data has been saved to the database.

post_update()

Upgrade this module if necessary

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.

pre_migrate3212()

Perform any pre migrate actions for this module from 3.2.10 to 3.2.12 This is for going from pre 3.2 versions where benefit data has been saved to the database.

pre_upgrade()

Run the pre upgrade for this module. This can use the old config data before it has been changed from the config.

upgrade()

Run the upgrade function for this module.

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()

_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()