Class: iHRIS Contact: Difference between revisions

From IHRIS Wiki
(Created page with 'This article desrcibes the class '''iHRIS_Contact'''which extends the class I2CE_List It is contained in the module Contact i…')
 
No edit summary
Line 55: Line 55:
**Default Value: ""  
**Default Value: ""  
==Inherited Variables==
==Inherited Variables==
===$$cache===
===$cache===
Theis protected variable is inherited from [[Class: I2CE_List#$$cache | I2CE_List->$$cache]]
Theis protected variable is inherited from [[Class: I2CE_List#$cache | I2CE_List->$cache]]
===$$children===
===$children===
Theis public variable is inherited from [[Class: I2CE_Form#$$children | I2CE_Form->$$children]]
Theis public variable is inherited from [[Class: I2CE_Form#$children | I2CE_Form->$children]]
===$$fields===
===$fields===
Theis protected variable is inherited from [[Class: I2CE_Form#$$fields | I2CE_Form->$$fields]]
Theis protected variable is inherited from [[Class: I2CE_Form#$fields | I2CE_Form->$fields]]
===$$parent===
===$parent===
Theis protected variable is inherited from [[Class: I2CE_Form#$$parent | I2CE_Form->$$parent]]
Theis protected variable is inherited from [[Class: I2CE_Form#$parent | I2CE_Form->$parent]]
===$$id===
===$id===
Theis protected variable is inherited from [[Class: I2CE_Form#$$id | I2CE_Form->$$id]]
Theis protected variable is inherited from [[Class: I2CE_Form#$id | I2CE_Form->$id]]
===$$attributes===
===$attributes===
Theis protected variable is inherited from [[Class: I2CE_Form#$$attributes | I2CE_Form->$$attributes]]
Theis protected variable is inherited from [[Class: I2CE_Form#$attributes | I2CE_Form->$attributes]]
===$$parent_forms===
===$parent_forms===
Theis protected variable is inherited from [[Class: I2CE_Form#$$parent_forms | I2CE_Form->$$parent_forms]]
Theis protected variable is inherited from [[Class: I2CE_Form#$parent_forms | I2CE_Form->$parent_forms]]
==Inherited Fuzzy Methods==
==Inherited Fuzzy Methods==
===isNumeric()===
===isNumeric()===

Revision as of 16:14, 16 October 2009

This article desrcibes the class iHRIS_Contactwhich 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 @author Luke Duncan <lduncan@intrahealth.org> @copyright Copyright © 2007, 2008 IntraHealth International, Inc. @since v1.0.0 @version v2.0.0 Object for dealing with contacts.

@package iHRIS @subpackage Manage @access public

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