|
|
| (28 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| This article desrcibes the class '''iHRIS_Module_Contact''' which extends the class [[Class: I2CE_Module | I2CE_Module]]
| | #REDIRECT [[Class: iHRIS_Module_Contact (4.1.7)]] |
| It is contained in the module [[iHRIS Module List#Contact|Contact]] in the package [https://launchpad.net/ihris-common iHRIS Common]
| |
| | |
| The class is 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]
| |
| | |
| I2CE_Module_Contact
| |
| @subpackage Common
| |
| *Author: Luke Duncan <lduncan@intrahealth.org>
| |
| | |
| *Author: Carl Leitner <litlfred@intrahealth.org>
| |
| *Since: 3.2.3
| |
| ==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:
| |
| * [http://www.php.net/manual/en/language.types.string.php string] $parent_form<br/>The parent form
| |
| *$contact_type
| |
| * [http://www.php.net/manual/en/language.types.string.php string] $new_child_form<br/>The new child form (which should subclass contact) in which the existing values are to be saved.
| |
| * [http://www.php.net/manual/en/language.types.boolean.php boolean] $delete_old<br/>If true the old child (matching) forms are removed
| |
| * [http://www.php.net/manual/en/language.types.boolean.php boolean] $remove_contact<br/>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: [http://www.php.net/manual/en/language.types.boolean.php boolean]
| |
| 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
| |
| * [[Class: I2CE_MagicDataNode | 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:
| |
| * [http://www.php.net/manual/en/language.types.string.php string] $parent_form
| |
| ===upgrade()===
| |
| Upgrade this module if necessary
| |
| *Signature: public function upgrade($old_vers,$new_vers)
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean]
| |
| 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
| |
| ==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]]
| |
