Class: I2CE List: Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
Line 1: Line 1:
This article desrcibes the1 class ''I2CE_List''.
__PAGE:Class: I2CE_List
This article desrcibes the [[Defining Forms#Dynamic Creation|dynamically]] created class ''I2CE_List''.
*Extends the class: [[Class: I2CE_Form | I2CE_Form]].
*Extends the class: [[Class: I2CE_Form | I2CE_Form]].
*Parent Classses:  [[Class: I2CE_Form | I2CE_Form]] [[Class: I2CE_Fuzzy | I2CE_Fuzzy]]
*Parent Classses:  [[Class: I2CE_Form | I2CE_Form]] [[Class: I2CE_Fuzzy | I2CE_Fuzzy]]
Line 14: Line 15:
** [[Class: iHRIS_Scheduled_Training_Course | iHRIS_Scheduled_Training_Course]]
** [[Class: iHRIS_Scheduled_Training_Course | iHRIS_Scheduled_Training_Course]]
** [[Class: iHRIS_Training_Course | iHRIS_Training_Course]]
** [[Class: iHRIS_Training_Course | iHRIS_Training_Course]]
*Location: Part of the module [[iHRIS Module List#Lists|Lists]] in the package [https://launchpad.net/i2ce I2CE]
** [[Class: iHRIS_ContinuingEducationCourse | iHRIS_ContinuingEducationCourse]]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.0-release/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_List.php modules/Forms/modules/Lists/lib/I2CE_List.php]
** [[Class: iHRIS_ListByCountry | iHRIS_ListByCountry]]
*Author: Luke Duncan <lduncan@intrahealth.org>
*** [[Class: iHRIS_Facility | iHRIS_Facility]]
*Since: v1.0.0
**** [[Class: iHRIS_HealthFacility | iHRIS_HealthFacility]]
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
*** [[Class: iHRIS_QualifyTrainingInstitution | iHRIS_QualifyTrainingInstitution]]
==Constants==
** [[Class: iHRIS_County | iHRIS_County]]
===I2CE_List::MAIN_FIELD===
** [[Class: iHRIS_District | iHRIS_District]]
The main field name used for display a description of a record.
** [[Class: iHRIS_Region | iHRIS_Region]]
Defined as: "name"
** [[Class: iHRIS_Degree | iHRIS_Degree]]
===I2CE_List::SEC_FIELD===
** [[Class: I2CE_Role | I2CE_Role]]
The secondary field name used for displaying a description of a record in combination with the MAIN_FIELD.
** [[Class: iHRIS_Classification | iHRIS_Classification]]
Defined as: null
** [[Class: iHRIS_SalaryGrade | iHRIS_SalaryGrade]]
===I2CE_List::SORT_FIELD===
** [[Class: iHRIS_Department | iHRIS_Department]]
The sort field name to be used for sorting the display list.  This can't be used with the SEC_FIELD option for display.
** [[Class: iHRIS_Certificate | iHRIS_Certificate]]
Defined as: null
** [[Class: iHRIS_DisciplinaryActionReason | iHRIS_DisciplinaryActionReason]]
==Variables==
** [[Class: iHRIS_TrainingDisruptionReason | iHRIS_TrainingDisruptionReason]]
===$cache===
** [[Class: iHRIS_ISCO_08_Major | iHRIS_ISCO_08_Major]]
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
** [[Class: iHRIS_ISCO_08_Sub_Major | iHRIS_ISCO_08_Sub_Major]]
*Type: static protected [http://www.php.net/manual/en/language.types.array.php array ] $cache
** [[Class: iHRIS_ISCO_88_Major | iHRIS_ISCO_88_Major]]
** [[Class: iHRIS_ISCO_88_Sub_Major | iHRIS_ISCO_88_Sub_Major]]
** [[Class: iHRIS_ISCO_88_Minor | iHRIS_ISCO_88_Minor]]
** [[Class: iHRIS_ISCO_88_Unit | iHRIS_ISCO_88_Unit]]
** [[Class: iHRIS_Training_Course_Evaluation | iHRIS_Training_Course_Evaluation]]
*Location: It is defined in configuration magic data of the module [[iHRIS Module List#Lists|Lists]] in the package [https://launchpad.net/i2ce I2CE]
==Inherited Methods==
===__construct()===
This public method is inherited from [[Class: I2CE_Form#__construct() | I2CE_Form->__construct()]]


==Methods==
===addChildForm()===
===_flattenDataTree()===
This public method is inherited from [[Class: I2CE_Form#addChildForm() | I2CE_Form->addChildForm()]]
*Signature: static protected function _flattenDataTree($data,$list)
 
*Parameters:
===addField()===
**$data
This public method is inherited from [[Class: I2CE_Form#addField() | I2CE_Form->addField()]]
**&$list
 
===_monsterMash()===
===cleanup()===
Gets the id's for a form that live at @param string $use_display value.  Defaults to true in which case the displayed fields are returned based on the display value.  If false, then the displa @param string $use_display value.  Defaults to true in which case the displayed fields are returned based on the display value.  If false, then the displa
This public method is inherited from [[Class: I2CE_Form#cleanup() | I2CE_Form->cleanup()]]
*Signature: static protected function _monsterMash($options,$form_name,$opt_field,$opt_form,$opt_id,$sub_fields,$sub_val,$display_fields,$use_display_value)
 
*Parameters:
===clearFields()===
** [http://www.php.net/manual/en/language.types.array.php array ] &$options <br/>Where the id's are saved.  Array with keys the ids of $form_name. For values, if $use_dislpay_value is true, then the displayed fields for $form_name that corresponds to that value.  If $use_display_fields is false, then we return an array of the display fields
This public method is inherited from [[Class: I2CE_Form#clearFields() | I2CE_Form->clearFields()]]
** [http://www.php.net/manual/en/language.types.string.php string ] $form_name
 
** stirng $opt_field <br/>The field we are limiting $form_name on.
===current()===
** stirng $opt_form <br/>The form we wish to look that $opt_field takes values in
This public method is inherited from [[Class: I2CE_Form#current() | I2CE_Form->current()]]
** [http://www.php.net/manual/en/language.types.string.php string ] $opt_id <br/>The id wish to look that $opt_field takes values.  e.g. we are looking for all instances of $form_name where $opt_field  is $opt_form|$opt_id
 
** artary $sub_fields <br/>Example  array(county+district,district+region,[region])
===displayField()===
** [http://www.php.net/manual/en/language.types.string.php string ] $sub_val <br/>Defaults to ''.  If use_display_value is set, a string we prepend to the displayed fields for the id
This public method is inherited from [[Class: I2CE_Form#displayField() | I2CE_Form->displayField()]]
***Default Value: ''
 
** [http://www.php.net/manual/en/language.types.array.php array ] $display_fields <br/>The fields which we use to populate $options with.  Defaults to an empty array in which case the value of $options is the display fields registered for this form .
===form()===
***Default Value: array()
This public method is inherited from [[Class: I2CE_Form#form() | I2CE_Form->form()]]
**$use_display_value
 
***Default Value: true
===getAllowedParentForms()===
===addCache()===
This public method is inherited from [[Class: I2CE_Form#getAllowedParentForms() | I2CE_Form->getAllowedParentForms()]]
Adds the id  number to the cache . @param integer $code The code of the entry to add.
 
*Signature: static final protected function addCache($table_name,$id,$value)
===getAttribute()===
*Parameters:
This public method is inherited from [[Class: I2CE_Form#getAttribute() | I2CE_Form->getAttribute()]]
** [http://www.php.net/manual/en/language.types.string.php string ] $table_name <br/>The name of the table in the database.
 
**$id
===getChildForms()===
** [http://www.php.net/manual/en/language.types.string.php string ] $value <br/>The value to add to the cache
This public method is inherited from [[Class: I2CE_Form#getChildForms() | I2CE_Form->getChildForms()]]
===componentizeQuery()===
 
returns the posible componentization of a form|id
===getChildFormsByForm()===
*Signature: static public function componentizeQuery($qry,$forms,$component)
This public method is inherited from [[Class: I2CE_Form#getChildFormsByForm() | I2CE_Form->getChildFormsByForm()]]
*Parameters:
 
** [http://www.php.net/manual/en/language.types.string.php string ] $qry <br/>the query need to get the form|id
===getChildren()===
** [http://www.php.net/manual/en/language.types.array.php array ] $forms <br/>an array of string which are componentized @parm string $component The component we possibly wish to componentize at.
This public method is inherited from [[Class: I2CE_Form#getChildren() | I2CE_Form->getChildren()]]
**$component
 
*Returns: string.<br/>They query need to turn $qry into one componentized to $component.
===getDisplayName()===
===createDataTree()===
This public method is inherited from [[Class: I2CE_Form#getDisplayName() | I2CE_Form->getDisplayName()]]
Create a data tree of the selectable forms.  Deisgned to be fed into tree select
 
*Signature: static public function createDataTree($fields,$forms,$limits,$orders,$display_first,$major_separator,$minor_separator)
===getField()===
*Parameters:
This public method is inherited from [[Class: I2CE_Form#getField() | I2CE_Form->getField()]]
** [http://www.php.net/manual/en/language.types.array.php array ] $fields <br/>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.
 
** [http://www.php.net/manual/en/language.types.array.php array ] $forms <br/>An unorderd array of form names whose values we allow to be selected
===getFieldNames()===
** [http://www.php.net/manual/en/language.types.array.php array ] $limits <br/>An array with keys form names and value limit data
This public method is inherited from [[Class: I2CE_Form#getFieldNames() | I2CE_Form->getFieldNames()]]
** [http://www.php.net/manual/en/language.types.array.php array ] $orders <br/>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()
===getFormId()===
**$display_first
This public method is inherited from [[Class: I2CE_Form#getFormId() | I2CE_Form->getFormId()]]
***Default Value: true
 
** [http://www.php.net/manual/en/language.types.string.php string ] $major_separator <br/>The seperator between the start display value and the extended display values.  If null, then the title is an array of values
===getHTMLName()===
***Default Value: ' - '
This public method is inherited from [[Class: I2CE_Form#getHTMLName() | I2CE_Form->getHTMLName()]]
** [http://www.php.net/manual/en/language.types.string.php string ] $minor_separator <br/>The sepeartor between the extended display values
 
***Default Value: ' '
===getId()===
===flattenDataTree()===
This public method is inherited from [[Class: I2CE_Form#getId() | I2CE_Form->getId()]]
*Signature: static public function flattenDataTree($data)
 
*Parameters:
===getParent()===
**$data
This public method is inherited from [[Class: I2CE_Form#getParent() | I2CE_Form->getParent()]]
===getCache()===
 
Return the cache cached entry for the id  number. @param integer $code The code of the entry to lookup.
===getParentForm()===
*Signature: static final protected function getCache($table_name,$id)
This public method is inherited from [[Class: I2CE_Form#getParentForm() | I2CE_Form->getParentForm()]]
*Parameters:
 
** [http://www.php.net/manual/en/language.types.string.php string ] $table_name <br/>The name of the table in the database.
===getParentID()===
**$id
This public method is inherited from [[Class: I2CE_Form#getParentID() | I2CE_Form->getParentID()]]
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]<br/>The value of the cached code.
 
===getDisplayFields()===
===getQueryDisplay()===
Returns a list of fields used for displaying this list.
This public method is inherited from [[Class: I2CE_Form#getQueryDisplay() | I2CE_Form->getQueryDisplay()]]
*Signature: static public function getDisplayFields($form_name)
 
*Parameters:
===getQueryFields()===
** [http://www.php.net/manual/en/language.types.string.php string ] $form_name
This public method is inherited from [[Class: I2CE_Form#getQueryFields() | I2CE_Form->getQueryFields()]]
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]
 
===getExtendedDisplay()===
===getQueryString()===
get an exended display for a field value
This public method is inherited from [[Class: I2CE_Form#getQueryString() | I2CE_Form->getQueryString()]]
*Signature: static public function getExtendedDisplay($fields,$start_value,$major_separator,$minor_separator)
 
*Parameters:
===hasAttribute()===
** [http://www.php.net/manual/en/language.types.array.php array ] $fields <br/>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.
This public method is inherited from [[Class: I2CE_Form#hasAttribute() | I2CE_Form->hasAttribute()]]
** [http://www.php.net/manual/en/language.types.string.php string ] $start_value <br/>E.g. "village|10"
 
** [http://www.php.net/manual/en/language.types.string.php string ] $major_separator <br/>The seperator between the start display value and the extended display values.  If null, we return an array.
===hasInvalid()===
***Default Value: ' - '
This public method is inherited from [[Class: I2CE_Form#hasInvalid() | I2CE_Form->hasInvalid()]]
** [http://www.php.net/manual/en/language.types.string.php string ] $minor_separator <br/>The sepeartor between the extended display values
 
***Default Value: ' '
===key()===
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]<br/>or array
This public method is inherited from [[Class: I2CE_Form#key() | I2CE_Form->key()]]
===getHTMLTemplate()===
 
Return the HTML file name for the form template for this form.
===listFields()===
*Signature: public function getHTMLTemplate()
This public method is inherited from [[Class: I2CE_Form#listFields() | I2CE_Form->listFields()]]
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
 
===getListType()===
===load()===
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.
This public method is inherited from [[Class: I2CE_Form#load() | I2CE_Form->load()]]
*Signature: public function getListType()
 
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
===next()===
===getSortFields()===
This public method is inherited from [[Class: I2CE_Form#next() | I2CE_Form->next()]]
Returns a list of fields used for sorting this list.
 
*Signature: static public function getSortFields($form_name)
===processDOM()===
*Parameters:
This public method is inherited from [[Class: I2CE_Form#processDOM() | I2CE_Form->processDOM()]]
** [http://www.php.net/manual/en/language.types.string.php string ] $form_name
 
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]
===removeField()===
===isCached()===
This public method is inherited from [[Class: I2CE_Form#removeField() | I2CE_Form->removeField()]]
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.
 
*Signature: static final protected function isCached($table_name,$id)
===reset()===
*Parameters:
This public method is inherited from [[Class: I2CE_Form#reset() | I2CE_Form->reset()]]
** [http://www.php.net/manual/en/language.types.string.php string ] $table_name <br/>The name of the table in the database.
 
**$id
===rewind()===
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
This public method is inherited from [[Class: I2CE_Form#rewind() | I2CE_Form->rewind()]]
===listOptions()===
 
Return the list of options for this list as an array.
===search()===
*Signature: static public function listOptions($form_name,$opt_field,$opt_value,$sub_fields,$selectable_forms)
This public method is inherited from [[Class: I2CE_Form#search() | I2CE_Form->search()]]
*Parameters:
 
** [http://www.php.net/manual/en/language.types.string.php string ] $form_name <br/>The form being listed.  This needs to be a subclass of I2CE_List
===setAttribute()===
** [http://www.php.net/manual/en/language.types.string.php string ] $opt_field <br/>An optional field to further limit the list of choices
This public method is inherited from [[Class: I2CE_Form#setAttribute() | I2CE_Form->setAttribute()]]
***Default Value: ""
 
** integer $opt_value <br/>If the $opt_field is used then this is the value to limit it by.
===setDisplayName()===
***Default Value: '|'
This public method is inherited from [[Class: I2CE_Form#setDisplayName() | I2CE_Form->setDisplayName()]]
** [http://www.php.net/manual/en/language.types.array.php array ] $sub_fields <br/>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
 
***Default Value: array()
===setForm()===
**$selectable_forms
This public method is inherited from [[Class: I2CE_Form#setForm() | I2CE_Form->setForm()]]
***Default Value: array()
 
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]
===setFromPost()===
===lookup()===
This public method is inherited from [[Class: I2CE_Form#setFromPost() | I2CE_Form->setFromPost()]]
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.
 
*Signature: static public function lookup($id,$form_name)
===setId()===
*Parameters:
This public method is inherited from [[Class: I2CE_Form#setId() | I2CE_Form->setId()]]
** integer $id <br/>The code of the entry to lookup.
 
** [http://www.php.net/manual/en/language.types.string.php string ] $form_name <br/>The name of the form in the database.
===setParent()===
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
This public method is inherited from [[Class: I2CE_Form#setParent() | I2CE_Form->setParent()]]
===monsterMash()===
 
Gets the id's for a form that live at @param string $use_display value.  Defaults to true in which case the displayed fields are returned based on the display value.  If false, then the displa @ returns array.  .  Array with keys the ids of $form_name. For values, if $use_dislpay_value is true, then
===valid()===
*Signature: static public function monsterMash($form_name,$opt_field,$opt_formid,$sub_fields,$display_fields,$use_display_value)
This public method is inherited from [[Class: I2CE_Form#valid() | I2CE_Form->valid()]]
*Parameters:
 
** [http://www.php.net/manual/en/language.types.string.php string ] $form_name <br/>Example person
===validate()===
** stirng $opt_field <br/>The field we are limiting $form_name on.  Example 'residence'
This public method is inherited from [[Class: I2CE_Form#validate() | I2CE_Form->validate()]]
** stirng $opt_formid <br/>The form|id and we wish to look that $opt_field takes values in
 
** artary $sub_fields <br/>Example  array(county+district,district+region,[region]) If a non-empty array it are the sub-fields path we wish to add to the results. In the example, if $opt_form|$opt_id = country|10 and $link_field = country, then we add in person where residence = country|10, then those person where residence is an region where  region+country = country|10. Then we add in those person id's where residence is any distrinct whose region is a region with region+country = country|10. Then we add in those person id's where residence is an county whose district has rgion field a region whose country field is country|10.
===__get()===
** [http://www.php.net/manual/en/language.types.array.php array ] $display_fields <br/>The fields which we return the values of.  Defaults to an empty array in which case the value of $options is the display fields registered for this form .
This protected method is inherited from [[Class: I2CE_Form#__get() | I2CE_Form->__get()]]
***Default Value: array()
 
**$use_display_value
===__isset()===
***Default Value: true
This protected method is inherited from [[Class: I2CE_Form#__isset() | I2CE_Form->__isset()]]
===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.
===__set()===
*Signature: public function name($delim)
This protected method is inherited from [[Class: I2CE_Form#__set() | I2CE_Form->__set()]]
*Parameters:
 
** [http://www.php.net/manual/en/language.types.string.php string ] $delim <br/>the delimiter between fields.
===__unset()===
***Default Value: ' - '
This protected method is inherited from [[Class: I2CE_Form#__unset() | I2CE_Form->__unset()]]
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
 
===setDisplayData()===
===addFormFields()===
Sets the field values to be displayed in the HTML template.
This protected method is inherited from [[Class: I2CE_Form#addFormFields() | I2CE_Form->addFormFields()]]
*Signature: public function setDisplayData($template)
 
*Parameters:
===getFormFieldsData()===
** [[Class: I2CE_Template | I2CE_Template]] &$template
This protected method is inherited from [[Class: I2CE_Form#getFormFieldsData() | I2CE_Form->getFormFieldsData()]]
===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
===lookupArray()===
*Signature: static public function walkupFieldPath($field_path,$formid)
This protected method is inherited from [[Class: I2CE_Form#lookupArray() | I2CE_Form->lookupArray()]]
*Parameters:
 
**$field_path
===_hasMethod()===
** [http://www.php.net/manual/en/language.types.string.php string ] $formid <br/>string of the form "$form|$id".  the starting value.  $form should be one of formX above (e.g. the dbvalue of a map field)
This public method is inherited from [[Class: I2CE_Fuzzy#_hasMethod() | I2CE_Fuzzy->_hasMethod()]]
*Returns: mixed.<br/>False on failure, string of the form "$form|$id" on success
==Inherited Variables==
===$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()]]
==Inherited Methods==
==Inherited Methods==
===__construct()===
===__construct()===

Revision as of 10:46, 19 October 2009

__PAGE:Class: I2CE_List This article desrcibes the dynamically created class I2CE_List.

Inherited Methods

__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

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

Inherited Methods

__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

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

Retrieved from "https://wiki.ihris.org/mediawiki/index.php?title=Class:_I2CE_List&oldid=9048"