Class: iHRIS Module PersonPosition: Difference between revisions

From IHRIS Wiki
No edit summary
 
(24 intermediate revisions by the same user not shown)
Line 1: Line 1:
This article desrcibes the class '''iHRIS_Module_PersonPosition'''.
#REDIRECT [[Class: iHRIS_Module_PersonPosition (4.1.7)]]
*Extends the class: [[Class: I2CE_Module | I2CE_Module]].
*Location: Part of the module [[iHRIS 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.0-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_Module_PersonPosition.php modules/ManagePersonPosition/lib/iHRIS_Module_PersonPosition.php]
 
*Author: Carl Leitner <litlfred@ibiblio.org>
*Since: v3.2.6
@filesource
Class iHRIS_Module_PersonPosition
==Variables==
===$do_migrate===
A flag to determine if migrate needs to be called during the upgrade method.
*Type: protected n $do_migrate
 
===$do_migrate3212===
A flag to determine if migrate3212 needs to be called during the upgrade method.
*Type: protected n $do_migrate3212
 
==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()
===action_person_position()===
*Signature: public function action_person_position($page)
Parameters:
*$page
===getLastPosition()===
Find and return the most recent position held by this person.
*Signature: public function getLastPosition($person)
*Returns: [[Class: I2CE_Form | I2CE_Form]] or null
Parameters:
*$person
===getMethods()===
*Signature: static public function 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()
*Signature: public function isActive_Person($person)
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
Parameters:
*$person
===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()
*Signature: public function isActive_PersonPosition($pers_pos)
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
Parameters:
*$pers_pos
===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: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
===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.
*Signature: protected function migrate3212()
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
===post_update()===
Upgrade this module if necessary
*Signature: public function post_update($old_vers,$new_vers)
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
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 ] $new_vers
===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: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
===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.
*Signature: protected function pre_migrate3212()
*Returns: [http://www.php.net/manual/en/language.types.boolean.php 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: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
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 ] $new_vers
* [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $new_storage
===upgrade()===
Run the upgrade function for this module.
*Signature: public function upgrade($old_vers,$new_vers)
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
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 ] $new_vers
==Inherited Fuzzy Methods==
===launchBackgroundProcess()===
This method is inherited from [[Class: I2CE_Module#launchBackgroundProcess() | I2CE_Module->launchBackgroundProcess()]]
 
===launchBackgroundPHPScript()===
This method is inherited from [[Class: I2CE_Module#launchBackgroundPHPScript() | I2CE_Module->launchBackgroundPHPScript()]]
 
===launchBackgroundPage()===
This method is inherited from [[Class: I2CE_Module#launchBackgroundPage() | I2CE_Module->launchBackgroundPage()]]
 
===userMessage()===
This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]]
 
 
[[Category:Class Documentation]]

Latest revision as of 08:59, 23 August 2013