Class: iHRIS Module PersonID: Difference between revisions

From IHRIS Wiki
No edit summary
 
(26 intermediate revisions by the same user not shown)
Line 1: Line 1:
This article desrcibes the class '''iHRIS_Module_PersonID''' which extends the class [[Class: I2CE_Module | I2CE_Module]]
#REDIRECT [[Class: iHRIS_Module_PersonID (4.1.7)]]
It is contained in the module [[iHRIS Module List#PersonID|PersonID]] in the package [https://launchpad.net/ihris-common iHRIS Common]
 
The class is defined in the file: [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0.0-release/annotate/head:/modules/Person/modules/ID/lib/iHRIS_Module_PersonID.php modules/Person/modules/ID/lib/iHRIS_Module_PersonID.php]
 
@filesource
Class iHRIS_Module_PersonID
*Author: Carl Leitner <litlfred@ibiblio.org>
*Since: v3.2
==Variables==
===$do_migrate===
A flag to determin if migrate needs to be called during the upgrade method.
*Type: protected n $do_migrate
 
==Methods==
===action_initialize()===
Method called before the module is enabled for the first time.
*Signature: public function action_initialize()
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean]
===action_person_id()===
*Signature: public function action_person_id($obj)
Parameters:
*$obj
===getMethods()===
*Signature: static public function getMethods()
===migrate()===
Perform the migrate actions for this module.
*Signature: protected function migrate()
*Returns: 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()===
Run the pre migrate for this module.  This can use the old config data before
it has been changed from the config.
*Signature: protected function pre_migrate()
*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
==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