Class: iHRIS Module Contact

This article desrcibes the class iHRIS_Module_Contact which extends the class I2CE_Module It is contained in the module Contact in the package iHRIS Common

The class is defined in the file: modules/Contact/lib/iHRIS_Module_Contact.php

I2CE_Module_Contact

@package iHRIS

@subpackage Common

@author Luke Duncan <lduncan@intrahealth.org>

@author Carl Leitner <litlfred@intrahealth.org>

@version 3.2.3

@since 3.2.3

@access public

Variables

$constant_migrate

@var protected static $constant_migraate array with keys the numeric ids of contact types before the new I2CE_FormField_MAPPED was introduced. The values are the corresponding id's after I2CE_FormField_MAPPED.

• Type: static protected $constant_migrate

Methods

changeContactForm()

Change the all child contact form with given type of a form to a form which subclasses the contact form.

@param string This function assumes that iHRIS_Module_Contact->upgrade() has been called for $new_vers >= 3.2.5 so that the $contact_type should be one of the values of {@link iHRIS_Module_Contact::$contact_type}. E.g. 'contact_type|facilty'

• Signature: static public function changeContactForm($parent_form,$contact_type,$new_child_form,$delete_old,$remove_contact)
• Returns: boolean. True on success.

Parameters:

• string $parent_form
  The parent form
• $contact_type
• string $new_child_form
  The new child form (which should subclass contact) in which the existing values are to be saved.
• boolean $delete_old
  If true the old child (matching) forms are removed
• boolean $remove_contact
  Defaults to true in which case we remove 'contact' as a child form
  • Default Value: true

pre_upgrade()

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

• Signature: public function pre_upgrade($old_vers,$new_vers,$new_storage)
• Returns: boolean

Parameters:

• string $old_vers
• string $new_vers
• I2CE_MagicDataNode $new_storage

removeContactForm()

Remove the contact form from the given parent form

• Signature: static public function removeContactForm($parent_form)
• Returns: booelan. true on success

Parameters:

• string $parent_form

upgrade()

Upgrade this module if necessary

• Signature: public function upgrade($old_vers,$new_vers)
• Returns: boolean

Parameters:

• string $old_vers
• string $new_vers

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