Class: I2CE FormField ENUM (4.1.12)

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

This article describes the class I2CE_FormField_ENUM .

• Extends the class: I2CE_FormField_STRING_LINE.
• Location: Part of the module fields-enum in the package I2CE 4.1.12-release
• Source: Defined in the file modules/Forms/modules/Fields/modules/Enum/lib/I2CE_FormField_ENUM.php on line 28
• Author: Luke Duncan <lduncan@intrahealth.org>
• Since: v4.1.6

Class for defining ENUM form fields.

Variables

$enum_values

The list of values for this field.

• Defined in i2ce/modules/Forms/modules/Fields/modules/Enum/lib/I2CE_FormField_ENUM.php on line 33
• Type: protected array $enum_values

Methods

__construct()

Create a new instance of this form field.

• Defined in i2ce/modules/Forms/modules/Fields/modules/Enum/lib/I2CE_FormField_ENUM.php on line 40
• Signature: public function __construct($name,$options)
• Parameters:
  • string $name
  • array $options
    • Default Value: array()

getDisplayValue()

Returns the value of this field as a human readable format.

• Defined in i2ce/modules/Forms/modules/Fields/modules/Enum/lib/I2CE_FormField_ENUM.php on line 52
• Signature: public function getDisplayValue($entry,$style)
• Parameters:
  • I2CE_Entry $entry
    If a I2CE_Entry object has been passed to this method then it will return the value for that entry assuming it's an entry for this field.
    • Default Value: false
  • $style
    • Default Value: 'default'
• Returns: mixed

postprocessDOMEditable()

• Defined in i2ce/modules/Forms/modules/Fields/modules/Enum/lib/I2CE_FormField_ENUM.php on line 176
• Signature: public function postprocessDOMEditable($node,$template,$form_node)
• Parameters:
  • $node
  • $template
  • $form_node

processDOMEditable()

• Defined in i2ce/modules/Forms/modules/Fields/modules/Enum/lib/I2CE_FormField_ENUM.php on line 133
• Signature: public function processDOMEditable($node,$template,$form_node)
• Parameters:
  • $node
  • $template
  • $form_node
• Returns: array
  of DOMNode

setupEnum()

Setup list of enumerated values for this field.

• Defined in i2ce/modules/Forms/modules/Fields/modules/Enum/lib/I2CE_FormField_ENUM.php on line 69
• Signature: public function setupEnum($display)
• Parameters:
  • $display
    • Default Value: 'default'

Inherited Methods

isSameValue()

This public method is inherited from I2CE_FormField_DB_STRING->isSameValue()

isValid()

This public method is inherited from I2CE_FormField_DB_STRING->isValid()

addHistory()

This public method is inherited from I2CE_FormField->addHistory()

cleanup()

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

compare()

This public method is inherited from I2CE_FormField->compare()

compareEntryDate()

This public method is inherited from I2CE_FormField->compareEntryDate()

createField()

This public method is inherited from I2CE_FormField->createField()

firstHistory()

This public method is inherited from I2CE_FormField->firstHistory()

getAttribute()

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

getContainer()

This public method is inherited from I2CE_FormField->getContainer()

getDBType()

This public method is inherited from I2CE_FormField->getDBType()

getDBValue()

This public method is inherited from I2CE_FormField->getDBValue()

getDisplayNode()

This public method is inherited from I2CE_FormField->getDisplayNode()

getDisplays()

This public method is inherited from I2CE_FormField->getDisplays()

getElement()

This public method is inherited from I2CE_FormField->getElement()

getFromDB()

This public method is inherited from I2CE_FormField->getFromDB()

getHTMLName()

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

getHeader()

This public method is inherited from I2CE_FormField->getHeader()

getHistory()

This public method is inherited from I2CE_FormField->getHistory()

getHref()

This public method is inherited from I2CE_FormField->getHref()

getInvalid()

This public method is inherited from I2CE_FormField->getInvalid()

getMDB2Type()

This public method is inherited from I2CE_FormField->getMDB2Type()

getName()

This public method is inherited from I2CE_FormField->getName()

getOption()

This public method is inherited from I2CE_FormField->getOption()

getStaticAttribute()

This public method is inherited from I2CE_FormField->getStaticAttribute()

getString()

This public method is inherited from I2CE_FormField->getString()

getTypeString()

This public method is inherited from I2CE_FormField->getTypeString()

getValue()

This public method is inherited from I2CE_FormField->getValue()

hasAttribute()

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

hasDisplay()

This public method is inherited from I2CE_FormField->hasDisplay()

hasHeader()

This public method is inherited from I2CE_FormField->hasHeader()

hasInvalid()

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

hasNextHistory()

