Class: I2CE List (Development)

For other versions, see Class: I2CE_List (versions) .

This article describes the abstract class I2CE_List .

• Extends the class: I2CE_Form.
• Child Classes:
  • I2CE_SimpleList
    • I2CE_SimpleCodedList
      • iHRIS_DHIS_CodedList
    • iHRIS_PersonID_Type
  • iHRIS_UserMap
  • I2CE_User_Form
    • I2CE_User_Request
  • iHRIS_Position
    • iHRIS_MultiPosition
  • iHRIS_Cadre
  • iHRIS_Scheduled_Training_Course
  • iHRIS_Training_Course
  • iHRIS_ContinuingEducationCourse
  • iHRIS_Currency
  • iHRIS_DataElement
  • iHRIS_DataSet
  • iHRIS_ListByCountry
    • iHRIS_Facility
      • iHRIS_HealthFacility
    • iHRIS_QualifyTrainingInstitution
  • iHRIS_Country
  • iHRIS_County
  • iHRIS_District
  • iHRIS_Region
  • I2CE_Form_Locale
  • iHRIS_Degree
  • I2CE_ArchivedReport
  • I2CE_Role
  • iHRIS_EstablishmentPeriod
  • iHRIS_Establishment
  • iHRIS_Classification
  • iHRIS_SalaryGrade
  • iHRIS_Job
    • iHRIS_ManageJob
  • iHRIS_Department
  • iHRIS_ConfirmationType
  • iHRIS_Certificate
  • iHRIS_DisciplinaryActionReason
  • iHRIS_TrainingDisruptionReason
  • iHRIS_TrainingProgram
  • iHRIS_ISCO_08_Major
  • iHRIS_ISCO_08_Sub_Major
  • iHRIS_ISCO_08_Minor
  • iHRIS_ISCO_08_Unit
  • iHRIS_ISCO_88_Major
  • iHRIS_ISCO_88_Sub_Major
  • iHRIS_ISCO_88_Minor
  • iHRIS_ISCO_88_Unit
  • iHRIS_Competency
  • iHRIS_Training_Course_Evaluation
• Location: Part of the module Lists in the package I2CE 4.1-dev
• Source: Defined in the file modules/Forms/modules/Lists/lib/I2CE_List.php on line 38
• Author: Luke Duncan <lduncan@intrahealth.org>
• Since: v1.0.0

Base object for dealing with lists of data. This is an abstract object with base code for many of the I2CE_Form interface methods. It is used for many of the list database objects such as AcademicLevel and District . It assumes all lists have a code field and by default a description field but this can be overwritten by certain objects like Cadre . @abstract

Form Fields

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

remap

The form field remap is implemented by REMAP

i2ce_hidden

The form field i2ce_hidden is implemented by YESNO

Variables

$mapped_fields_by_form

of array index by names of lists of arrays where keys are form names, values are arrays with keys field names and values field objects

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_List.php on line 59
• Type: static protected array $mapped_fields_by_form

$cache

An array to cache lookup entries Any lookups done to the database will be cached in this static array so additional lookups using the same id won't have to access the database. @static

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_List.php on line 118
• Type: static protected array $cache

Methods

_findLowerMatches()

Internal method to find all the ids for forms that are below the given matched form id. This will go through the list of fields until the form that is being matched is found. @param string $match The form id to match at the top.

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_List.php on line 578
• Signature: static protected function _findLowerMatches($match_form,$match_ids,$fields,$forms,$displayed,$show_hidden)
• Parameters:
  • $match_form
  • $match_ids
  • array $fields
    The getDisplayedFields() for the field object.
  • array $forms
    The getSelectableForms() for the field object.
  • array $displayed
    A list of forms that should be included in the results.
  • int $show_hidden
    0=non-hidden, 1=All, 2=hidden only. Defaults to 0
    • Default Value: 0
• Returns: array

_getDisplayFields()

Worker function to get the display fields

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_List.php on line 217
• Signature: protected function _getDisplayFields($style)
• Parameters:
  • string $style
    Defaults to 'default'
    • Default Value: 'default'
• Returns: array
  of string

_getDisplayString()

worker method to get the display string

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_List.php on line 226
• Signature: protected function _getDisplayString($style)
• Parameters:
  • string $style
    Defaults to 'default'
    • Default Value: 'default'
• Returns: string

_getSortFields()

Worker function to get the display fields

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_List.php on line 323
• Signature: protected function _getSortFields($style)
• Parameters:
  • string $style
    Defaults to 'default'
    • Default Value: 'default'
