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

From IHRIS Wiki
(Created page with '{{otherversions|Class: iHRIS_Module_DisciplinaryAction}} This article describes the class ''iHRIS_Module_DisciplinaryAction'' . *Extends the class: [[Class: I2CE_Module (Developm…')
 
No edit summary
 
Line 2: Line 2:
This article describes the class ''iHRIS_Module_DisciplinaryAction'' .
This article describes the class ''iHRIS_Module_DisciplinaryAction'' .
*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)#disciplinary_action|disciplinary_action]] in the package [https://launchpad.net/ihris-manage iHRIS Manage] 4.0-dev
*Location: Part of the module [[iHRIS Manage Module List (Development)#disciplinary_action|disciplinary_action]] 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/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php#L37 modules/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php] on line 37
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php#L37 modules/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php] on line 37
*Author: Carl Leitner <litlfred@ibiblio.org>
*Author: Carl Leitner <litlfred@ibiblio.org>
iHRIS_Module_DisciplinaryAction
iHRIS_Module_DisciplinaryAction
==Methods==
==Methods==
===action_disciplinary_action()===
===action_disciplinary_action()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0-dev/annotate/head:/modules/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php#L47 manage/modules/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php] on line 47
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php#L58 manage/modules/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php] on line 58
*Signature: public function action_disciplinary_action($obj)
*Signature: public function action_disciplinary_action($obj)
*Parameters:
*Parameters:
**$obj  
**$obj  
===getDisciplinaryActions()===
===getDisciplinaryActions()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0-dev/annotate/head:/modules/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php#L127 manage/modules/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php] on line 127
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php#L151 manage/modules/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php] on line 151
*Signature: static public function getDisciplinaryActions($person,$only_active)
*Signature: static public function getDisciplinaryActions($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/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php#L50 manage/modules/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php] on line 50
*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/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php#L40 manage/modules/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php] on line 40
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php#L40 manage/modules/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php] on line 40
*Signature: static public function getMethods()
*Signature: static public function getMethods()
===postUpdateDispActionTypeFields()===
===postUpdateDispActionTypeFields()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0-dev/annotate/head:/modules/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php#L169 manage/modules/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php] on line 169
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php#L203 manage/modules/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php] on line 203
*Signature: protected function postUpdateDispActionTypeFields()
*Signature: protected function postUpdateDispActionTypeFields()
===preUpgradeDispActionTypeFields()===
===preUpgradeDispActionTypeFields()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0-dev/annotate/head:/modules/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php#L159 manage/modules/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php] on line 159
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php#L193 manage/modules/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php] on line 193
*Signature: protected function preUpgradeDispActionTypeFields()
*Signature: protected function preUpgradeDispActionTypeFields()
===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/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php#L66 manage/modules/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php] on line 66
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php#L90 manage/modules/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php] on line 90
*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 ]
===showActions()===
===showActions()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0-dev/annotate/head:/modules/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php#L106 manage/modules/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php] on line 106
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php#L130 manage/modules/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php] on line 130
*Signature: protected function showActions($node,$template,$only_active)
*Signature: protected function showActions($node,$template,$only_active)
*Parameters:
*Parameters:
Line 45: Line 50:
**$only_active  
**$only_active  
===showAllActions()===
===showAllActions()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0-dev/annotate/head:/modules/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php#L101 manage/modules/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php] on line 101
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php#L125 manage/modules/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php] on line 125
*Signature: public function showAllActions($node,$template)
*Signature: public function showAllActions($node,$template)
*Parameters:
*Parameters:
Line 51: Line 56:
**$template  
**$template  
===showCurrentActions()===
===showCurrentActions()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0-dev/annotate/head:/modules/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php#L97 manage/modules/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php] on line 97
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php#L121 manage/modules/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php] on line 121
*Signature: public function showCurrentActions($node,$template)
*Signature: public function showCurrentActions($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/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php#L85 manage/modules/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php] on line 85
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php#L109 manage/modules/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php] on line 109
*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_disciplinary_action()===
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/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php#L72 manage/modules/Disciplinary/lib/iHRIS_Module_DisciplinaryAction.php] on line 72
*Signature: public function validate_form_disciplinary_action($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 09:26, 6 May 2015


This article describes the class iHRIS_Module_DisciplinaryAction .

iHRIS_Module_DisciplinaryAction

Methods

action_disciplinary_action()

getDisciplinaryActions()

getHooks()

Return the array of hooks available in this module.

getMethods()

postUpdateDispActionTypeFields()

preUpgradeDispActionTypeFields()

pre_upgrade()

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

showActions()

showAllActions()

showCurrentActions()

upgrade()

Upgrade this module if necessary

validate_form_disciplinary_action()

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