Class: iHRIS Contact: Difference between revisions
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
This article desrcibes the class '''iHRIS_Contact''' | This article desrcibes the class '''iHRIS_Contact'''. | ||
*Extends the class: [[Class: I2CE_List | I2CE_List]]. | |||
It is contained in the module [[iHRIS Module List#Contact|Contact]] in the package [https://launchpad.net/ihris-common iHRIS Common] | It is contained in the module [[iHRIS Module List#Contact|Contact]] in the package [https://launchpad.net/ihris-common iHRIS Common] | ||
| Line 41: | Line 42: | ||
is automatically set on those. | is automatically set on those. | ||
*Signature: static public function listTypeOptions($form) | *Signature: static public function listTypeOptions($form) | ||
*Returns: [http://www.php.net/manual/en/language.types.array.php array] | *Returns: [http://www.php.net/manual/en/language.types.array.php array ] | ||
Parameters: | Parameters: | ||
* [http://www.php.net/manual/en/language.types.string.php string] $form<br/>The form we wish to lookup by | * [http://www.php.net/manual/en/language.types.string.php string ] $form<br/>The form we wish to lookup by | ||
===lookupType()=== | ===lookupType()=== | ||
Lookup the given value from the status array. | Lookup the given value from the status array. | ||
*Signature: static public function lookupType($id,$form) | *Signature: static public function lookupType($id,$form) | ||
*Returns: [http://www.php.net/manual/en/language.types.string.php string] | *Returns: [http://www.php.net/manual/en/language.types.string.php string ] | ||
Parameters: | Parameters: | ||
* integer $id | * integer $id | ||
* [http://www.php.net/manual/en/language.types.string.php string] $form<br/>Not used for this method. | * [http://www.php.net/manual/en/language.types.string.php string ] $form<br/>Not used for this method. | ||
**Default Value: "" | **Default Value: "" | ||
==Inherited Variables== | ==Inherited Variables== | ||
Revision as of 22:24, 16 October 2009
This article desrcibes the class iHRIS_Contact.
- Extends the class: I2CE_List.
It is contained in the module Contact in the package iHRIS Common
The class is defined in the file: modules/Contact/lib/iHRIS_Contact.php
@subpackage Manage @copyright Copyright © 2007, 2008 IntraHealth International, Inc. Object for dealing with contacts. @subpackage Manage
- Author: Luke Duncan <lduncan@intrahealth.org>
- Since: v1.0.0
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 y $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)
- Returns: array
Parameters:
- string $form
The form we wish to lookup by
lookupType()
Lookup the given value from the status array.
- Signature: static public function lookupType($id,$form)
- Returns: string
Parameters:
- integer $id
- string $form
Not used for this method.- Default Value: ""
Inherited Variables
$cache
Theis protected variable is inherited from I2CE_List->$cache
$children
Theis public variable is inherited from I2CE_Form->$children
$fields
Theis protected variable is inherited from I2CE_Form->$fields
$parent
Theis protected variable is inherited from I2CE_Form->$parent
$id
Theis protected variable is inherited from I2CE_Form->$id
$attributes
Theis protected variable is inherited from I2CE_Form->$attributes
$parent_forms
Theis protected variable is inherited from I2CE_Form->$parent_forms
Inherited Fuzzy Methods
isNumeric()
This method is inherited from I2CE_Form->isNumeric()
getLimitStyles()
This method is inherited from I2CE_Form->getLimitStyles()
checkLimit()
This method is inherited from I2CE_Form->checkLimit()
checkWhereClause()
This method is inherited from I2CE_Form->checkWhereClause()
createCheckFunction()
This method is inherited from I2CE_Form->createCheckFunction()
createCheckLimitString()
This method is inherited from I2CE_Form->createCheckLimitString()
generateLimit()
This method is inherited from I2CE_Form->generateLimit()
generateWhereClause()
This method is inherited from I2CE_Form->generateWhereClause()
processLimit()
This method is inherited from I2CE_Form->processLimit()
getDisplayedExistingLimit()
This method is inherited from I2CE_Form->getDisplayedExistingLimit()
isComponentized()
This method is inherited from I2CE_Form->isComponentized()
addChild()
This method is inherited from I2CE_Form->addChild()
getChildIds()
This method is inherited from I2CE_Form->getChildIds()
getStorage()
This method is inherited from I2CE_Form->getStorage()
isWritable()
This method is inherited from I2CE_Form->isWritable()
populate()
This method is inherited from I2CE_Form->populate()
populateChild()
This method is inherited from I2CE_Form->populateChild()
populateChildren()
This method is inherited from I2CE_Form->populateChildren()
populateFirst()
This method is inherited from I2CE_Form->populateFirst()
populateHistory()
This method is inherited from I2CE_Form->populateHistory()
populateLast()
This method is inherited from I2CE_Form->populateLast()
delete()
This method is inherited from I2CE_Form->delete()
save()
This method is inherited from I2CE_Form->save()
setChangeType()
This method is inherited from I2CE_Form->setChangeType()
userMessage()
This method is inherited from I2CE_Fuzzy->userMessage()
