Class: iHRIS Module PersonEducation: Difference between revisions

From IHRIS Wiki
No edit summary
 
(15 intermediate revisions by the same user not shown)
Line 1: Line 1:
This article describes the class ''iHRIS_Module_PersonEducation''.
#REDIRECT [[Class: iHRIS_Module_PersonEducation (4.1.7)]]
*Extends the class: [[Class: I2CE_Module | I2CE_Module]].
*Parent Classses:  [[Class: I2CE_Module | I2CE_Module]] [[Class: I2CE_Fuzzy | I2CE_Fuzzy]]
*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.0-release/annotate/head:/modules/Person/modules/Education/lib/iHRIS_Module_PersonEducation.php modules/Person/modules/Education/lib/iHRIS_Module_PersonEducation.php]
*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.
*Type: protected bolean $do_migrate
 
==Methods==
===action_education()===
*Signature: public function action_education($obj)
*Parameters:
**$obj
===action_initialize()===
Method called before the moduled is enabled for the first time.
*Signature: public function action_initialize()
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
===getMethods()===
*Signature: static public function getMethods()
===migrate()===
Perform the migrate actions for this module.
*Signature: protected function migrate()
*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)
*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.
*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)
*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 ]
 
 
[[Category:Class Documentation]]

Latest revision as of 08:59, 23 August 2013