Class: iHRIS Contact (Development): Difference between revisions

From IHRIS Wiki
(Created page with '{{otherversions|Class: iHRIS_Contact}} This article describes the class ''iHRIS_Contact'' . *Extends the class: I2CE_List. *Location: Part of…')
 
No edit summary
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{otherversions|Class: iHRIS_Contact}}
{{otherversions|Class: iHRIS_Contact}}
This article describes the class ''iHRIS_Contact'' .
This article describes the class ''iHRIS_Contact'' .
*Extends the class: [[Class: I2CE_List (Development) | I2CE_List]].
*Extends the class: [[Class: I2CE_Form (Development) | I2CE_Form]].
*Location: Part of the module [[iHRIS Common Module List (Development)#Contact|Contact]] in the package [https://launchpad.net/ihris-common iHRIS Common] 4.0-dev
*Child Classes:
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0-dev/annotate/head:/modules/Contact/lib/iHRIS_Contact.php#L35 modules/Contact/lib/iHRIS_Contact.php] on line 35
** [[Class: iHRIS_NamedContact (Development) | iHRIS_NamedContact]]
** [[Class: iHRIS_NextOfKin (Development) | iHRIS_NextOfKin]]
*Location: Part of the module [[iHRIS Common Module List (Development)#Contact|Contact]] in the package [https://launchpad.net/ihris-common iHRIS Common] 4.1-dev
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/modules/Contact/lib/iHRIS_Contact.php#L35 modules/Contact/lib/iHRIS_Contact.php] on line 35
*Author: Luke Duncan <lduncan@intrahealth.org>
*Author: Luke Duncan <lduncan@intrahealth.org>
*Since: v1.0.0
*Since: v1.0.0
Line 13: Line 16:
===telephone===
===telephone===
The form field ''telephone'' is implemented by [[Class: I2CE_FormField_STRING_LINE (Development) |STRING_LINE ]]
The form field ''telephone'' is implemented by [[Class: I2CE_FormField_STRING_LINE (Development) |STRING_LINE ]]
===mobile_phone===
The form field ''mobile_phone'' is implemented by [[Class: I2CE_FormField_STRING_LINE (Development) |STRING_LINE ]]
===alt_telephone===
===alt_telephone===
The form field ''alt_telephone'' is implemented by [[Class: I2CE_FormField_STRING_LINE (Development) |STRING_LINE ]]
The form field ''alt_telephone'' is implemented by [[Class: I2CE_FormField_STRING_LINE (Development) |STRING_LINE ]]
Line 21: Line 26:
===notes===
===notes===
The form field ''notes'' is implemented by [[Class: I2CE_FormField_STRING_MLINE (Development) |STRING_MLINE ]]
The form field ''notes'' is implemented by [[Class: I2CE_FormField_STRING_MLINE (Development) |STRING_MLINE ]]
==Inherited Form Fields==
===i2ce_hidden===
The form field ''i2ce_hidden'' is implemented by [[Class: I2CE_FormField_YESNO (Development) |YESNO ]]is inherited from the class [[Class: I2CE_List (Development)|I2CE_List]]
==Constants==
==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===
===iHRIS_Contact::TYPE_PERSONAL===
Constant values for contact types: Personal.
Constant values for contact types: Personal.
Line 47: Line 45:
===$types===
===$types===
The list of contact types.
The list of contact types.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0-dev/annotate/head:/modules/Contact/lib/iHRIS_Contact.php#L65 common/modules/Contact/lib/iHRIS_Contact.php] on line 65
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/modules/Contact/lib/iHRIS_Contact.php#L61 common/modules/Contact/lib/iHRIS_Contact.php] on line 61
*Type: static protected [http://www.php.net/manual/en/language.types.array.php array ] $types
*Type: static protected [http://www.php.net/manual/en/language.types.array.php array ] $types


Line 53: Line 51:
===listTypeOptions()===
===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.
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.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0-dev/annotate/head:/modules/Contact/lib/iHRIS_Contact.php#L88 common/modules/Contact/lib/iHRIS_Contact.php] on line 88
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/modules/Contact/lib/iHRIS_Contact.php#L84 common/modules/Contact/lib/iHRIS_Contact.php] on line 84
*Signature: static public function listTypeOptions($form)
*Signature: static public function listTypeOptions($form)
*Parameters:
*Parameters:
Line 60: Line 58:
===lookupType()===
===lookupType()===
Lookup the given value from the status array.
Lookup the given value from the status array.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0-dev/annotate/head:/modules/Contact/lib/iHRIS_Contact.php#L77 common/modules/Contact/lib/iHRIS_Contact.php] on line 77
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.1-dev/annotate/head:/modules/Contact/lib/iHRIS_Contact.php#L73 common/modules/Contact/lib/iHRIS_Contact.php] on line 73
*Signature: static public function lookupType($id,$form)
*Signature: static public function lookupType($id,$form)
*Parameters:
*Parameters:
Line 68: Line 66:
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
==Inherited Methods==
==Inherited Methods==
===componentizeQuery()===
This public method is inherited from [[Class: I2CE_List (Development)#componentizeQuery() | I2CE_List->componentizeQuery()]]
===createDataTree()===
This public method is inherited from [[Class: I2CE_List (Development)#createDataTree() | I2CE_List->createDataTree()]]
===flattenDataTree()===
This public method is inherited from [[Class: I2CE_List (Development)#flattenDataTree() | I2CE_List->flattenDataTree()]]
===getDisplayFields()===
This public method is inherited from [[Class: I2CE_List (Development)#getDisplayFields() | I2CE_List->getDisplayFields()]]
===getExtendedDisplay()===
This public method is inherited from [[Class: I2CE_List (Development)#getExtendedDisplay() | I2CE_List->getExtendedDisplay()]]
===getHTMLTemplate()===
This public method is inherited from [[Class: I2CE_List (Development)#getHTMLTemplate() | I2CE_List->getHTMLTemplate()]]
===getListType()===
This public method is inherited from [[Class: I2CE_List (Development)#getListType() | I2CE_List->getListType()]]
===getSortFields()===
This public method is inherited from [[Class: I2CE_List (Development)#getSortFields() | I2CE_List->getSortFields()]]
===listOptions()===
This public method is inherited from [[Class: I2CE_List (Development)#listOptions() | I2CE_List->listOptions()]]
===lookup()===
This public method is inherited from [[Class: I2CE_List (Development)#lookup() | I2CE_List->lookup()]]
===monsterMash()===
This public method is inherited from [[Class: I2CE_List (Development)#monsterMash() | I2CE_List->monsterMash()]]
===name()===
This public method is inherited from [[Class: I2CE_List (Development)#name() | I2CE_List->name()]]
===setDisplayData()===
This public method is inherited from [[Class: I2CE_List (Development)#setDisplayData() | I2CE_List->setDisplayData()]]
===walkupFieldPath()===
This public method is inherited from [[Class: I2CE_List (Development)#walkupFieldPath() | I2CE_List->walkupFieldPath()]]
===_flattenDataTree()===
This protected method is inherited from [[Class: I2CE_List (Development)#_flattenDataTree() | I2CE_List->_flattenDataTree()]]
===_monsterMash()===
This protected method is inherited from [[Class: I2CE_List (Development)#_monsterMash() | I2CE_List->_monsterMash()]]
===addCache()===
This protected method is inherited from [[Class: I2CE_List (Development)#addCache() | I2CE_List->addCache()]]
===getCache()===
This protected method is inherited from [[Class: I2CE_List (Development)#getCache() | I2CE_List->getCache()]]
===isCached()===
This protected method is inherited from [[Class: I2CE_List (Development)#isCached() | I2CE_List->isCached()]]
===showHiddenLimit()===
This protected method is inherited from [[Class: I2CE_List (Development)#showHiddenLimit() | I2CE_List->showHiddenLimit()]]
===__construct()===
===__construct()===
This public method is inherited from [[Class: I2CE_Form (Development)#__construct() | I2CE_Form->__construct()]]
This public method is inherited from [[Class: I2CE_Form (Development)#__construct() | I2CE_Form->__construct()]]
Line 134: Line 72:
This public method is inherited from [[Class: I2CE_Form (Development)#addChildForm() | I2CE_Form->addChildForm()]]
This public method is inherited from [[Class: I2CE_Form (Development)#addChildForm() | I2CE_Form->addChildForm()]]


===addField()===
===childFormAdded()===
This public method is inherited from [[Class: I2CE_Form (Development)#addField() | I2CE_Form->addField()]]
This public method is inherited from [[Class: I2CE_Form (Development)#childFormAdded() | I2CE_Form->childFormAdded()]]


===cleanup()===
===cleanup()===
This public method is inherited from [[Class: I2CE_Form (Development)#cleanup() | I2CE_Form->cleanup()]]
This public method is inherited from [[Class: I2CE_Form (Development)#cleanup() | I2CE_Form->cleanup()]]
===clearFields()===
This public method is inherited from [[Class: I2CE_Form (Development)#clearFields() | I2CE_Form->clearFields()]]
===current()===
This public method is inherited from [[Class: I2CE_Form (Development)#current() | I2CE_Form->current()]]


===displayField()===
===displayField()===
Line 154: Line 86:
===getAllowedParentForms()===
===getAllowedParentForms()===
This public method is inherited from [[Class: I2CE_Form (Development)#getAllowedParentForms() | I2CE_Form->getAllowedParentForms()]]
This public method is inherited from [[Class: I2CE_Form (Development)#getAllowedParentForms() | I2CE_Form->getAllowedParentForms()]]
===getAttribute()===
This public method is inherited from [[Class: I2CE_Form (Development)#getAttribute() | I2CE_Form->getAttribute()]]


===getChildForms()===
===getChildForms()===
Line 173: Line 102:
This public method is inherited from [[Class: I2CE_Form (Development)#getField() | I2CE_Form->getField()]]
This public method is inherited from [[Class: I2CE_Form (Development)#getField() | I2CE_Form->getField()]]


===getFieldNames()===
===getFormID()===
This public method is inherited from [[Class: I2CE_Form (Development)#getFieldNames() | I2CE_Form->getFieldNames()]]
This public method is inherited from [[Class: I2CE_Form (Development)#getFormID() | I2CE_Form->getFormID()]]
 
===getFormId()===
This public method is inherited from [[Class: I2CE_Form (Development)#getFormId() | I2CE_Form->getFormId()]]
 
===getHTMLName()===
This public method is inherited from [[Class: I2CE_Form (Development)#getHTMLName() | I2CE_Form->getHTMLName()]]


===getId()===
===getHistory()===
This public method is inherited from [[Class: I2CE_Form (Development)#getId() | I2CE_Form->getId()]]
This public method is inherited from [[Class: I2CE_Form (Development)#getHistory() | I2CE_Form->getHistory()]]


===getParent()===
===getParent()===
Line 194: Line 117:
This public method is inherited from [[Class: I2CE_Form (Development)#getParentID() | I2CE_Form->getParentID()]]
This public method is inherited from [[Class: I2CE_Form (Development)#getParentID() | I2CE_Form->getParentID()]]


===getQueryDisplay()===
===getPost()===
This public method is inherited from [[Class: I2CE_Form (Development)#getQueryDisplay() | I2CE_Form->getQueryDisplay()]]
This public method is inherited from [[Class: I2CE_Form (Development)#getPost() | I2CE_Form->getPost()]]
 
===getQueryFields()===
This public method is inherited from [[Class: I2CE_Form (Development)#getQueryFields() | I2CE_Form->getQueryFields()]]
 
===getQueryString()===
This public method is inherited from [[Class: I2CE_Form (Development)#getQueryString() | I2CE_Form->getQueryString()]]
 
===hasAttribute()===
This public method is inherited from [[Class: I2CE_Form (Development)#hasAttribute() | I2CE_Form->hasAttribute()]]
 
===hasInvalid()===
This public method is inherited from [[Class: I2CE_Form (Development)#hasInvalid() | I2CE_Form->hasInvalid()]]
 
===key()===
This public method is inherited from [[Class: I2CE_Form (Development)#key() | I2CE_Form->key()]]


===listFields()===
===listFields()===
This public method is inherited from [[Class: I2CE_Form (Development)#listFields() | I2CE_Form->listFields()]]
This public method is inherited from [[Class: I2CE_Form (Development)#listFields() | I2CE_Form->listFields()]]


===load()===
===parentIsSet()===
This public method is inherited from [[Class: I2CE_Form (Development)#load() | I2CE_Form->load()]]
This public method is inherited from [[Class: I2CE_Form (Development)#parentIsSet() | I2CE_Form->parentIsSet()]]
 
===next()===
This public method is inherited from [[Class: I2CE_Form (Development)#next() | I2CE_Form->next()]]


===processDOM()===
===processDOM()===
This public method is inherited from [[Class: I2CE_Form (Development)#processDOM() | I2CE_Form->processDOM()]]
This public method is inherited from [[Class: I2CE_Form (Development)#processDOM() | I2CE_Form->processDOM()]]
===removeField()===
This public method is inherited from [[Class: I2CE_Form (Development)#removeField() | I2CE_Form->removeField()]]


===reset()===
===reset()===
This public method is inherited from [[Class: I2CE_Form (Development)#reset() | I2CE_Form->reset()]]
This public method is inherited from [[Class: I2CE_Form (Development)#reset() | I2CE_Form->reset()]]
===rewind()===
This public method is inherited from [[Class: I2CE_Form (Development)#rewind() | I2CE_Form->rewind()]]


===search()===
===search()===
This public method is inherited from [[Class: I2CE_Form (Development)#search() | I2CE_Form->search()]]
This public method is inherited from [[Class: I2CE_Form (Development)#search() | I2CE_Form->search()]]


===setAttribute()===
===setCreated()===
This public method is inherited from [[Class: I2CE_Form (Development)#setAttribute() | I2CE_Form->setAttribute()]]
This public method is inherited from [[Class: I2CE_Form (Development)#setCreated() | I2CE_Form->setCreated()]]


===setDisplayName()===
===setDisplayName()===
Line 248: Line 147:
This public method is inherited from [[Class: I2CE_Form (Development)#setFromPost() | I2CE_Form->setFromPost()]]
This public method is inherited from [[Class: I2CE_Form (Development)#setFromPost() | I2CE_Form->setFromPost()]]


===setId()===
===setLastModified()===
This public method is inherited from [[Class: I2CE_Form (Development)#setId() | I2CE_Form->setId()]]
This public method is inherited from [[Class: I2CE_Form (Development)#setLastModified() | I2CE_Form->setLastModified()]]


===setParent()===
===setParent()===
This public method is inherited from [[Class: I2CE_Form (Development)#setParent() | I2CE_Form->setParent()]]
This public method is inherited from [[Class: I2CE_Form (Development)#setParent() | I2CE_Form->setParent()]]


===valid()===
===isValidFieldName()===
This public method is inherited from [[Class: I2CE_Form (Development)#valid() | I2CE_Form->valid()]]
This protected method is inherited from [[Class: I2CE_Form (Development)#isValidFieldName() | I2CE_Form->isValidFieldName()]]
 
===lookupArray()===
This protected method is inherited from [[Class: I2CE_Form (Development)#lookupArray() | I2CE_Form->lookupArray()]]
 
===preProcessFieldArgs()===
This protected method is inherited from [[Class: I2CE_Form (Development)#preProcessFieldArgs() | I2CE_Form->preProcessFieldArgs()]]
 
===setupCreatedField()===
This protected method is inherited from [[Class: I2CE_Form (Development)#setupCreatedField() | I2CE_Form->setupCreatedField()]]
 
===setupLastModifiedField()===
This protected method is inherited from [[Class: I2CE_Form (Development)#setupLastModifiedField() | I2CE_Form->setupLastModifiedField()]]


===validate()===
===setupParentField()===
This public method is inherited from [[Class: I2CE_Form (Development)#validate() | I2CE_Form->validate()]]
This protected method is inherited from [[Class: I2CE_Form (Development)#setupParentField() | I2CE_Form->setupParentField()]]


===__get()===
===__get()===
This protected method is inherited from [[Class: I2CE_Form (Development)#__get() | I2CE_Form->__get()]]
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#__get() | I2CE_FieldContainer->__get()]]


===__isset()===
===__isset()===
This protected method is inherited from [[Class: I2CE_Form (Development)#__isset() | I2CE_Form->__isset()]]
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#__isset() | I2CE_FieldContainer->__isset()]]


===__set()===
===__set()===
This protected method is inherited from [[Class: I2CE_Form (Development)#__set() | I2CE_Form->__set()]]
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#__set() | I2CE_FieldContainer->__set()]]


===__unset()===
===__unset()===
This protected method is inherited from [[Class: I2CE_Form (Development)#__unset() | I2CE_Form->__unset()]]
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#__unset() | I2CE_FieldContainer->__unset()]]
 
===addField()===
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#addField() | I2CE_FieldContainer->addField()]]
 
===clearFields()===
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#clearFields() | I2CE_FieldContainer->clearFields()]]
 
===current()===
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#current() | I2CE_FieldContainer->current()]]


===addFormFields()===
===getAttribute()===
This protected method is inherited from [[Class: I2CE_Form (Development)#addFormFields() | I2CE_Form->addFormFields()]]
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#getAttribute() | I2CE_FieldContainer->getAttribute()]]


===getFormFieldsData()===
===getContainerIndex()===
This protected method is inherited from [[Class: I2CE_Form (Development)#getFormFieldsData() | I2CE_Form->getFormFieldsData()]]
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#getContainerIndex() | I2CE_FieldContainer->getContainerIndex()]]


===lookupArray()===
===getContainerType()===
This protected method is inherited from [[Class: I2CE_Form (Development)#lookupArray() | I2CE_Form->lookupArray()]]
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#getContainerType() | I2CE_FieldContainer->getContainerType()]]
 
===getFieldNames()===
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#getFieldNames() | I2CE_FieldContainer->getFieldNames()]]
 
===getHTMLName()===
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#getHTMLName() | I2CE_FieldContainer->getHTMLName()]]
 
===getId()===
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#getId() | I2CE_FieldContainer->getId()]]
 
===getLoad()===
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#getLoad() | I2CE_FieldContainer->getLoad()]]
 
===getMeta()===
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#getMeta() | I2CE_FieldContainer->getMeta()]]
 
===getName()===
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#getName() | I2CE_FieldContainer->getName()]]
 
===getNameId()===
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#getNameId() | I2CE_FieldContainer->getNameId()]]
 
===getQueryDisplay()===
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#getQueryDisplay() | I2CE_FieldContainer->getQueryDisplay()]]
 
===getQueryFields()===
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#getQueryFields() | I2CE_FieldContainer->getQueryFields()]]
 
===getQueryString()===
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#getQueryString() | I2CE_FieldContainer->getQueryString()]]
 
===hasAttribute()===
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#hasAttribute() | I2CE_FieldContainer->hasAttribute()]]
 
===hasField()===
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#hasField() | I2CE_FieldContainer->hasField()]]
 
===hasInvalid()===
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#hasInvalid() | I2CE_FieldContainer->hasInvalid()]]
 
===hasMeta()===
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#hasMeta() | I2CE_FieldContainer->hasMeta()]]
 
===isValid()===
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#isValid() | I2CE_FieldContainer->isValid()]]
 
===key()===
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#key() | I2CE_FieldContainer->key()]]
 
===load()===
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#load() | I2CE_FieldContainer->load()]]
 
===next()===
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#next() | I2CE_FieldContainer->next()]]
 
===removeField()===
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#removeField() | I2CE_FieldContainer->removeField()]]
 
===rewind()===
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#rewind() | I2CE_FieldContainer->rewind()]]
 
===setAttribute()===
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#setAttribute() | I2CE_FieldContainer->setAttribute()]]
 
===setId()===
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#setId() | I2CE_FieldContainer->setId()]]
 
===setInvalidMessage()===
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#setInvalidMessage() | I2CE_FieldContainer->setInvalidMessage()]]
 
===setMeta()===
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#setMeta() | I2CE_FieldContainer->setMeta()]]
 
===setName()===
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#setName() | I2CE_FieldContainer->setName()]]
 
===valid()===
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#valid() | I2CE_FieldContainer->valid()]]
 
===validate()===
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#validate() | I2CE_FieldContainer->validate()]]
 
===addFields()===
This protected method is inherited from [[Class: I2CE_FieldContainer (Development)#addFields() | I2CE_FieldContainer->addFields()]]
 
===getAttributes()===
This protected method is inherited from [[Class: I2CE_FieldContainer (Development)#getAttributes() | I2CE_FieldContainer->getAttributes()]]


===_hasMethod()===
===_hasMethod()===
This public method is inherited from [[Class: I2CE_Fuzzy (Development)#_hasMethod() | I2CE_Fuzzy->_hasMethod()]]
This public method is inherited from [[Class: I2CE_Fuzzy (Development)#_hasMethod() | I2CE_Fuzzy->_hasMethod()]]
==Inherited Variables==
==Inherited Variables==
===$cache===
Theis protected variable is inherited from [[Class: I2CE_List (Development)#$cache | I2CE_List->$cache]]
===$children===
===$children===
Theis public variable is inherited from [[Class: I2CE_Form (Development)#$children | I2CE_Form->$children]]
Theis public variable is inherited from [[Class: I2CE_Form (Development)#$children | I2CE_Form->$children]]
===$parent_forms===
Theis protected variable is inherited from [[Class: I2CE_Form (Development)#$parent_forms | I2CE_Form->$parent_forms]]
===$parentField===
Theis protected variable is inherited from [[Class: I2CE_Form (Development)#$parentField | I2CE_Form->$parentField]]
===$lastModifiedField===
Theis protected variable is inherited from [[Class: I2CE_Form (Development)#$lastModifiedField | I2CE_Form->$lastModifiedField]]
===$createdField===
Theis protected variable is inherited from [[Class: I2CE_Form (Development)#$createdField | I2CE_Form->$createdField]]
===$name===
Theis protected variable is inherited from [[Class: I2CE_FieldContainer (Development)#$name | I2CE_FieldContainer->$name]]
===$display_name===
Theis protected variable is inherited from [[Class: I2CE_FieldContainer (Development)#$display_name | I2CE_FieldContainer->$display_name]]


===$fields===
===$fields===
Theis protected variable is inherited from [[Class: I2CE_Form (Development)#$fields | I2CE_Form->$fields]]
Theis protected variable is inherited from [[Class: I2CE_FieldContainer (Development)#$fields | I2CE_FieldContainer->$fields]]


===$parent===
===$attributes===
Theis protected variable is inherited from [[Class: I2CE_Form (Development)#$parent | I2CE_Form->$parent]]
Theis protected variable is inherited from [[Class: I2CE_FieldContainer (Development)#$attributes | I2CE_FieldContainer->$attributes]]


===$id===
===$id===
Theis protected variable is inherited from [[Class: I2CE_Form (Development)#$id | I2CE_Form->$id]]
Theis protected variable is inherited from [[Class: I2CE_FieldContainer (Development)#$id | I2CE_FieldContainer->$id]]
 
===$attributes===
Theis protected variable is inherited from [[Class: I2CE_Form (Development)#$attributes | I2CE_Form->$attributes]]


===$parent_forms===
===$factory===
Theis protected variable is inherited from [[Class: I2CE_Form (Development)#$parent_forms | I2CE_Form->$parent_forms]]
Theis protected variable is inherited from [[Class: I2CE_FieldContainer (Development)#$factory | I2CE_FieldContainer->$factory]]
==Inherited Fuzzy Methods==
==Inherited Fuzzy Methods==
===isNumeric()===
===isNumeric()===
Line 328: Line 347:
===generateWhereClause()===
===generateWhereClause()===
This method is inherited from [[Class: I2CE_Form (Development)#generateWhereClause() | I2CE_Form->generateWhereClause()]]
This method is inherited from [[Class: I2CE_Form (Development)#generateWhereClause() | I2CE_Form->generateWhereClause()]]
===processLimit()===
This method is inherited from [[Class: I2CE_Form (Development)#processLimit() | I2CE_Form->processLimit()]]
===getDisplayedExistingLimit()===
This method is inherited from [[Class: I2CE_Form (Development)#getDisplayedExistingLimit() | I2CE_Form->getDisplayedExistingLimit()]]


===isComponentized()===
===isComponentized()===
Line 352: Line 365:
===populate()===
===populate()===
This method is inherited from [[Class: I2CE_Form (Development)#populate() | I2CE_Form->populate()]]
This method is inherited from [[Class: I2CE_Form (Development)#populate() | I2CE_Form->populate()]]
===duplicate()===
This method is inherited from [[Class: I2CE_Form (Development)#duplicate() | I2CE_Form->duplicate()]]
===storeHistory()===
This method is inherited from [[Class: I2CE_Form (Development)#storeHistory() | I2CE_Form->storeHistory()]]


===populateChild()===
===populateChild()===
Line 376: Line 395:
===setChangeType()===
===setChangeType()===
This method is inherited from [[Class: I2CE_Form (Development)#setChangeType() | I2CE_Form->setChangeType()]]
This method is inherited from [[Class: I2CE_Form (Development)#setChangeType() | I2CE_Form->setChangeType()]]
===changeID()===
This method is inherited from [[Class: I2CE_Form (Development)#changeID() | I2CE_Form->changeID()]]


===userMessage()===
===userMessage()===

Latest revision as of 08:21, 6 May 2015


This article describes the class iHRIS_Contact .

@copyright Copyright © 2007, 2008 IntraHealth International, Inc. Object for dealing with contacts.

Form Fields

This class is a form class and provides the following form fields

address

The form field address is implemented by STRING_MLINE

telephone

The form field telephone is implemented by STRING_LINE

mobile_phone

The form field mobile_phone is implemented by STRING_LINE

alt_telephone

The form field alt_telephone is implemented by STRING_LINE

fax

The form field fax is implemented by STRING_LINE

email

The form field email is implemented by STRING_LINE

notes

The form field notes is implemented by STRING_MLINE

Constants

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.

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.

lookupType()

Lookup the given value from the status array.

Inherited Methods

__construct()

This public method is inherited from I2CE_Form->__construct()

addChildForm()

This public method is inherited from I2CE_Form->addChildForm()

childFormAdded()

This public method is inherited from I2CE_Form->childFormAdded()

cleanup()

This public method is inherited from I2CE_Form->cleanup()

displayField()

This public method is inherited from I2CE_Form->displayField()

form()

This public method is inherited from I2CE_Form->form()

getAllowedParentForms()

This public method is inherited from I2CE_Form->getAllowedParentForms()

getChildForms()

This public method is inherited from I2CE_Form->getChildForms()

getChildFormsByForm()

This public method is inherited from I2CE_Form->getChildFormsByForm()

getChildren()

This public method is inherited from I2CE_Form->getChildren()

getDisplayName()

This public method is inherited from I2CE_Form->getDisplayName()

getField()

This public method is inherited from I2CE_Form->getField()

getFormID()

This public method is inherited from I2CE_Form->getFormID()

getHistory()

This public method is inherited from I2CE_Form->getHistory()

getParent()

This public method is inherited from I2CE_Form->getParent()

getParentForm()

This public method is inherited from I2CE_Form->getParentForm()

getParentID()

This public method is inherited from I2CE_Form->getParentID()

getPost()

This public method is inherited from I2CE_Form->getPost()

listFields()

This public method is inherited from I2CE_Form->listFields()

parentIsSet()

This public method is inherited from I2CE_Form->parentIsSet()

processDOM()

This public method is inherited from I2CE_Form->processDOM()

reset()

This public method is inherited from I2CE_Form->reset()

search()

This public method is inherited from I2CE_Form->search()

setCreated()

This public method is inherited from I2CE_Form->setCreated()

setDisplayName()

This public method is inherited from I2CE_Form->setDisplayName()

setForm()

This public method is inherited from I2CE_Form->setForm()

setFromPost()

This public method is inherited from I2CE_Form->setFromPost()

setLastModified()

This public method is inherited from I2CE_Form->setLastModified()

setParent()

This public method is inherited from I2CE_Form->setParent()

isValidFieldName()

This protected method is inherited from I2CE_Form->isValidFieldName()

lookupArray()

This protected method is inherited from I2CE_Form->lookupArray()

preProcessFieldArgs()

This protected method is inherited from I2CE_Form->preProcessFieldArgs()

setupCreatedField()

This protected method is inherited from I2CE_Form->setupCreatedField()

setupLastModifiedField()

This protected method is inherited from I2CE_Form->setupLastModifiedField()

setupParentField()

This protected method is inherited from I2CE_Form->setupParentField()

__get()

This public method is inherited from I2CE_FieldContainer->__get()

__isset()

This public method is inherited from I2CE_FieldContainer->__isset()

__set()

This public method is inherited from I2CE_FieldContainer->__set()

__unset()

This public method is inherited from I2CE_FieldContainer->__unset()

addField()

This public method is inherited from I2CE_FieldContainer->addField()

clearFields()

This public method is inherited from I2CE_FieldContainer->clearFields()

current()

This public method is inherited from I2CE_FieldContainer->current()

getAttribute()

This public method is inherited from I2CE_FieldContainer->getAttribute()

getContainerIndex()

This public method is inherited from I2CE_FieldContainer->getContainerIndex()

getContainerType()

This public method is inherited from I2CE_FieldContainer->getContainerType()

getFieldNames()

This public method is inherited from I2CE_FieldContainer->getFieldNames()

getHTMLName()

This public method is inherited from I2CE_FieldContainer->getHTMLName()

getId()

This public method is inherited from I2CE_FieldContainer->getId()

getLoad()

This public method is inherited from I2CE_FieldContainer->getLoad()

getMeta()

This public method is inherited from I2CE_FieldContainer->getMeta()

getName()

This public method is inherited from I2CE_FieldContainer->getName()

getNameId()

This public method is inherited from I2CE_FieldContainer->getNameId()

getQueryDisplay()

This public method is inherited from I2CE_FieldContainer->getQueryDisplay()

getQueryFields()

This public method is inherited from I2CE_FieldContainer->getQueryFields()

getQueryString()

This public method is inherited from I2CE_FieldContainer->getQueryString()

hasAttribute()

This public method is inherited from I2CE_FieldContainer->hasAttribute()

hasField()

This public method is inherited from I2CE_FieldContainer->hasField()

hasInvalid()

This public method is inherited from I2CE_FieldContainer->hasInvalid()

hasMeta()

This public method is inherited from I2CE_FieldContainer->hasMeta()

isValid()

This public method is inherited from I2CE_FieldContainer->isValid()

key()

This public method is inherited from I2CE_FieldContainer->key()

load()

This public method is inherited from I2CE_FieldContainer->load()

next()

This public method is inherited from I2CE_FieldContainer->next()

removeField()

This public method is inherited from I2CE_FieldContainer->removeField()

rewind()

This public method is inherited from I2CE_FieldContainer->rewind()

setAttribute()

This public method is inherited from I2CE_FieldContainer->setAttribute()

setId()

This public method is inherited from I2CE_FieldContainer->setId()

setInvalidMessage()

This public method is inherited from I2CE_FieldContainer->setInvalidMessage()

setMeta()

This public method is inherited from I2CE_FieldContainer->setMeta()

setName()

This public method is inherited from I2CE_FieldContainer->setName()

valid()

This public method is inherited from I2CE_FieldContainer->valid()

validate()

This public method is inherited from I2CE_FieldContainer->validate()

addFields()

This protected method is inherited from I2CE_FieldContainer->addFields()

getAttributes()

This protected method is inherited from I2CE_FieldContainer->getAttributes()

_hasMethod()

This public method is inherited from I2CE_Fuzzy->_hasMethod()

Inherited Variables

$children

Theis public variable is inherited from I2CE_Form->$children

$parent_forms

Theis protected variable is inherited from I2CE_Form->$parent_forms

$parentField

Theis protected variable is inherited from I2CE_Form->$parentField

$lastModifiedField

Theis protected variable is inherited from I2CE_Form->$lastModifiedField

$createdField

Theis protected variable is inherited from I2CE_Form->$createdField

$name

Theis protected variable is inherited from I2CE_FieldContainer->$name

$display_name

Theis protected variable is inherited from I2CE_FieldContainer->$display_name

$fields

Theis protected variable is inherited from I2CE_FieldContainer->$fields

$attributes

Theis protected variable is inherited from I2CE_FieldContainer->$attributes

$id

Theis protected variable is inherited from I2CE_FieldContainer->$id

$factory

Theis protected variable is inherited from I2CE_FieldContainer->$factory

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()

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()

duplicate()

This method is inherited from I2CE_Form->duplicate()

storeHistory()

This method is inherited from I2CE_Form->storeHistory()

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()

changeID()

This method is inherited from I2CE_Form->changeID()

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()