Class: iHRIS Module Contact (Development)

From IHRIS Wiki
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.


This article describes the class iHRIS_Module_Contact .

  • Author: Carl Leitner <litlfred@intrahealth.org>
  • Since: 3.2.3

I2CE_Module_Contact

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.

Methods

changeContactForm()

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

  • Defined in common/modules/Contact/lib/iHRIS_Module_Contact.php on line 113
  • Signature: static public function changeContactForm($parent_form,$contact_type,$new_child_form,$delete_old,$remove_contact)
  • Parameters:
    • string $parent_form
      The parent 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  ::$contact_type. E.g. 'contact_type|facilty'
    • $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
  • Returns: boolean.
    True on success.

pre_upgrade()

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

removeContactForm()

Remove the contact form from the given parent form

upgrade()

Upgrade this module if necessary

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

getHooks()

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

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