Class: I2CE FormField BOOL (4.1.12)

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

This article describes the class I2CE_FormField_BOOL .

• Extends the class: I2CE_FormField_DB_INT.
• Location: Part of the module Fields in the package I2CE 4.1.12-release
• Source: Defined in the file modules/Forms/modules/Fields/lib/I2CE_FormField_BOOL.php on line 28
• Author: Luke Duncan <lduncan@intrahealth.org>
• Since: v2.0.0

Class for defining all the database fields used by a object.

Methods

__construct()

Create a new instance of a I2CE_FormField

• Defined in i2ce/modules/Forms/modules/Fields/lib/I2CE_FormField_BOOL.php on line 39
• Signature: public function __construct($name,$options)
• Parameters:
  • string $name
  • array $options
    A list of options for this form field.

getDBValue()

Returns the value of this field ready to be stored in the database.

• Defined in i2ce/modules/Forms/modules/Fields/lib/I2CE_FormField_BOOL.php on line 57
• Signature: public function getDBValue()
• Returns: mixed

getDisplayValue()

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

• Defined in i2ce/modules/Forms/modules/Fields/lib/I2CE_FormField_BOOL.php on line 68
• 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

isValid()

Checks to see if the current value for this is set and valid.

• Defined in i2ce/modules/Forms/modules/Fields/lib/I2CE_FormField_BOOL.php on line 82
• Signature: public function isValid()
• Returns: boolean

processDOMEditable()

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

setFromPost()

Sets the value of this field from the posted form.

• Defined in i2ce/modules/Forms/modules/Fields/lib/I2CE_FormField_BOOL.php on line 47
• Signature: public function setFromPost($post)
• Parameters:
  • array $post
    The $_POST array holding the values for this form.

Inherited Methods

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

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

isSameValue()

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

issetValue()

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

nextHistory()

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

postprocessDOMEditable()

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

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

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

generateLimit_equals()

This method is inherited from I2CE_FormField_DB_INT->generateLimit_equals()

generateLimit_greaterthan()

This method is inherited from I2CE_FormField_DB_INT->generateLimit_greaterthan()

generateLimit_lessthan()

This method is inherited from I2CE_FormField_DB_INT->generateLimit_lessthan()

generateLimit_greaterthan_equals()

This method is inherited from I2CE_FormField_DB_INT->generateLimit_greaterthan_equals()

generateLimit_lessthan_equals()

This method is inherited from I2CE_FormField_DB_INT->generateLimit_lessthan_equals()

generateLimit_between()

This method is inherited from I2CE_FormField_DB_INT->generateLimit_between()

checkLimit_in()

This method is inherited from I2CE_FormField_DB_INT->checkLimit_in()

checkLimitString_in()

This method is inherited from I2CE_FormField_DB_INT->checkLimitString_in()

getLimitMenu_in()

This method is inherited from I2CE_FormField_DB_INT->getLimitMenu_in()

processLimitMenu_in()

This method is inherited from I2CE_FormField_DB_INT->processLimitMenu_in()

checkLimit_equals()

This method is inherited from I2CE_FormField_DB_INT->checkLimit_equals()

checkLimitString_equals()

This method is inherited from I2CE_FormField_DB_INT->checkLimitString_equals()

getLimitMenu_equals()

This method is inherited from I2CE_FormField_DB_INT->getLimitMenu_equals()

processLimitMenu_equals()

This method is inherited from I2CE_FormField_DB_INT->processLimitMenu_equals()

checkLimit_greaterthan()

This method is inherited from I2CE_FormField_DB_INT->checkLimit_greaterthan()

checkLimitString_greaterthan()

This method is inherited from I2CE_FormField_DB_INT->checkLimitString_greaterthan()

getLimitMenu_greaterthan()

This method is inherited from I2CE_FormField_DB_INT->getLimitMenu_greaterthan()

processLimitMenu_greaterthan()

This method is inherited from I2CE_FormField_DB_INT->processLimitMenu_greaterthan()

checkLimit_lessthan()

This method is inherited from I2CE_FormField_DB_INT->checkLimit_lessthan()

