Class: iHRIS Module PersonEducation: Difference between revisions

From IHRIS Wiki
No edit summary
Line 1: Line 1:
This article describes the class ''iHRIS_Module_PersonEducation''.
#REDIRECT [[Class: iHRIS_Module_PersonEducation (4.0.3)]]
*Extends the class: [[Class: I2CE_Module | I2CE_Module]].
*Location: Part of the module [[iHRIS Common Module List#PersonEducation|PersonEducation]] 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.2-release/annotate/head:/modules/Person/modules/Education/lib/iHRIS_Module_PersonEducation.php#L33 modules/Person/modules/Education/lib/iHRIS_Module_PersonEducation.php] on line 33
*Author: Carl Leitner <litlfred@ibiblio.org>
*Since: v3.2
@filesource Class iHRIS_Module_PersonEducation
==Variables==
===$do_migrate===
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/Education/lib/iHRIS_Module_PersonEducation.php#L39 common/modules/Person/modules/Education/lib/iHRIS_Module_PersonEducation.php] on line 39
*Type: protected bolean $do_migrate
 
==Methods==
===action_education()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0.2-release/annotate/head:/modules/Person/modules/Education/lib/iHRIS_Module_PersonEducation.php#L160 common/modules/Person/modules/Education/lib/iHRIS_Module_PersonEducation.php] on line 160
*Signature: public function action_education($obj)
*Parameters:
**$obj
===action_initialize()===
Method called before the moduled is enabled for the first time.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0.2-release/annotate/head:/modules/Person/modules/Education/lib/iHRIS_Module_PersonEducation.php#L88 common/modules/Person/modules/Education/lib/iHRIS_Module_PersonEducation.php] on line 88
*Signature: public function action_initialize()
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
===getMethods()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0.2-release/annotate/head:/modules/Person/modules/Education/lib/iHRIS_Module_PersonEducation.php#L153 common/modules/Person/modules/Education/lib/iHRIS_Module_PersonEducation.php] on line 153
*Signature: static public function getMethods()
===migrate()===
Perform the migrate actions for this module.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0.2-release/annotate/head:/modules/Person/modules/Education/lib/iHRIS_Module_PersonEducation.php#L59 common/modules/Person/modules/Education/lib/iHRIS_Module_PersonEducation.php] on line 59
*Signature: protected function migrate()
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
===post_update()===
Upgrade this module if necessary
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0.2-release/annotate/head:/modules/Person/modules/Education/lib/iHRIS_Module_PersonEducation.php#L137 common/modules/Person/modules/Education/lib/iHRIS_Module_PersonEducation.php] on line 137
*Signature: public function post_update($old_vers,$new_vers)
*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
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
===pre_migrate()===
Run the pre migrate 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/Education/lib/iHRIS_Module_PersonEducation.php#L46 common/modules/Person/modules/Education/lib/iHRIS_Module_PersonEducation.php] on line 46
*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.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0.2-release/annotate/head:/modules/Person/modules/Education/lib/iHRIS_Module_PersonEducation.php#L117 common/modules/Person/modules/Education/lib/iHRIS_Module_PersonEducation.php] on line 117
*Signature: public function pre_upgrade($old_vers,$new_vers,$new_storage)
*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
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
==Inherited Methods==
===__construct()===
This public method is inherited from [[Class: I2CE_Module#__construct() | I2CE_Module->__construct()]]
 
===action_configure()===
This public method is inherited from [[Class: I2CE_Module#action_configure() | I2CE_Module->action_configure()]]
 
===action_disable()===
This public method is inherited from [[Class: I2CE_Module#action_disable() | I2CE_Module->action_disable()]]
 
===action_enable()===
This public method is inherited from [[Class: I2CE_Module#action_enable() | I2CE_Module->action_enable()]]
 
===conflict_external()===
This public method is inherited from [[Class: I2CE_Module#conflict_external() | I2CE_Module->conflict_external()]]
 
===getCLIHooks()===
This public method is inherited from [[Class: I2CE_Module#getCLIHooks() | I2CE_Module->getCLIHooks()]]
 
===getCLIMethods()===
This public method is inherited from [[Class: I2CE_Module#getCLIMethods() | I2CE_Module->getCLIMethods()]]
 
===getConfig()===
This public method is inherited from [[Class: I2CE_Module#getConfig() | I2CE_Module->getConfig()]]
 
===getHooks()===
This public method is inherited from [[Class: I2CE_Module#getHooks() | I2CE_Module->getHooks()]]
 
===requirement_external()===
This public method is inherited from [[Class: I2CE_Module#requirement_external() | I2CE_Module->requirement_external()]]
 
===upgrade()===
This public method is inherited from [[Class: I2CE_Module#upgrade() | I2CE_Module->upgrade()]]
 
===_hasMethod()===
This public method is inherited from [[Class: I2CE_Fuzzy#_hasMethod() | I2CE_Fuzzy->_hasMethod()]]
==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]]

Revision as of 15:21, 10 March 2010