Class: iHRIS Module Qualify (Development): Difference between revisions

From IHRIS Wiki
(Created page with '{{otherversions|Class: iHRIS_Module_Qualify}} This article describes the class ''iHRIS_Module_Qualify'' . *Extends the class: I2CE_Module. …')
 
No edit summary
 
Line 2: Line 2:
This article describes the class ''iHRIS_Module_Qualify'' .
This article describes the class ''iHRIS_Module_Qualify'' .
*Extends the class: [[Class: I2CE_Module (Development) | I2CE_Module]].
*Extends the class: [[Class: I2CE_Module (Development) | I2CE_Module]].
*Location: Part of the module [[iHRIS Qualify Module List (Development)#ihris-qualify|ihris-qualify]] in the package [https://launchpad.net/qualify iHRIS Qualify] 4.0-dev
*Location: Part of the module [[iHRIS Qualify Module List (Development)#ihris-qualify|ihris-qualify]] in the package [https://launchpad.net/qualify iHRIS Qualify] 4.1-dev
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/qualify/4.0-dev/annotate/head:/lib/iHRIS_Module_Qualify.php#L37 lib/iHRIS_Module_Qualify.php] on line 37
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/qualify/4.1-dev/annotate/head:/lib/iHRIS_Module_Qualify.php#L37 lib/iHRIS_Module_Qualify.php] on line 37
*Author: Carl Leitner <litlfred@ibiblio.org>
*Author: Carl Leitner <litlfred@ibiblio.org>
iHRIS_Module_Qualify
iHRIS_Module_Qualify
Line 9: Line 9:
===action_deployment()===
===action_deployment()===
Handle adding the deployment form to the person page view page.
Handle adding the deployment form to the person page view page.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/qualify/4.0-dev/annotate/head:/lib/iHRIS_Module_Qualify.php#L95 qualify/lib/iHRIS_Module_Qualify.php] on line 95
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/qualify/4.1-dev/annotate/head:/lib/iHRIS_Module_Qualify.php#L111 qualify/lib/iHRIS_Module_Qualify.php] on line 111
*Signature: public function action_deployment($page)
*Signature: public function action_deployment($page)
*Parameters:
*Parameters:
Line 16: Line 16:
===action_education()===
===action_education()===
Handle adding the education form to the person page view page.
Handle adding the education form to the person page view page.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/qualify/4.0-dev/annotate/head:/lib/iHRIS_Module_Qualify.php#L71 qualify/lib/iHRIS_Module_Qualify.php] on line 71
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/qualify/4.1-dev/annotate/head:/lib/iHRIS_Module_Qualify.php#L87 qualify/lib/iHRIS_Module_Qualify.php] on line 87
*Signature: public function action_education($page)
*Signature: public function action_education($page)
*Parameters:
*Parameters:
Line 23: Line 23:
===action_out_migration()===
===action_out_migration()===
Handle adding the out_migration form to the person page view page.
Handle adding the out_migration form to the person page view page.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/qualify/4.0-dev/annotate/head:/lib/iHRIS_Module_Qualify.php#L83 qualify/lib/iHRIS_Module_Qualify.php] on line 83
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/qualify/4.1-dev/annotate/head:/lib/iHRIS_Module_Qualify.php#L99 qualify/lib/iHRIS_Module_Qualify.php] on line 99
*Signature: public function action_out_migration($page)
*Signature: public function action_out_migration($page)
*Parameters:
*Parameters:
Line 30: Line 30:
===action_record_verify()===
===action_record_verify()===
Handle adding the record verify form to the person page view page.
Handle adding the record verify form to the person page view page.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/qualify/4.0-dev/annotate/head:/lib/iHRIS_Module_Qualify.php#L59 qualify/lib/iHRIS_Module_Qualify.php] on line 59
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/qualify/4.1-dev/annotate/head:/lib/iHRIS_Module_Qualify.php#L75 qualify/lib/iHRIS_Module_Qualify.php] on line 75
*Signature: public function action_record_verify($page)
*Signature: public function action_record_verify($page)
*Parameters:
*Parameters:
Line 37: Line 37:
===action_training()===
===action_training()===
Handle adding the training form to the person page view page.
Handle adding the training form to the person page view page.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/qualify/4.0-dev/annotate/head:/lib/iHRIS_Module_Qualify.php#L107 qualify/lib/iHRIS_Module_Qualify.php] on line 107
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/qualify/4.1-dev/annotate/head:/lib/iHRIS_Module_Qualify.php#L123 qualify/lib/iHRIS_Module_Qualify.php] on line 123
*Signature: public function action_training($page)
*Signature: public function action_training($page)
*Parameters:
*Parameters:
Line 43: Line 43:
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
===ensureFormsAndPages()===
===ensureFormsAndPages()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/qualify/4.0-dev/annotate/head:/lib/iHRIS_Module_Qualify.php#L527 qualify/lib/iHRIS_Module_Qualify.php] on line 527
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/qualify/4.1-dev/annotate/head:/lib/iHRIS_Module_Qualify.php#L641 qualify/lib/iHRIS_Module_Qualify.php] on line 641
*Signature: public function ensureFormsAndPages()
*Signature: public function ensureFormsAndPages()
===getHooks()===
Return the array of hooks available in this module.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/qualify/4.1-dev/annotate/head:/lib/iHRIS_Module_Qualify.php#L58 qualify/lib/iHRIS_Module_Qualify.php] on line 58
*Signature: static public function getHooks()
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]
===getMethods()===
===getMethods()===
Return any fuzzy methds that this module implements
Return any fuzzy methds that this module implements
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/qualify/4.0-dev/annotate/head:/lib/iHRIS_Module_Qualify.php#L44 qualify/lib/iHRIS_Module_Qualify.php] on line 44
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/qualify/4.1-dev/annotate/head:/lib/iHRIS_Module_Qualify.php#L44 qualify/lib/iHRIS_Module_Qualify.php] on line 44
*Signature: static public function getMethods()
*Signature: static public function getMethods()
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]
===pre_upgrade()===
===pre_upgrade()===
Do any pre upgrade actions if necessary.
Do any pre upgrade actions if necessary.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/qualify/4.0-dev/annotate/head:/lib/iHRIS_Module_Qualify.php#L144 qualify/lib/iHRIS_Module_Qualify.php] on line 144
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/qualify/4.1-dev/annotate/head:/lib/iHRIS_Module_Qualify.php#L258 qualify/lib/iHRIS_Module_Qualify.php] on line 258
*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 60: Line 65:
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
===updateContactTypes()===
===updateContactTypes()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/qualify/4.0-dev/annotate/head:/lib/iHRIS_Module_Qualify.php#L453 qualify/lib/iHRIS_Module_Qualify.php] on line 453
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/qualify/4.1-dev/annotate/head:/lib/iHRIS_Module_Qualify.php#L567 qualify/lib/iHRIS_Module_Qualify.php] on line 567
*Signature: protected function updateContactTypes()
*Signature: protected function updateContactTypes()
===upgrade()===
===upgrade()===
Upgrade this module if necessary based on the previous and new versions of the module.
Upgrade this module if necessary based on the previous and new versions of the module.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/qualify/4.0-dev/annotate/head:/lib/iHRIS_Module_Qualify.php#L223 qualify/lib/iHRIS_Module_Qualify.php] on line 223
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/qualify/4.1-dev/annotate/head:/lib/iHRIS_Module_Qualify.php#L337 qualify/lib/iHRIS_Module_Qualify.php] on line 337
*Signature: public function upgrade($old_vers,$new_vers)
*Signature: public function upgrade($old_vers,$new_vers)
*Parameters:
*Parameters:
Line 70: Line 75:
** [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_disciplinary_action()===
Perform any extra validation for the disciplinary action.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/qualify/4.1-dev/annotate/head:/lib/iHRIS_Module_Qualify.php#L240 qualify/lib/iHRIS_Module_Qualify.php] on line 240
*Signature: public function validate_form_disciplinary_action($form)
*Parameters:
** I2CE_From $form
===validate_form_exam()===
Perform any additional required validation for the exam.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/qualify/4.1-dev/annotate/head:/lib/iHRIS_Module_Qualify.php#L194 qualify/lib/iHRIS_Module_Qualify.php] on line 194
*Signature: public function validate_form_exam($form)
*Parameters:
** [[Class: I2CE_Form (Development) | I2CE_Form]] $form
===validate_form_license()===
Perform any extra validation for the license form.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/qualify/4.1-dev/annotate/head:/lib/iHRIS_Module_Qualify.php#L157 qualify/lib/iHRIS_Module_Qualify.php] on line 157
*Signature: public function validate_form_license($form)
*Parameters:
** [[Class: I2CE_Form (Development) | I2CE_Form]] $form
===validate_form_private_practice()===
Perform any extra validation for the private practice license.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/qualify/4.1-dev/annotate/head:/lib/iHRIS_Module_Qualify.php#L228 qualify/lib/iHRIS_Module_Qualify.php] on line 228
*Signature: public function validate_form_private_practice($form)
*Parameters:
** [[Class: I2CE_Form (Development) | I2CE_Form]] $form
===validate_form_registration()===
Validate any extra information other than required fields for registrations.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/qualify/4.1-dev/annotate/head:/lib/iHRIS_Module_Qualify.php#L183 qualify/lib/iHRIS_Module_Qualify.php] on line 183
*Signature: public function validate_form_registration($form)
*Parameters:
** [[Class: I2CE_Form (Development) | I2CE_Form]] $form
===validate_form_training()===
Validate all fields for the training form.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/qualify/4.1-dev/annotate/head:/lib/iHRIS_Module_Qualify.php#L206 qualify/lib/iHRIS_Module_Qualify.php] on line 206
*Signature: public function validate_form_training($form)
*Parameters:
** [[Class: I2CE_Form (Development) | I2CE_Form]] $form
===validate_form_training_disrupt()===
Validate any extra information other than required fields for training disruptions.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/qualify/4.1-dev/annotate/head:/lib/iHRIS_Module_Qualify.php#L170 qualify/lib/iHRIS_Module_Qualify.php] on line 170
*Signature: public function validate_form_training_disrupt($form)
*Parameters:
** [[Class: I2CE_Form (Development) | I2CE_Form]] $form
==Inherited Methods==
==Inherited Methods==
===__construct()===
===__construct()===
Line 85: Line 132:
===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 94: Line 138:
===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_Qualify .

iHRIS_Module_Qualify

Methods

action_deployment()

Handle adding the deployment form to the person page view page.

action_education()

Handle adding the education form to the person page view page.

action_out_migration()

Handle adding the out_migration form to the person page view page.

action_record_verify()

Handle adding the record verify form to the person page view page.

action_training()

Handle adding the training form to the person page view page.

ensureFormsAndPages()

getHooks()

Return the array of hooks available in this module.

getMethods()

Return any fuzzy methds that this module implements

pre_upgrade()

Do any pre upgrade actions if necessary.

updateContactTypes()

upgrade()

Upgrade this module if necessary based on the previous and new versions of the module.

validate_form_disciplinary_action()

Perform any extra validation for the disciplinary action.

validate_form_exam()

Perform any additional required validation for the exam.

validate_form_license()

Perform any extra validation for the license form.

validate_form_private_practice()

Perform any extra validation for the private practice license.

validate_form_registration()

Validate any extra information other than required fields for registrations.

validate_form_training()

Validate all fields for the training form.

validate_form_training_disrupt()

Validate any extra information other than required fields for training disruptions.

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