This public method is inherited from I2CE_FormField->hasNextHistory()

hasOption()

This public method is inherited from I2CE_FormField->hasOption()

hasStaticAttribute()

This public method is inherited from I2CE_FormField->hasStaticAttribute()

isInDB()

This public method is inherited from I2CE_FormField->isInDB()

issetValue()

This public method is inherited from I2CE_FormField->issetValue()

nextHistory()

This public method is inherited from I2CE_FormField->nextHistory()

processDOM()

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

processDOMNotEditable()

This public method is inherited from I2CE_FormField->processDOMNotEditable()

setAttribute()

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

setContainer()

This public method is inherited from I2CE_FormField->setContainer()

setDefaultOptions()

This public method is inherited from I2CE_FormField->setDefaultOptions()

setElement()

This public method is inherited from I2CE_FormField->setElement()

setFromDB()

This public method is inherited from I2CE_FormField->setFromDB()

setFromPost()

This public method is inherited from I2CE_FormField->setFromPost()

setHTMLName()

This public method is inherited from I2CE_FormField->setHTMLName()

setHeaders()

This public method is inherited from I2CE_FormField->setHeaders()

setHref()

This public method is inherited from I2CE_FormField->setHref()

setInvalid()

This public method is inherited from I2CE_FormField->setInvalid()

setInvalidMessage()

This public method is inherited from I2CE_FormField->setInvalidMessage()

setOption()

This public method is inherited from I2CE_FormField->setOption()

setStaticAttribute()

This public method is inherited from I2CE_FormField->setStaticAttribute()

setValue()

This public method is inherited from I2CE_FormField->setValue()

unsetValue()

This public method is inherited from I2CE_FormField->unsetValue()

displayInvalid()

This protected method is inherited from I2CE_FormField->displayInvalid()

getDefaultValue()

This protected method is inherited from I2CE_FormField->getDefaultValue()

getOptionsByPath()

This protected method is inherited from I2CE_FormField->getOptionsByPath()

optionsHasPath()

This protected method is inherited from I2CE_FormField->optionsHasPath()

processHeaderEditable()

This protected method is inherited from I2CE_FormField->processHeaderEditable()

withinForm()

This protected method is inherited from I2CE_FormField->withinForm()

_hasMethod()

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

Inherited Variables

$name

Theis protected variable is inherited from I2CE_FormField->$name

$options

Theis protected variable is inherited from I2CE_FormField->$options

$value

Theis protected variable is inherited from I2CE_FormField->$value

$headers

Theis protected variable is inherited from I2CE_FormField->$headers

$href

Theis protected variable is inherited from I2CE_FormField->$href

$container

Theis protected variable is inherited from I2CE_FormField->$container

$history

Theis protected variable is inherited from I2CE_FormField->$history

$history_idx

Theis protected variable is inherited from I2CE_FormField->$history_idx

$attributes

Theis protected variable is inherited from I2CE_FormField->$attributes

$static_attrs

Theis protected variable is inherited from I2CE_FormField->$static_attrs

$invalid

Theis protected variable is inherited from I2CE_FormField->$invalid

$HTMLName

Theis protected variable is inherited from I2CE_FormField->$HTMLName

Inherited Fuzzy Methods

generateLimit_in()

This method is inherited from I2CE_FormField_DB_STRING->generateLimit_in()

generateLimit_equals()

This method is inherited from I2CE_FormField_DB_STRING->generateLimit_equals()

generateLimit_greaterthan()

This method is inherited from I2CE_FormField_DB_STRING->generateLimit_greaterthan()

generateLimit_lessthan()

This method is inherited from I2CE_FormField_DB_STRING->generateLimit_lessthan()

generateLimit_greaterthan_equals()

This method is inherited from I2CE_FormField_DB_STRING->generateLimit_greaterthan_equals()

generateLimit_lessthan_equals()

This method is inherited from I2CE_FormField_DB_STRING->generateLimit_lessthan_equals()

generateLimit_between()

This method is inherited from I2CE_FormField_DB_STRING->generateLimit_between()

generateLimit_like()

This method is inherited from I2CE_FormField_DB_STRING->generateLimit_like()

generateLimit_lowerlike()

This method is inherited from I2CE_FormField_DB_STRING->generateLimit_lowerlike()

generateLimit_lowerequals()

This method is inherited from I2CE_FormField_DB_STRING->generateLimit_lowerequals()

generateLimit_contains()

This method is inherited from I2CE_FormField_DB_STRING->generateLimit_contains()

generateLimit_startswith()

This method is inherited from I2CE_FormField_DB_STRING->generateLimit_startswith()

checkLimit_in()

This method is inherited from I2CE_FormField_DB_STRING->checkLimit_in()

checkLimitString_in()