• Returns: array
  of string

_searchLowerMatches()

Internal method to search all the ids for forms that are below the given matched form id. @param string $match The form id to match at the top.

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_List.php on line 605
• Signature: static protected function _searchLowerMatches($match_form,$match_ids,$fields,$forms,$displayed,$show_hidden)
• Parameters:
  • $match_form
  • $match_ids
  • array $fields
    The getDisplayedFields() for the field object.
  • array $forms
    The getSelectableFroms() for the field object.
  • array $displayed
    A list of forms that should be included in the results.
  • int $show_hidden
    0=non-hidden, 1=All, 2=hidden only.
• Returns: array

addCache()

Adds the id number to the cache . @param integer $code The code of the entry to add.

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_List.php on line 518
• Signature: static final protected function addCache($table_name,$id,$value)
• Parameters:
  • string $table_name
    The name of the table in the database.
  • $id
  • string $value
    The value to add to the cache

buildDataTree()

Create a data tree of the selectable forms. Deisgned to be fed into tree select

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_List.php on line 557
• Signature: static public function buildDataTree($fields,$forms,$limits,$orders,$show_hidden)
• Parameters:
  • array $fields
    an ordered array E.g array('village+county','county','district,'region+country','country'). it is an "bottom up" array of string where strings are of the form "$form" or "$form+$link_field". In the case of the former type, then $link_field is assumed to be the next form. So for example, "county" has link field "district". If a "$form(+$link_field)" is surrounded by brackets [ ] , it is not displayed.
  • array $forms
    An unorderd array of form names whose values we allow to be selected
  • array $limits
    An array with keys form names and value limit data
  • array $orders
    An array with keys form names and values array of field orders for that form. If the form name has no orders, we use default ordering for that form based on its displayed firelds
    • Default Value: array()
  • int $show_hidden
    0=non-hidden, 1=All, 2=hidden only. Defaults to 0
    • Default Value: 0
• Returns: array

componentizeQuery()

returns the posible componentization of a form|id

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_List.php on line 129
• Signature: static public function componentizeQuery($qry,$forms,$component)
• Parameters:
  • string $qry
    the query need to get the form|id
  • array $forms
    an array of string which are componentized @parm string $component The component we possibly wish to componentize at.
  • $component
• Returns: string.
  They query need to turn $qry into one componentized to $component.

findLowerMatches()

For the list of displayed fields for a field, find all the ids for forms that are below the given matched form id. For example if a location has the displayed fields of: array( 'county', 'district', '[region]', 'country' ) with selectable fields: array( 'county', 'district' ) if you want to match the district: district|10 this method will return all the county ids that are in district|10. This will also return 'district|10' in the list to have a complete list of valid selectable forms.

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_List.php on line 655
• Signature: static public function findLowerMatches($match,$fields,$forms,$show_hidden)
• Parameters:
  • string $match
    The form id to match at the top.
  • array $fields
    The getDisplayedFields() for the field object.
  • array $forms
    The getSelectableFroms() for the field object.
  • int $show_hidden
    0=non-hidden, 1=All, 2=hidden only. Defaults to 0
    • Default Value: 0
• Returns: array

flattenDataTree()

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_List.php on line 561
• Signature: static public function flattenDataTree($data)
• Parameters:
  • $data

getCache()

Return the cache cached entry for the id number. @param integer $code The code of the entry to lookup.

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_List.php on line 531
• Signature: static final protected function getCache($table_name,$id)
• Parameters:
  • string $table_name
    The name of the table in the database.
  • $id
• Returns: string
  The value of the cached code.

getDisplayFieldStyles()

Returns a list of fields used for displaying this list.

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_List.php on line 282
• Signature: static public function getDisplayFieldStyles($form_name,$style)
• Parameters:
  • string $form_name
  • string $style
    Defaults to 'default'
    • Default Value: 'default'
• Returns: array

getDisplayFields()

Returns a list of fields used for displaying this list.

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_List.php on line 260
• Signature: static public function getDisplayFields($form_name,$style)
• Parameters:
  • string $form_name
  • string $style
    Defaults to 'default'
    • Default Value: 'default'
• Returns: array

getDisplayString()

Returns display string used for displaying this list.

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_List.php on line 238
• Signature: static public function getDisplayString($form_name,$style)
• Parameters:
  • string $form_name
  • string $style
    Defaults to 'default'
    • Default Value: 'default'
• Returns: string

getFieldsMappingToList()

Get all fields mapping to the given list type

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_List.php on line 65
• Signature: static public function getFieldsMappingToList($list)
• Parameters:
  • mixed $list
    Either a string a list name or isntance of {I2CE_List}
• Returns: array
  keys are form names, values are arrays with keys field names and values field objects

getHTMLTemplate()

Return the HTML file name for the form template for this form.

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_List.php on line 148
• Signature: public function getHTMLTemplate($type)
• Parameters:
  • $type
    • Default Value: 'default'
• Returns: string

getListType()

Return the list edit type for this list. The possible return values are "list," "dual," or "select." Select will display a drop down of all choices and list and dual will list them all in a table. Dual includes the linked list object for the object.

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_List.php on line 176
• Signature: public function getListType()
• Returns: string

getSortFields()

Returns a list of fields used for sorting this list.

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_List.php on line 303
• Signature: static public function getSortFields($form_name,$style)
• Parameters:
  • string $form_name
  • string $style
    Defaults to 'default'
    • Default Value: 'default'
• Returns: array

getViewTemplate()

Return the HTML file name for the view template for this form.

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_List.php on line 160
• Signature: public function getViewTemplate($type)
• Parameters:
  • $type
    • Default Value: 'default'
• Returns: string

isCached()

Checks to see if the id number is cached. Checks the cache to see if code has been cached or not. @param integer $code The code of the entry to lookup.

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_List.php on line 504
• Signature: static final protected function isCached($table_name,$id)
• Parameters:
  • string $table_name
    The name of the table in the database.
  • $id
• Returns: boolean

isList()

Check to see if a class or class name is a list

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_List.php on line 45
• Signature: static public function isList($class)
• Parameters:
  • mixed $class
    an object or a string
• Returns: boolean

listOptions()

Return the list of options for this list as an array. @param string $opt_field An optional field to further limit the list of choices @param integer $opt_value If the $opt_field is used then this is the value to limit it by. @param array $sub_fields of string. If $op_value is is set, it is an array of linked ($form+)$field's to include results under the optional value. e.g. if $opt_value was 'country|10' and $sub_fields was array(county+district,district+region,[region],country) we would display all counties and district who are under country|10. In this case we display the extended version of the option

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_List.php on line 345
• Signature: static public function listOptions($form_name,$show_hidden,$select_fields)
• Parameters:
  • string $form_name
    The form being listed. This needs to be a subclass of I2CE_List
  • int $show_hidden
    0=non-hidden, 1=All, 2=hidden only. Defaults to 0 @param $select_fields An array of field objects of the form type that that are in this form that we want to limit values by. Defaults to empty array
    • Default Value: 0
  • $select_fields
    • Default Value: array()
• Returns: array

lookup()

Looks up the description of the item based on the code. This is the default method that most implementations of lookup () use. It finds the description of the object based on the code and saves it in the cache and returns it.

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_List.php on line 476
• Signature: static public function lookup($id,$form_name)
• Parameters:
  • integer $id
    The code of the entry to lookup.
  • string $form_name
    The name of the form in the database.
• Returns: string

name()

Return the display name for this list object. This will return the same value as lookup() but from the current object instead of from the database.

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_List.php on line 197
• Signature: public function name($style)
• Parameters:
  • string $style
    Defaults to 'default'
    • Default Value: 'default'
• Returns: string

setDisplayData()

Sets the field values to be displayed in the HTML template.

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_List.php on line 182
• Signature: public function setDisplayData($template)
• Parameters:
  • I2CE_Template &$template

showHiddenLimit()

Modifies a where clause to limit to hidden fields as neccesary @param int $show_hideden. 0=non-hidden, 1=All, 2=hidden only

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_List.php on line 395
• Signature: static public function showHiddenLimit($where,$show_hidden)
• Parameters:
  • array $where
  • $show_hidden
• Returns: array()

walkupFieldPath()

Walk up a form/linked field path until. Return the id of the top form. $param mixed. Either an array of string or a colon-sepearted string. (imploded) values is a string of the form: form1(+field1):...:formM(+fieldM):..:fieldN there needs to be at least one colon/array needs to be at least two in length

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_List.php on line 408
• Signature: static public function walkupFieldPath($field_path,$formid)
• Parameters:
  • $field_path
  • string $formid
    string of the form "$form|$id". the starting value. $form should be one of formX above (e.g. the dbvalue of a map field)
• Returns: mixed.
  False on failure, string of the form "$form|$id" on success

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