Class: iHRIS Contact: Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
Line 2: Line 2:
*Extends the class: [[Class: I2CE_List | I2CE_List]].
*Extends the class: [[Class: I2CE_List | I2CE_List]].
*Location: Part of the module [[iHRIS Common Module List#Contact|Contact]] in the package [https://launchpad.net/ihris-common iHRIS Common]
*Location: Part of the module [[iHRIS Common 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.1-release/annotate/head:/modules/Contact/lib/iHRIS_Contact.php modules/Contact/lib/iHRIS_Contact.php]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0.2-release/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 42: Line 42:
===$types===
===$types===
The list of contact types.
The list of contact types.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0.2-release/annotate/head:/modules/Contact/lib/iHRIS_Contact.php#L65 common/modules/Contact/lib/iHRIS_Contact.php] on line 65
*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 47: Line 48:
===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.2-release/annotate/head:/modules/Contact/lib/iHRIS_Contact.php#L88 common/modules/Contact/lib/iHRIS_Contact.php] on line 88
*Signature: static public function listTypeOptions($form)
*Signature: static public function listTypeOptions($form)
*Parameters:
*Parameters:
Line 53: Line 55:
===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.2-release/annotate/head:/modules/Contact/lib/iHRIS_Contact.php#L77 common/modules/Contact/lib/iHRIS_Contact.php] on line 77
*Signature: static public function lookupType($id,$form)
*Signature: static public function lookupType($id,$form)
*Parameters:
*Parameters:

Revision as of 10:19, 10 November 2009

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

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::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.

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

componentizeQuery()

This public method is inherited from I2CE_List->componentizeQuery()

createDataTree()

This public method is inherited from I2CE_List->createDataTree()

flattenDataTree()

This public method is inherited from I2CE_List->flattenDataTree()

getDisplayFields()

This public method is inherited from I2CE_List->getDisplayFields()

getExtendedDisplay()

This public method is inherited from I2CE_List->getExtendedDisplay()

getHTMLTemplate()

This public method is inherited from I2CE_List->getHTMLTemplate()

getListType()

This public method is inherited from I2CE_List->getListType()

getSortFields()

This public method is inherited from I2CE_List->getSortFields()

listOptions()

This public method is inherited from I2CE_List->listOptions()

lookup()

This public method is inherited from I2CE_List->lookup()

monsterMash()

This public method is inherited from I2CE_List->monsterMash()

name()

This public method is inherited from I2CE_List->name()

setDisplayData()

This public method is inherited from I2CE_List->setDisplayData()

walkupFieldPath()

This public method is inherited from I2CE_List->walkupFieldPath()

_flattenDataTree()

This protected method is inherited from I2CE_List->_flattenDataTree()

_monsterMash()

This protected method is inherited from I2CE_List->_monsterMash()

addCache()

This protected method is inherited from I2CE_List->addCache()

getCache()

This protected method is inherited from I2CE_List->getCache()

isCached()

This protected method is inherited from I2CE_List->isCached()

__construct()

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

addChildForm()

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

addField()

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

cleanup()

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

clearFields()

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

current()

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

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

getAttribute()

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

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

getFieldNames()

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

getFormId()

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

getHTMLName()

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

getId()

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

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

getQueryDisplay()

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

getQueryFields()

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

getQueryString()

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

hasAttribute()

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

hasInvalid()

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

key()

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

listFields()

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

load()

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

next()

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

processDOM()

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

removeField()

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

reset()

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

rewind()

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

search()

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

setAttribute()

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

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

setId()

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

setParent()

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

valid()

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

validate()

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

__get()

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

__isset()

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

__set()

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

__unset()

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

addFormFields()

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

getFormFieldsData()

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

lookupArray()

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

_hasMethod()

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

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