|
|
| (16 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| This article describes the class ''iHRIS_Contact''.
| | #REDIRECT [[Class: iHRIS_Contact (4.1.7)]] |
| *Extends the class: [[Class: I2CE_List | I2CE_List]].
| |
| *Location: Part of the module [[iHRIS 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_Contact.php modules/Contact/lib/iHRIS_Contact.php]
| |
| *Author: Luke Duncan <lduncan@intrahealth.org>
| |
| *Since: v1.0.0
| |
| @copyright Copyright © 2007, 2008 IntraHealth International, Inc. Object for dealing with contacts.
| |
| ==Form Fields==
| |
| This class is a [[Class: I2CE_Form |form class]] and provides the following [[Class: I2CE_FormField |form fields]]
| |
| ==address==
| |
| The form field ''address'' is implemented by [[Class: I2CE_FormField_STRING_MLINE |STRING_MLINE ]]
| |
| ==telephone==
| |
| The form field ''telephone'' is implemented by [[Class: I2CE_FormField_STRING_LINE |STRING_LINE ]]
| |
| ==alt_telephone==
| |
| The form field ''alt_telephone'' is implemented by [[Class: I2CE_FormField_STRING_LINE |STRING_LINE ]]
| |
| ==fax==
| |
| The form field ''fax'' is implemented by [[Class: I2CE_FormField_STRING_LINE |STRING_LINE ]]
| |
| ==email==
| |
| The form field ''email'' is implemented by [[Class: I2CE_FormField_STRING_LINE |STRING_LINE ]]
| |
| ==notes==
| |
| The form field ''notes'' is implemented by [[Class: I2CE_FormField_STRING_MLINE |STRING_MLINE ]]
| |
| ==Constants==
| |
| ===iHRIS_Contact::MAIN_FIELD===
| |
| The main field name used for display a description of a record.
| |
| Defined as: "contact_type"
| |
| ===iHRIS_Contact::TYPE_PERSONAL===
| |
| Constant values for contact types: Personal.
| |
| Defined as: 1
| |
| ===iHRIS_Contact::TYPE_WORK===
| |
| Constant values for contact types: Work.
| |
| Defined as: 2
| |
| ===iHRIS_Contact::TYPE_EMERGENCY===
| |
| Constant values for contact types: Emergency.
| |
| Defined as: 3
| |
| ===iHRIS_Contact::TYPE_OTHER===
| |
| Constant values for contact types: Other.
| |
| Defined as: 4
| |
| ===iHRIS_Contact::TYPE_FACILITY===
| |
| Constant values for contact types: Facility.
| |
| Defined as: 5
| |
| ==Variables==
| |
| ===$types===
| |
| The list of contact types.
| |
| *Type: static protected [http://www.php.net/manual/en/language.types.array.php array ] $types
| |
| | |
| ==Methods==
| |
| ===listTypeOptions()===
| |
| List all the options from the status array. The facility type isn't displayed since that's only used for facility contact info and is automatically set on those.
| |
| *Signature: static public function listTypeOptions($form)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $form <br/>The form we wish to lookup by
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array ]
| |
| ===lookupType()===
| |
| Lookup the given value from the status array.
| |
| *Signature: static public function lookupType($id,$form)
| |
| *Parameters:
| |
| ** integer $id
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $form <br/>Not used for this method.
| |
| ***Default Value: ""
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
