Class: iHRIS Module Training Course (Development): Difference between revisions

From IHRIS Wiki
(Created page with '{{otherversions|Class: iHRIS_Module_Training_Course}} This article describes the class ''iHRIS_Module_Training_Course'' . *Extends the class: [[Class: I2CE_Module (Development) |…')
 
No edit summary
 
Line 2: Line 2:
This article describes the class ''iHRIS_Module_Training_Course'' .
This article describes the class ''iHRIS_Module_Training_Course'' .
*Extends the class: [[Class: I2CE_Module (Development) | I2CE_Module]].
*Extends the class: [[Class: I2CE_Module (Development) | I2CE_Module]].
*Location: Part of the module [[iHRIS Common Module List (Development)#training-course|training-course]] in the package [https://launchpad.net/ihris-common iHRIS Common] 4.0-dev
*Location: Part of the module [[iHRIS Common Module List (Development)#training-course|training-course]] in the package [https://launchpad.net/ihris-common iHRIS Common] 4.1-dev
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0-dev/annotate/head:/modules/TrainingCourse/lib/iHRIS_Module_Training_Course.php#L37 modules/TrainingCourse/lib/iHRIS_Module_Training_Course.php] on line 37
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/modules/TrainingCourse/lib/iHRIS_Module_Training_Course.php#L37 modules/TrainingCourse/lib/iHRIS_Module_Training_Course.php] on line 37
*Author: Carl Leitner <litlfred@ibiblio.org>
*Author: Carl Leitner <litlfred@ibiblio.org>
iHRIS_Module_Trainng_Course
iHRIS_Module_Trainng_Course
==Methods==
==Methods==
===action_person_scheduled_training_course()===
===action_person_scheduled_training_course()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0-dev/annotate/head:/modules/TrainingCourse/lib/iHRIS_Module_Training_Course.php#L46 common/modules/TrainingCourse/lib/iHRIS_Module_Training_Course.php] on line 46
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/modules/TrainingCourse/lib/iHRIS_Module_Training_Course.php#L46 common/modules/TrainingCourse/lib/iHRIS_Module_Training_Course.php] on line 46
*Signature: public function action_person_scheduled_training_course($page)
*Signature: public function action_person_scheduled_training_course($page)
*Parameters:
*Parameters:
**$page  
**$page  
===getEnrolledCourseIDs()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/modules/TrainingCourse/lib/iHRIS_Module_Training_Course.php#L388 common/modules/TrainingCourse/lib/iHRIS_Module_Training_Course.php] on line 388
*Signature: protected function getEnrolledCourseIDs($personForm)
*Parameters:
**$personForm
===getHooks()===
Return the array of hooks available in this module.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/modules/TrainingCourse/lib/iHRIS_Module_Training_Course.php#L122 common/modules/TrainingCourse/lib/iHRIS_Module_Training_Course.php] on line 122
*Signature: static public function getHooks()
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]
===getMethods()===
===getMethods()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0-dev/annotate/head:/modules/TrainingCourse/lib/iHRIS_Module_Training_Course.php#L39 common/modules/TrainingCourse/lib/iHRIS_Module_Training_Course.php] on line 39
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/modules/TrainingCourse/lib/iHRIS_Module_Training_Course.php#L39 common/modules/TrainingCourse/lib/iHRIS_Module_Training_Course.php] on line 39
*Signature: static public function getMethods()
*Signature: static public function getMethods()
===moveScheduledTrainingCourseToMap()===
===moveScheduledTrainingCourseToMap()===
Make ehceduled training courses a map value of training course rather than a child.
Make ehceduled training courses a map value of training course rather than a child.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0-dev/annotate/head:/modules/TrainingCourse/lib/iHRIS_Module_Training_Course.php#L236 common/modules/TrainingCourse/lib/iHRIS_Module_Training_Course.php] on line 236
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/modules/TrainingCourse/lib/iHRIS_Module_Training_Course.php#L343 common/modules/TrainingCourse/lib/iHRIS_Module_Training_Course.php] on line 343
*Signature: protected function moveScheduledTrainingCourseToMap()
*Signature: protected function moveScheduledTrainingCourseToMap()
===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-common/4.0-dev/annotate/head:/modules/TrainingCourse/lib/iHRIS_Module_Training_Course.php#L100 common/modules/TrainingCourse/lib/iHRIS_Module_Training_Course.php] on line 100
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/modules/TrainingCourse/lib/iHRIS_Module_Training_Course.php#L207 common/modules/TrainingCourse/lib/iHRIS_Module_Training_Course.php] on line 207
*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 29: Line 39:
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
===showEnrolledCourses()===
===showEnrolledCourses()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0-dev/annotate/head:/modules/TrainingCourse/lib/iHRIS_Module_Training_Course.php#L291 common/modules/TrainingCourse/lib/iHRIS_Module_Training_Course.php] on line 291
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/modules/TrainingCourse/lib/iHRIS_Module_Training_Course.php#L416 common/modules/TrainingCourse/lib/iHRIS_Module_Training_Course.php] on line 416
*Signature: public function showEnrolledCourses($node,$template,$args)
*Signature: public function showEnrolledCourses($node,$template,$args)
*Parameters:
*Parameters:
Line 38: Line 48:
===upgrade()===
===upgrade()===
Upgrade this module if necessary
Upgrade this module if necessary
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0-dev/annotate/head:/modules/TrainingCourse/lib/iHRIS_Module_Training_Course.php#L127 common/modules/TrainingCourse/lib/iHRIS_Module_Training_Course.php] on line 127
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/modules/TrainingCourse/lib/iHRIS_Module_Training_Course.php#L234 common/modules/TrainingCourse/lib/iHRIS_Module_Training_Course.php] on line 234
*Signature: public function upgrade($old_vers,$new_vers)
*Signature: public function upgrade($old_vers,$new_vers)
*Parameters:
*Parameters:
Line 44: Line 54:
** [http://www.php.net/manual/en/language.types.string.php string ] $new_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 ]
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
===validate_form_person_scheduled_training_course_field_training_course_mod()===
Perform any extra validation for the license. @param I2CE_Form $form
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/modules/TrainingCourse/lib/iHRIS_Module_Training_Course.php#L149 common/modules/TrainingCourse/lib/iHRIS_Module_Training_Course.php] on line 149
*Signature: public function validate_form_person_scheduled_training_course_field_training_course_mod($fieldObj)
*Parameters:
**$fieldObj
===validate_form_scheduled_training_course()===
Perform any extra validation for the license.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/modules/TrainingCourse/lib/iHRIS_Module_Training_Course.php#L134 common/modules/TrainingCourse/lib/iHRIS_Module_Training_Course.php] on line 134
*Signature: public function validate_form_scheduled_training_course($form)
*Parameters:
** [[Class: I2CE_Form (Development) | I2CE_Form]] $form
==Inherited Methods==
==Inherited Methods==
===__construct()===
===__construct()===
Line 59: Line 81:
===action_initialize()===
===action_initialize()===
This public method is inherited from [[Class: I2CE_Module (Development)#action_initialize() | I2CE_Module->action_initialize()]]
This public method is inherited from [[Class: I2CE_Module (Development)#action_initialize() | I2CE_Module->action_initialize()]]
===getCLIHooks()===
This public method is inherited from [[Class: I2CE_Module (Development)#getCLIHooks() | I2CE_Module->getCLIHooks()]]


===getCLIMethods()===
===getCLIMethods()===
Line 68: Line 87:
===getConfig()===
===getConfig()===
This public method is inherited from [[Class: I2CE_Module (Development)#getConfig() | I2CE_Module->getConfig()]]
This public method is inherited from [[Class: I2CE_Module (Development)#getConfig() | I2CE_Module->getConfig()]]
===getHooks()===
This public method is inherited from [[Class: I2CE_Module (Development)#getHooks() | I2CE_Module->getHooks()]]


===post_update()===
===post_update()===

Latest revision as of 09:27, 6 May 2015


This article describes the class iHRIS_Module_Training_Course .

iHRIS_Module_Trainng_Course

Methods

action_person_scheduled_training_course()

getEnrolledCourseIDs()

getHooks()

Return the array of hooks available in this module.

getMethods()

moveScheduledTrainingCourseToMap()

Make ehceduled training courses a map value of training course rather than a child.

pre_upgrade()

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

showEnrolledCourses()

upgrade()

Upgrade this module if necessary

validate_form_person_scheduled_training_course_field_training_course_mod()

Perform any extra validation for the license. @param I2CE_Form $form

validate_form_scheduled_training_course()

Perform any extra validation for the license.

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

action_initialize()

This public method is inherited from I2CE_Module->action_initialize()

getCLIMethods()

This public method is inherited from I2CE_Module->getCLIMethods()

getConfig()

This public method is inherited from I2CE_Module->getConfig()

post_update()

This public method is inherited from I2CE_Module->post_update()

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