Class: iHRIS Module Person (Development): Difference between revisions
(Created page with '{{otherversions|Class: iHRIS_Module_Person}} This article describes the class ''iHRIS_Module_Person'' . *Extends the class: I2CE_Module. *L…') |
No edit summary |
||
Line 2: | Line 2: | ||
This article describes the class ''iHRIS_Module_Person'' . | This article describes the class ''iHRIS_Module_Person'' . | ||
*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)#Person|Person]] in the package [https://launchpad.net/ihris-common iHRIS Common] 4. | *Location: Part of the module [[iHRIS Common Module List (Development)#Person|Person]] 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. | *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/modules/Person/lib/iHRIS_Module_Person.php#L33 modules/Person/lib/iHRIS_Module_Person.php] on line 33 | ||
*Author: Carl Leitner <litlfred@ibiblio.org> | *Author: Carl Leitner <litlfred@ibiblio.org> | ||
*Since: v3.2 | *Since: v3.2 | ||
@filesource Class iHRIS_Module_PersonDemographic | @filesource Class iHRIS_Module_PersonDemographic | ||
==Methods== | ==Methods== | ||
===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/Person/lib/iHRIS_Module_Person.php#L40 common/modules/Person/lib/iHRIS_Module_Person.php] on line 40 | |||
*Signature: static public function getHooks() | |||
*Returns: [http://www.php.net/manual/en/language.types.array.php array ] | |||
===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. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/modules/Person/lib/iHRIS_Module_Person.php#L100 common/modules/Person/lib/iHRIS_Module_Person.php] on line 100 | ||
*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 17: | Line 22: | ||
** [[Class: I2CE_MagicDataNode (Development) | I2CE_MagicDataNode]] $new_storage | ** [[Class: I2CE_MagicDataNode (Development) | I2CE_MagicDataNode]] $new_storage | ||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | ||
===upgrade()=== | |||
Upgrade this module if necessary | |||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/modules/Person/lib/iHRIS_Module_Person.php#L121 common/modules/Person/lib/iHRIS_Module_Person.php] on line 121 | |||
*Signature: public function upgrade($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 ] | |||
===validate_form_person()=== | |||
Perform extra validation for the person form. A new person record needs to verify there aren't any existing records with the same name. | |||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/modules/Person/lib/iHRIS_Module_Person.php#L52 common/modules/Person/lib/iHRIS_Module_Person.php] on line 52 | |||
*Signature: public function validate_form_person($form) | |||
*Parameters: | |||
** [[Class: I2CE_Form (Development) | I2CE_Form]] $form | |||
==Inherited Methods== | ==Inherited Methods== | ||
===__construct()=== | ===__construct()=== | ||
Line 32: | Line 51: | ||
===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()]] | ||
===getCLIMethods()=== | ===getCLIMethods()=== | ||
Line 41: | Line 57: | ||
===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()]] | ||
===getMethods()=== | ===getMethods()=== | ||
Line 50: | Line 63: | ||
===post_update()=== | ===post_update()=== | ||
This public method is inherited from [[Class: I2CE_Module (Development)#post_update() | I2CE_Module->post_update()]] | This public method is inherited from [[Class: I2CE_Module (Development)#post_update() | I2CE_Module->post_update()]] | ||
===_hasMethod()=== | ===_hasMethod()=== |
Latest revision as of 08:26, 6 May 2015
This article describes the class iHRIS_Module_Person .
- Extends the class: I2CE_Module.
- Location: Part of the module Person in the package iHRIS Common 4.1-dev
- Source: Defined in the file modules/Person/lib/iHRIS_Module_Person.php on line 33
- Author: Carl Leitner <litlfred@ibiblio.org>
- Since: v3.2
@filesource Class iHRIS_Module_PersonDemographic
Methods
getHooks()
Return the array of hooks available in this module.
- Defined in common/modules/Person/lib/iHRIS_Module_Person.php on line 40
- Signature: static public function getHooks()
- Returns: array
pre_upgrade()
Run the pre upgrade for this module. This can use the old config data before it has been changed from the config.
- Defined in common/modules/Person/lib/iHRIS_Module_Person.php on line 100
- Signature: public function pre_upgrade($old_vers,$new_vers,$new_storage)
- Parameters:
- string $old_vers
- string $new_vers
- I2CE_MagicDataNode $new_storage
- Returns: boolean
upgrade()
Upgrade this module if necessary
- Defined in common/modules/Person/lib/iHRIS_Module_Person.php on line 121
- Signature: public function upgrade($old_vers,$new_vers)
- Parameters:
- Returns: boolean
validate_form_person()
Perform extra validation for the person form. A new person record needs to verify there aren't any existing records with the same name.
- Defined in common/modules/Person/lib/iHRIS_Module_Person.php on line 52
- Signature: public function validate_form_person($form)
- Parameters:
- I2CE_Form $form
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()
getMethods()
This public method is inherited from I2CE_Module->getMethods()
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()