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

From IHRIS Wiki
(Created page with '{{otherversions|Class: iHRIS_Module_PersonContact}} This article describes the class ''iHRIS_Module_PersonContact'' . *Extends the class: [[Class: I2CE_Module (Development) | I2C…')
 
No edit summary
 
Line 2: Line 2:
This article describes the class ''iHRIS_Module_PersonContact'' .
This article describes the class ''iHRIS_Module_PersonContact'' .
*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)#PersonContact|PersonContact]] in the package [https://launchpad.net/ihris-common iHRIS Common] 4.0-dev
*Location: Part of the module [[iHRIS Common Module List (Development)#PersonContact|PersonContact]] 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/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php#L34 modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php] on line 34
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php#L34 modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php] on line 34
*Author: Carl Leitner <litlfred@ibiblio.org>
*Author: Carl Leitner <litlfred@ibiblio.org>
*Since: v3.2
*Since: v3.2
Line 9: Line 9:
==Variables==
==Variables==
===$contacts===
===$contacts===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0-dev/annotate/head:/modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php#L46 common/modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php] on line 46
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php#L46 common/modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php] on line 46
*Type: static protected $contacts
*Type: static protected $contacts


==Methods==
==Methods==
===action_contact()===
===action_contact()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0-dev/annotate/head:/modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php#L108 common/modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php] on line 108
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php#L133 common/modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php] on line 133
*Signature: protected function action_contact($page,$contact)
*Signature: protected function action_contact($page,$contact)
*Parameters:
*Parameters:
Line 20: Line 20:
**$contact  
**$contact  
===action_person_contact_emergency()===
===action_person_contact_emergency()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0-dev/annotate/head:/modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php#L99 common/modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php] on line 99
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php#L124 common/modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php] on line 124
*Signature: public function action_person_contact_emergency($page)
*Signature: public function action_person_contact_emergency($page)
*Parameters:
*Parameters:
**$page  
**$page  
===action_person_contact_other()===
===action_person_contact_other()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0-dev/annotate/head:/modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php#L102 common/modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php] on line 102
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php#L127 common/modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php] on line 127
*Signature: public function action_person_contact_other($page)
*Signature: public function action_person_contact_other($page)
*Parameters:
*Parameters:
**$page  
**$page  
===action_person_contact_personal()===
===action_person_contact_personal()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0-dev/annotate/head:/modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php#L96 common/modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php] on line 96
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php#L121 common/modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php] on line 121
*Signature: public function action_person_contact_personal($page)
*Signature: public function action_person_contact_personal($page)
*Parameters:
*Parameters:
**$page  
**$page  
===action_person_contact_work()===
===action_person_contact_work()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0-dev/annotate/head:/modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php#L93 common/modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php] on line 93
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php#L118 common/modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php] on line 118
*Signature: public function action_person_contact_work($page)
*Signature: public function action_person_contact_work($page)
*Parameters:
*Parameters:
**$page  
**$page  
===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/modules/Contact/lib/iHRIS_Module_PersonContact.php#L52 common/modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php] on line 52
*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/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php#L36 common/modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php] on line 36
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php#L36 common/modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php] on line 36
*Signature: static public function getMethods()
*Signature: static public function getMethods()
===post_update()===
===post_update()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0-dev/annotate/head:/modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php#L64 common/modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php] on line 64
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php#L89 common/modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php] on line 89
*Signature: public function post_update($old_vers,$new_vers)
*Signature: public function post_update($old_vers,$new_vers)
*Parameters:
*Parameters:
Line 49: Line 54:
**$new_vers  
**$new_vers  
===updateContacts()===
===updateContacts()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0-dev/annotate/head:/modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php#L75 common/modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php] on line 75
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php#L100 common/modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php] on line 100
*Signature: protected function updateContacts()
*Signature: protected function updateContacts()
===upgrade()===
===upgrade()===
Upgrades the modules
Upgrades the modules
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0-dev/annotate/head:/modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php#L55 common/modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php] on line 55
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php#L80 common/modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php] on line 80
*Signature: public function upgrade($old_vers,$new_vers)
*Signature: public function upgrade($old_vers,$new_vers)
*Parameters:
*Parameters:
Line 59: Line 64:
** [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_contact_field_email()===
Validate the email field for contact forms.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php#L64 common/modules/Person/modules/Contact/lib/iHRIS_Module_PersonContact.php] on line 64
*Signature: public function validate_form_contact_field_email($formfield)
*Parameters:
** [[Class: I2CE_FormField (Development) | I2CE_FormField]] $formfield
==Inherited Methods==
==Inherited Methods==
===__construct()===
===__construct()===
Line 74: Line 85:
===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 83: Line 91:
===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()]]


===pre_upgrade()===
===pre_upgrade()===

Latest revision as of 09:26, 6 May 2015


This article describes the class iHRIS_Module_PersonContact .

@filesource Class iHRIS_Module_PersonContact

Variables

$contacts

Methods

action_contact()

action_person_contact_emergency()

action_person_contact_other()

action_person_contact_personal()

action_person_contact_work()

getHooks()

Return the array of hooks available in this module.

getMethods()

post_update()

updateContacts()

upgrade()

Upgrades the modules

validate_form_contact_field_email()

Validate the email field for contact forms.

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

pre_upgrade()

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

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