Class: iHRIS Contact: Difference between revisions

From IHRIS Wiki
No edit summary
(Redirected page to Class: iHRIS Contact (4.1.7))
 
(27 intermediate revisions by the same user not shown)
Line 1: Line 1:
This article desrcibes the class '''iHRIS_Contact''' which extends the class [[Class: I2CE_List | I2CE_List]]
#REDIRECT [[Class: iHRIS_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_Contact.php 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: [http://www.php.net/manual/en/language.types.array.php array]
Parameters:
* [http://www.php.net/manual/en/language.types.string.php string] $form<br/>The  form we wish to lookup by
===lookupType()===
Lookup the given value from the status array.
*Signature: static public function lookupType($id,$form)
*Returns: [http://www.php.net/manual/en/language.types.string.php string]
Parameters:
* integer $id
* [http://www.php.net/manual/en/language.types.string.php string] $form<br/>Not used for this method.
**Default Value: ""
==Inherited Variables==
===$cache===
Theis protected variable is inherited from [[Class: I2CE_List#$cache | I2CE_List->$cache]]
 
===$children===
Theis public variable is inherited from [[Class: I2CE_Form#$children | I2CE_Form->$children]]
 
===$fields===
Theis protected variable is inherited from [[Class: I2CE_Form#$fields | I2CE_Form->$fields]]
 
===$parent===
Theis protected variable is inherited from [[Class: I2CE_Form#$parent | I2CE_Form->$parent]]
 
===$id===
Theis protected variable is inherited from [[Class: I2CE_Form#$id | I2CE_Form->$id]]
 
===$attributes===
Theis protected variable is inherited from [[Class: I2CE_Form#$attributes | I2CE_Form->$attributes]]
 
===$parent_forms===
Theis protected variable is inherited from [[Class: I2CE_Form#$parent_forms | I2CE_Form->$parent_forms]]
==Inherited Fuzzy Methods==
===isNumeric()===
This method is inherited from [[Class: I2CE_Form#isNumeric() | I2CE_Form->isNumeric()]]
 
===getLimitStyles()===
This method is inherited from [[Class: I2CE_Form#getLimitStyles() | I2CE_Form->getLimitStyles()]]
 
===checkLimit()===
This method is inherited from [[Class: I2CE_Form#checkLimit() | I2CE_Form->checkLimit()]]
 
===checkWhereClause()===
This method is inherited from [[Class: I2CE_Form#checkWhereClause() | I2CE_Form->checkWhereClause()]]
 
===createCheckFunction()===
This method is inherited from [[Class: I2CE_Form#createCheckFunction() | I2CE_Form->createCheckFunction()]]
 
===createCheckLimitString()===
This method is inherited from [[Class: I2CE_Form#createCheckLimitString() | I2CE_Form->createCheckLimitString()]]
 
===generateLimit()===
This method is inherited from [[Class: I2CE_Form#generateLimit() | I2CE_Form->generateLimit()]]
 
===generateWhereClause()===
This method is inherited from [[Class: I2CE_Form#generateWhereClause() | I2CE_Form->generateWhereClause()]]
 
===processLimit()===
This method is inherited from [[Class: I2CE_Form#processLimit() | I2CE_Form->processLimit()]]
 
===getDisplayedExistingLimit()===
This method is inherited from [[Class: I2CE_Form#getDisplayedExistingLimit() | I2CE_Form->getDisplayedExistingLimit()]]
 
===isComponentized()===
This method is inherited from [[Class: I2CE_Form#isComponentized() | I2CE_Form->isComponentized()]]
 
===addChild()===
This method is inherited from [[Class: I2CE_Form#addChild() | I2CE_Form->addChild()]]
 
===getChildIds()===
This method is inherited from [[Class: I2CE_Form#getChildIds() | I2CE_Form->getChildIds()]]
 
===getStorage()===
This method is inherited from [[Class: I2CE_Form#getStorage() | I2CE_Form->getStorage()]]
 
===isWritable()===
This method is inherited from [[Class: I2CE_Form#isWritable() | I2CE_Form->isWritable()]]
 
===populate()===
This method is inherited from [[Class: I2CE_Form#populate() | I2CE_Form->populate()]]
 
===populateChild()===
This method is inherited from [[Class: I2CE_Form#populateChild() | I2CE_Form->populateChild()]]
 
===populateChildren()===
This method is inherited from [[Class: I2CE_Form#populateChildren() | I2CE_Form->populateChildren()]]
 
===populateFirst()===
This method is inherited from [[Class: I2CE_Form#populateFirst() | I2CE_Form->populateFirst()]]
 
===populateHistory()===
This method is inherited from [[Class: I2CE_Form#populateHistory() | I2CE_Form->populateHistory()]]
 
===populateLast()===
This method is inherited from [[Class: I2CE_Form#populateLast() | I2CE_Form->populateLast()]]
 
===delete()===
This method is inherited from [[Class: I2CE_Form#delete() | I2CE_Form->delete()]]
 
===save()===
This method is inherited from [[Class: I2CE_Form#save() | I2CE_Form->save()]]
 
===setChangeType()===
This method is inherited from [[Class: I2CE_Form#setChangeType() | I2CE_Form->setChangeType()]]
 
===userMessage()===
This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]]
 
 
[[Category:Class Documentation]]

Latest revision as of 09:54, 23 August 2013