checkLimitString_lessthan()

This method is inherited from I2CE_FormField_DB_INT->checkLimitString_lessthan()

getLimitMenu_lessthan()

This method is inherited from I2CE_FormField_DB_INT->getLimitMenu_lessthan()

processLimitMenu_lessthan()

This method is inherited from I2CE_FormField_DB_INT->processLimitMenu_lessthan()

checkLimit_greaterthan_equals()

This method is inherited from I2CE_FormField_DB_INT->checkLimit_greaterthan_equals()

checkLimitString_greaterthan_equals()

This method is inherited from I2CE_FormField_DB_INT->checkLimitString_greaterthan_equals()

getLimitMenu_greaterthan_equals()

This method is inherited from I2CE_FormField_DB_INT->getLimitMenu_greaterthan_equals()

processLimitMenu_greaterthan_equals()

This method is inherited from I2CE_FormField_DB_INT->processLimitMenu_greaterthan_equals()

checkLimit_lessthan_equals()

This method is inherited from I2CE_FormField_DB_INT->checkLimit_lessthan_equals()

checkLimitString_lessthan_equals()

This method is inherited from I2CE_FormField_DB_INT->checkLimitString_lessthan_equals()

getLimitMenu_lessthan_equals()

This method is inherited from I2CE_FormField_DB_INT->getLimitMenu_lessthan_equals()

processLimitMenu_lessthan_equals()

This method is inherited from I2CE_FormField_DB_INT->processLimitMenu_lessthan_equals()

checkLimit_between()

This method is inherited from I2CE_FormField_DB_INT->checkLimit_between()

checkLimitString_between()

This method is inherited from I2CE_FormField_DB_INT->checkLimitString_between()

getLimitMenu_between()

This method is inherited from I2CE_FormField_DB_INT->getLimitMenu_between()

processLimitMenu_between()

This method is inherited from I2CE_FormField_DB_INT->processLimitMenu_between()

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

Fuzzy Methods

generateLimit_truefalse()

This method is implemented by I2CE_Module_FieldLimits->generateLimit_BOOL_truefalse()

generateLimit_true()

This method is implemented by I2CE_Module_FieldLimits->generateLimit_BOOL_true()

generateLimit_false()

This method is implemented by I2CE_Module_FieldLimits->generateLimit_BOOL_false()

checkLimit_truefalse()

This method is implemented by I2CE_Module_FieldLimits->checkLimit_BOOL_truefalse()

checkLimitString_truefalse()

This method is implemented by I2CE_Module_FieldLimits->checkLimitString_BOOL_truefalse()

getLimitMenu_truefalse()

This method is implemented by I2CE_Module_FieldLimits->I2CE_FormField_BOOL_DISPLAYFIELDSTYLE_truefalse()

processLimitMenu_truefalse()

This method is implemented by I2CE_Module_FieldLimits->I2CE_FormField_BOOL_PROCESSFIELDSTYLE_truefalse()

checkLimit_true()

This method is implemented by I2CE_Module_FieldLimits->checkLimit_BOOL_true()

checkLimitString_true()

This method is implemented by I2CE_Module_FieldLimits->checkLimitString_BOOL_true()

getLimitMenu_true()

This method is implemented by I2CE_Module_FieldLimits->I2CE_FormField_BOOL_DISPLAYFIELDSTYLE_true()

processLimitMenu_true()

This method is implemented by I2CE_Module_FieldLimits->I2CE_FormField_BOOL_PROCESSFIELDSTYLE_true()

checkLimit_false()

This method is implemented by I2CE_Module_FieldLimits->checkLimit_BOOL_false()

checkLimitString_false()

This method is implemented by I2CE_Module_FieldLimits->checkLimitString_BOOL_false()

getLimitMenu_false()

This method is implemented by I2CE_Module_FieldLimits->I2CE_FormField_BOOL_DISPLAYFIELDSTYLE_false()

processLimitMenu_false()

This method is implemented by I2CE_Module_FieldLimits->I2CE_FormField_BOOL_PROCESSFIELDSTYLE_false()