Class: I2CE SimpleList: Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
Line 1: Line 1:
This article desrcibes the class '''I2CE_SimpleList''' which extends the class [[Class: I2CE_List | I2CE_List]]
This article desrcibes the class '''I2CE_SimpleList'''.
*Extends the class: [[Class: I2CE_List | I2CE_List]].
It is contained in the module [[iHRIS Module List#Lists|Lists]] in the package [https://launchpad.net/i2ce I2CE]
It is contained in the module [[iHRIS Module List#Lists|Lists]] in the package [https://launchpad.net/i2ce I2CE]


Line 11: Line 12:
Return the HTML file name for the form template for this form.
Return the HTML file name for the form template for this form.
*Signature: public function getHTMLTemplate()
*Signature: public function getHTMLTemplate()
*Returns: [http://www.php.net/manual/en/language.types.string.php string]
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
===getListType()===
===getListType()===
Return the list edit type for this list.
Return the list edit type for this list.
Line 19: Line 20:
linked list object for the object.
linked list object for the object.
*Signature: public function getListType()
*Signature: public function getListType()
*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 Variables==
==Inherited Variables==
===$cache===
===$cache===

Revision as of 21:25, 16 October 2009

This article desrcibes the class I2CE_SimpleList.

It is contained in the module Lists in the package I2CE

The class is defined in the file: modules/Forms/modules/Lists/lib/I2CE_SimpleList.php

Object for dealing with simple lists.

  • Author: Luke Duncan <lduncan@intrahealth.org>
  • Since: v2.0.0

Methods

getHTMLTemplate()

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

  • Signature: public function getHTMLTemplate()
  • 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.

  • Signature: public function getListType()
  • Returns: string

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