Class: iHRIS Module Contact: Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
Line 2: Line 2:
*Extends the class: [[Class: I2CE_Module | I2CE_Module]].
*Extends the class: [[Class: I2CE_Module | I2CE_Module]].
*Parent Classses:  [[Class: I2CE_Module | I2CE_Module]] [[Class: I2CE_Fuzzy | I2CE_Fuzzy]]
*Parent Classses:  [[Class: I2CE_Module | I2CE_Module]] [[Class: I2CE_Fuzzy | I2CE_Fuzzy]]
*Location: Part of the module [[iHRIS Module List#Contact|Contact]] in the package [https://launchpad.net/ihris-common iHRIS Common]
*Location: Part of the module [[iHRIS Common Module List#Contact|Contact]] in the package [https://launchpad.net/ihris-common iHRIS Common]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0.0-release/annotate/head:/modules/Contact/lib/iHRIS_Module_Contact.php modules/Contact/lib/iHRIS_Module_Contact.php]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0.0-release/annotate/head:/modules/Contact/lib/iHRIS_Module_Contact.php modules/Contact/lib/iHRIS_Module_Contact.php]
*Author: Luke Duncan <lduncan@intrahealth.org>
*Author: Luke Duncan <lduncan@intrahealth.org>
Line 47: Line 47:
** [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 ]
==Inherited Methods==
===__construct()===
This public method is inherited from [[Class: I2CE_Module#__construct() | I2CE_Module->__construct()]]
===action_configure()===
This public method is inherited from [[Class: I2CE_Module#action_configure() | I2CE_Module->action_configure()]]
===action_disable()===
This public method is inherited from [[Class: I2CE_Module#action_disable() | I2CE_Module->action_disable()]]
===action_enable()===
This public method is inherited from [[Class: I2CE_Module#action_enable() | I2CE_Module->action_enable()]]
===action_initialize()===
This public method is inherited from [[Class: I2CE_Module#action_initialize() | I2CE_Module->action_initialize()]]
===conflict_external()===
This public method is inherited from [[Class: I2CE_Module#conflict_external() | I2CE_Module->conflict_external()]]
===getCLIHooks()===
This public method is inherited from [[Class: I2CE_Module#getCLIHooks() | I2CE_Module->getCLIHooks()]]
===getCLIMethods()===
This public method is inherited from [[Class: I2CE_Module#getCLIMethods() | I2CE_Module->getCLIMethods()]]
===getConfig()===
This public method is inherited from [[Class: I2CE_Module#getConfig() | I2CE_Module->getConfig()]]
===getHooks()===
This public method is inherited from [[Class: I2CE_Module#getHooks() | I2CE_Module->getHooks()]]
===getMethods()===
This public method is inherited from [[Class: I2CE_Module#getMethods() | I2CE_Module->getMethods()]]
===post_update()===
This public method is inherited from [[Class: I2CE_Module#post_update() | I2CE_Module->post_update()]]
===requirement_external()===
This public method is inherited from [[Class: I2CE_Module#requirement_external() | I2CE_Module->requirement_external()]]
===_hasMethod()===
This public method is inherited from [[Class: I2CE_Fuzzy#_hasMethod() | I2CE_Fuzzy->_hasMethod()]]
==Inherited Fuzzy Methods==
===launchBackgroundProcess()===
This method is inherited from [[Class: I2CE_Module#launchBackgroundProcess() | I2CE_Module->launchBackgroundProcess()]]
===launchBackgroundPHPScript()===
This method is inherited from [[Class: I2CE_Module#launchBackgroundPHPScript() | I2CE_Module->launchBackgroundPHPScript()]]
===launchBackgroundPage()===
This method is inherited from [[Class: I2CE_Module#launchBackgroundPage() | I2CE_Module->launchBackgroundPage()]]
===userMessage()===
This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]]




[[Category:Class Documentation]]
[[Category:Class Documentation]]

Revision as of 12:11, 19 October 2009

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.

  • 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.

  • 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

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

upgrade()

Upgrade this module if necessary

  • Signature: public function upgrade($old_vers,$new_vers)
  • Parameters:
  • Returns: boolean
Retrieved from "https://wiki.ihris.org/mediawiki/index.php?title=Class:_iHRIS_Module_Contact&oldid=9802"