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

From IHRIS Wiki
(Created page with '{{otherversions|Class: iHRIS_Module_Accident}} This article describes the class ''iHRIS_Module_Accident'' . *Extends the class: I2CE_Module…')
 
No edit summary
 
Line 2: Line 2:
This article describes the class ''iHRIS_Module_Accident'' .
This article describes the class ''iHRIS_Module_Accident'' .
*Extends the class: [[Class: I2CE_Module (Development) | I2CE_Module]].
*Extends the class: [[Class: I2CE_Module (Development) | I2CE_Module]].
*Location: Part of the module [[iHRIS Manage Module List (Development)#accident|accident]] in the package [https://launchpad.net/ihris-manage iHRIS Manage] 4.0-dev
*Location: Part of the module [[iHRIS Manage Module List (Development)#accident|accident]] in the package [https://launchpad.net/ihris-manage iHRIS Manage] 4.1-dev
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0-dev/annotate/head:/modules/Accident/lib/iHRIS_Module_Accident.php#L37 modules/Accident/lib/iHRIS_Module_Accident.php] on line 37
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/Accident/lib/iHRIS_Module_Accident.php#L37 modules/Accident/lib/iHRIS_Module_Accident.php] on line 37
*Author: Carl Leitner <litlfred@ibiblio.org>
*Author: Carl Leitner <litlfred@ibiblio.org>
iHRIS_Module_Accident
iHRIS_Module_Accident
==Methods==
==Methods==
===action_accident()===
===action_accident()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0-dev/annotate/head:/modules/Accident/lib/iHRIS_Module_Accident.php#L46 manage/modules/Accident/lib/iHRIS_Module_Accident.php] on line 46
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/Accident/lib/iHRIS_Module_Accident.php#L57 manage/modules/Accident/lib/iHRIS_Module_Accident.php] on line 57
*Signature: public function action_accident($obj)
*Signature: public function action_accident($obj)
*Parameters:
*Parameters:
**$obj  
**$obj  
===getAccidents()===
===getAccidents()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0-dev/annotate/head:/modules/Accident/lib/iHRIS_Module_Accident.php#L125 manage/modules/Accident/lib/iHRIS_Module_Accident.php] on line 125
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/Accident/lib/iHRIS_Module_Accident.php#L149 manage/modules/Accident/lib/iHRIS_Module_Accident.php] on line 149
*Signature: static public function getAccidents($person,$only_active)
*Signature: static public function getAccidents($person,$only_active)
*Parameters:
*Parameters:
Line 19: Line 19:
**$only_active  
**$only_active  
***Default Value: true
***Default Value: true
===getHooks()===
Return the array of hooks available in this module.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/Accident/lib/iHRIS_Module_Accident.php#L49 manage/modules/Accident/lib/iHRIS_Module_Accident.php] on line 49
*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-manage/4.0-dev/annotate/head:/modules/Accident/lib/iHRIS_Module_Accident.php#L39 manage/modules/Accident/lib/iHRIS_Module_Accident.php] on line 39
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/Accident/lib/iHRIS_Module_Accident.php#L39 manage/modules/Accident/lib/iHRIS_Module_Accident.php] on line 39
*Signature: static public function getMethods()
*Signature: static public function getMethods()
===postUpdateAccidentTypeFields()===
===postUpdateAccidentTypeFields()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0-dev/annotate/head:/modules/Accident/lib/iHRIS_Module_Accident.php#L169 manage/modules/Accident/lib/iHRIS_Module_Accident.php] on line 169
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/Accident/lib/iHRIS_Module_Accident.php#L193 manage/modules/Accident/lib/iHRIS_Module_Accident.php] on line 193
*Signature: protected function postUpdateAccidentTypeFields()
*Signature: protected function postUpdateAccidentTypeFields()
===preUpgradeAccidentTypeFields()===
===preUpgradeAccidentTypeFields()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0-dev/annotate/head:/modules/Accident/lib/iHRIS_Module_Accident.php#L159 manage/modules/Accident/lib/iHRIS_Module_Accident.php] on line 159
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/Accident/lib/iHRIS_Module_Accident.php#L183 manage/modules/Accident/lib/iHRIS_Module_Accident.php] on line 183
*Signature: protected function preUpgradeAccidentTypeFields()
*Signature: protected function preUpgradeAccidentTypeFields()
===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-manage/4.0-dev/annotate/head:/modules/Accident/lib/iHRIS_Module_Accident.php#L64 manage/modules/Accident/lib/iHRIS_Module_Accident.php] on line 64
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/Accident/lib/iHRIS_Module_Accident.php#L88 manage/modules/Accident/lib/iHRIS_Module_Accident.php] on line 88
*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 38: 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 ]
===showAccidents()===
===showAccidents()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0-dev/annotate/head:/modules/Accident/lib/iHRIS_Module_Accident.php#L104 manage/modules/Accident/lib/iHRIS_Module_Accident.php] on line 104
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/Accident/lib/iHRIS_Module_Accident.php#L128 manage/modules/Accident/lib/iHRIS_Module_Accident.php] on line 128
*Signature: protected function showAccidents($node,$template,$only_active)
*Signature: protected function showAccidents($node,$template,$only_active)
*Parameters:
*Parameters:
Line 45: Line 50:
**$only_active  
**$only_active  
===showAllAccidents()===
===showAllAccidents()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0-dev/annotate/head:/modules/Accident/lib/iHRIS_Module_Accident.php#L99 manage/modules/Accident/lib/iHRIS_Module_Accident.php] on line 99
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/Accident/lib/iHRIS_Module_Accident.php#L123 manage/modules/Accident/lib/iHRIS_Module_Accident.php] on line 123
*Signature: public function showAllAccidents($node,$template)
*Signature: public function showAllAccidents($node,$template)
*Parameters:
*Parameters:
Line 51: Line 56:
**$template  
**$template  
===showCurrentAccidents()===
===showCurrentAccidents()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0-dev/annotate/head:/modules/Accident/lib/iHRIS_Module_Accident.php#L95 manage/modules/Accident/lib/iHRIS_Module_Accident.php] on line 95
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/Accident/lib/iHRIS_Module_Accident.php#L119 manage/modules/Accident/lib/iHRIS_Module_Accident.php] on line 119
*Signature: public function showCurrentAccidents($node,$template)
*Signature: public function showCurrentAccidents($node,$template)
*Parameters:
*Parameters:
Line 58: Line 63:
===upgrade()===
===upgrade()===
Upgrade this module if necessary
Upgrade this module if necessary
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0-dev/annotate/head:/modules/Accident/lib/iHRIS_Module_Accident.php#L83 manage/modules/Accident/lib/iHRIS_Module_Accident.php] on line 83
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/Accident/lib/iHRIS_Module_Accident.php#L107 manage/modules/Accident/lib/iHRIS_Module_Accident.php] on line 107
*Signature: public function upgrade($old_vers,$new_vers)
*Signature: public function upgrade($old_vers,$new_vers)
*Parameters:
*Parameters:
Line 64: Line 69:
** [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_accident()===
Checks to make sure the end of applicability is after the start of applicability.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/Accident/lib/iHRIS_Module_Accident.php#L71 manage/modules/Accident/lib/iHRIS_Module_Accident.php] on line 71
*Signature: public function validate_form_accident($form)
*Parameters:
** [[Class: I2CE_Form (Development) | I2CE_Form]] $form
==Inherited Methods==
==Inherited Methods==
===__construct()===
===__construct()===
Line 79: Line 90:
===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 88: Line 96:
===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 08:26, 6 May 2015


This article describes the class iHRIS_Module_Accident .

iHRIS_Module_Accident

Methods

action_accident()

getAccidents()

getHooks()

Return the array of hooks available in this module.

getMethods()

postUpdateAccidentTypeFields()

preUpgradeAccidentTypeFields()

pre_upgrade()

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

showAccidents()

showAllAccidents()

showCurrentAccidents()

upgrade()

Upgrade this module if necessary

validate_form_accident()

Checks to make sure the end of applicability is after the start of applicability.

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