This method is inherited from I2CE_FormField_DB_STRING->checkLimitString_in()

getLimitMenu_in()

This method is inherited from I2CE_FormField_DB_STRING->getLimitMenu_in()

processLimitMenu_in()

This method is inherited from I2CE_FormField_DB_STRING->processLimitMenu_in()

checkLimit_equals()

This method is inherited from I2CE_FormField_DB_STRING->checkLimit_equals()

checkLimitString_equals()

This method is inherited from I2CE_FormField_DB_STRING->checkLimitString_equals()

getLimitMenu_equals()

This method is inherited from I2CE_FormField_DB_STRING->getLimitMenu_equals()

processLimitMenu_equals()

This method is inherited from I2CE_FormField_DB_STRING->processLimitMenu_equals()

checkLimit_greaterthan()

This method is inherited from I2CE_FormField_DB_STRING->checkLimit_greaterthan()

checkLimitString_greaterthan()

This method is inherited from I2CE_FormField_DB_STRING->checkLimitString_greaterthan()

getLimitMenu_greaterthan()

This method is inherited from I2CE_FormField_DB_STRING->getLimitMenu_greaterthan()

processLimitMenu_greaterthan()

This method is inherited from I2CE_FormField_DB_STRING->processLimitMenu_greaterthan()

checkLimit_lessthan()

This method is inherited from I2CE_FormField_DB_STRING->checkLimit_lessthan()

checkLimitString_lessthan()

This method is inherited from I2CE_FormField_DB_STRING->checkLimitString_lessthan()

getLimitMenu_lessthan()

This method is inherited from I2CE_FormField_DB_STRING->getLimitMenu_lessthan()

processLimitMenu_lessthan()

This method is inherited from I2CE_FormField_DB_STRING->processLimitMenu_lessthan()

checkLimit_greaterthan_equals()

This method is inherited from I2CE_FormField_DB_STRING->checkLimit_greaterthan_equals()

checkLimitString_greaterthan_equals()

This method is inherited from I2CE_FormField_DB_STRING->checkLimitString_greaterthan_equals()

getLimitMenu_greaterthan_equals()

This method is inherited from I2CE_FormField_DB_STRING->getLimitMenu_greaterthan_equals()

processLimitMenu_greaterthan_equals()

This method is inherited from I2CE_FormField_DB_STRING->processLimitMenu_greaterthan_equals()

checkLimit_lessthan_equals()

This method is inherited from I2CE_FormField_DB_STRING->checkLimit_lessthan_equals()

checkLimitString_lessthan_equals()

This method is inherited from I2CE_FormField_DB_STRING->checkLimitString_lessthan_equals()

getLimitMenu_lessthan_equals()

This method is inherited from I2CE_FormField_DB_STRING->getLimitMenu_lessthan_equals()

processLimitMenu_lessthan_equals()

This method is inherited from I2CE_FormField_DB_STRING->processLimitMenu_lessthan_equals()

checkLimit_between()

This method is inherited from I2CE_FormField_DB_STRING->checkLimit_between()

checkLimitString_between()

This method is inherited from I2CE_FormField_DB_STRING->checkLimitString_between()

getLimitMenu_between()

This method is inherited from I2CE_FormField_DB_STRING->getLimitMenu_between()

processLimitMenu_between()

This method is inherited from I2CE_FormField_DB_STRING->processLimitMenu_between()

checkLimit_like()

This method is inherited from I2CE_FormField_DB_STRING->checkLimit_like()

checkLimitString_like()

This method is inherited from I2CE_FormField_DB_STRING->checkLimitString_like()

getLimitMenu_like()

This method is inherited from I2CE_FormField_DB_STRING->getLimitMenu_like()

processLimitMenu_like()

This method is inherited from I2CE_FormField_DB_STRING->processLimitMenu_like()

checkLimit_lowerlike()

This method is inherited from I2CE_FormField_DB_STRING->checkLimit_lowerlike()

checkLimitString_lowerlike()

This method is inherited from I2CE_FormField_DB_STRING->checkLimitString_lowerlike()

getLimitMenu_lowerlike()

This method is inherited from I2CE_FormField_DB_STRING->getLimitMenu_lowerlike()

processLimitMenu_lowerlike()

This method is inherited from I2CE_FormField_DB_STRING->processLimitMenu_lowerlike()

checkLimit_lowerequals()

This method is inherited from I2CE_FormField_DB_STRING->checkLimit_lowerequals()

checkLimitString_lowerequals()

This method is inherited from I2CE_FormField_DB_STRING->checkLimitString_lowerequals()

getLimitMenu_lowerequals()

This method is inherited from I2CE_FormField_DB_STRING->getLimitMenu_lowerequals()

processLimitMenu_lowerequals()

This method is inherited from I2CE_FormField_DB_STRING->processLimitMenu_lowerequals()

checkLimit_contains()

This method is inherited from I2CE_FormField_DB_STRING->checkLimit_contains()

checkLimitString_contains()

This method is inherited from I2CE_FormField_DB_STRING->checkLimitString_contains()

getLimitMenu_contains()

This method is inherited from I2CE_FormField_DB_STRING->getLimitMenu_contains()

processLimitMenu_contains()

This method is inherited from I2CE_FormField_DB_STRING->processLimitMenu_contains()

checkLimit_startswith()

This method is inherited from I2CE_FormField_DB_STRING->checkLimit_startswith()

checkLimitString_startswith()

This method is inherited from I2CE_FormField_DB_STRING->checkLimitString_startswith()

getLimitMenu_startswith()

This method is inherited from I2CE_FormField_DB_STRING->getLimitMenu_startswith()

processLimitMenu_startswith()

This method is inherited from I2CE_FormField_DB_STRING->processLimitMenu_startswith()

cachedTableReference()

This method is inherited from I2CE_FormField->cachedTableReference()

isNumeric()

This method is inherited from I2CE_FormField->isNumeric()

getLimitStyles()

This method is inherited from I2CE_FormField->getLimitStyles()

generateLimit()

This method is inherited from I2CE_FormField->generateLimit()

describeLimit()

This method is inherited from I2CE_FormField->describeLimit()

generateLimit_null()

This method is inherited from I2CE_FormField->generateLimit_null()

generateLimit_not_null()

This method is inherited from I2CE_FormField->generateLimit_not_null()

generateLimit_null_not_null()

This method is inherited from I2CE_FormField->generateLimit_null_not_null()

checkLimit_null()

This method is inherited from I2CE_FormField->checkLimit_null()

checkLimit_not_null()

This method is inherited from I2CE_FormField->checkLimit_not_null()

checkLimit_null_not_null()

This method is inherited from I2CE_FormField->checkLimit_null_not_null()

checkLimitString_null()

This method is inherited from I2CE_FormField->checkLimitString_null()

checkLimitString_not_null()

This method is inherited from I2CE_FormField->checkLimitString_not_null()

checkLimitString_null_not_null()

This method is inherited from I2CE_FormField->checkLimitString_null_not_null()

getLimitMenu_null()

This method is inherited from I2CE_FormField->getLimitMenu_null()

getLimitMenu_not_null()

This method is inherited from I2CE_FormField->getLimitMenu_not_null()

getLimitMenu_null_not_null()

This method is inherited from I2CE_FormField->getLimitMenu_null_not_null()

processLimitMenu_null()

This method is inherited from I2CE_FormField->processLimitMenu_null()

processLimitMenu_not_null()

This method is inherited from I2CE_FormField->processLimitMenu_not_null()

processLimitMenu_null_not_null()

This method is inherited from I2CE_FormField->processLimitMenu_null_not_null()

generateLimit_max_parent()

This method is inherited from I2CE_FormField->generateLimit_max_parent()

generateLimit_min_parent()

This method is inherited from I2CE_FormField->generateLimit_min_parent()

generateLimit_max_parent_form()

This method is inherited from I2CE_FormField->generateLimit_max_parent_form()

generateLimit_min_parent_form()

This method is inherited from I2CE_FormField->generateLimit_min_parent_form()

getLimitMenu_max_parent()

This method is inherited from I2CE_FormField->getLimitMenu_max_parent()

getLimitMenu_min_parent()

This method is inherited from I2CE_FormField->getLimitMenu_min_parent()

getLimitMenu_max_parent_form()

This method is inherited from I2CE_FormField->getLimitMenu_max_parent_form()

getLimitMenu_min_parent_form()

This method is inherited from I2CE_FormField->getLimitMenu_min_parent_form()

processLimitMenu_max_parent()

This method is inherited from I2CE_FormField->processLimitMenu_max_parent()

processLimitMenu_min_parent()

This method is inherited from I2CE_FormField->processLimitMenu_min_parent()

processLimitMenu_max_parent_form()

This method is inherited from I2CE_FormField->processLimitMenu_max_parent_form()

processLimitMenu_min_parent_form()

This method is inherited from I2CE_FormField->processLimitMenu_min_parent_form()

save()

This method is inherited from I2CE_FormField->save()

globalFieldUpdate()

This method is inherited from I2CE_FormField->globalFieldUpdate()

populateHistory()

This method is inherited from I2CE_FormField->populateHistory()

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()

Inherited Fuzzy CLI Methods

cachedTableReference()

This method is inherited from I2CE_FormField->cachedTableReference()