Class: I2CE FormField YESNO: Difference between revisions
No edit summary |
No edit summary |
||
| Line 2: | Line 2: | ||
*Extends the class: [[Class: I2CE_FormField_DB_INT | I2CE_FormField_DB_INT]]. | *Extends the class: [[Class: I2CE_FormField_DB_INT | I2CE_FormField_DB_INT]]. | ||
*Location: Part of the module [[I2CE Module List#forms|forms]] in the package [https://launchpad.net/i2ce I2CE] | *Location: Part of the module [[I2CE Module List#forms|forms]] in the package [https://launchpad.net/i2ce I2CE] | ||
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0. | *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/fields/I2CE_FormField_YESNO.php#L28 modules/Forms/lib/fields/I2CE_FormField_YESNO.php] on line 28 | ||
*Author: Luke Duncan <lduncan@intrahealth.org> | *Author: Luke Duncan <lduncan@intrahealth.org> | ||
*Since: v2.0.0 | *Since: v2.0.0 | ||
| Line 9: | Line 9: | ||
===__construct()=== | ===__construct()=== | ||
Create a new instance of a I2CE_FormField | Create a new instance of a I2CE_FormField | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/fields/I2CE_FormField_YESNO.php#L39 i2ce/modules/Forms/lib/fields/I2CE_FormField_YESNO.php] on line 39 | |||
*Signature: public function __construct($name,$options) | *Signature: public function __construct($name,$options) | ||
*Parameters: | *Parameters: | ||
| Line 15: | Line 16: | ||
===getDBValue()=== | ===getDBValue()=== | ||
Returns the value of this field ready to be stored in the database. | Returns the value of this field ready to be stored in the database. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/fields/I2CE_FormField_YESNO.php#L57 i2ce/modules/Forms/lib/fields/I2CE_FormField_YESNO.php] on line 57 | |||
*Signature: public function getDBValue() | *Signature: public function getDBValue() | ||
*Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ] | *Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ] | ||
===getDisplayValue()=== | ===getDisplayValue()=== | ||
Returns the value of this field as a human readable format. | Returns the value of this field as a human readable format. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/fields/I2CE_FormField_YESNO.php#L68 i2ce/modules/Forms/lib/fields/I2CE_FormField_YESNO.php] on line 68 | |||
*Signature: public function getDisplayValue($entry) | *Signature: public function getDisplayValue($entry) | ||
*Parameters: | *Parameters: | ||
| Line 26: | Line 29: | ||
===isValid()=== | ===isValid()=== | ||
Checks to see if the current value for this is set and valid. | Checks to see if the current value for this is set and valid. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/fields/I2CE_FormField_YESNO.php#L82 i2ce/modules/Forms/lib/fields/I2CE_FormField_YESNO.php] on line 82 | |||
*Signature: public function isValid() | *Signature: public function isValid() | ||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | ||
===processDOMEditable()=== | ===processDOMEditable()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/fields/I2CE_FormField_YESNO.php#L98 i2ce/modules/Forms/lib/fields/I2CE_FormField_YESNO.php] on line 98 | |||
*Signature: public function processDOMEditable($node,$template,$form_node) | *Signature: public function processDOMEditable($node,$template,$form_node) | ||
*Parameters: | *Parameters: | ||
| Line 37: | Line 42: | ||
===setFromPost()=== | ===setFromPost()=== | ||
Sets the value of this field from the posted form. | Sets the value of this field from the posted form. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/fields/I2CE_FormField_YESNO.php#L47 i2ce/modules/Forms/lib/fields/I2CE_FormField_YESNO.php] on line 47 | |||
*Signature: public function setFromPost($post) | *Signature: public function setFromPost($post) | ||
*Parameters: | *Parameters: | ||
Revision as of 08:50, 10 November 2009
This article describes the class I2CE_FormField_YESNO.
- Extends the class: I2CE_FormField_DB_INT.
- Location: Part of the module forms in the package I2CE
- Source: Defined in the file modules/Forms/lib/fields/I2CE_FormField_YESNO.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/lib/fields/I2CE_FormField_YESNO.php on line 39
- Signature: public function __construct($name,$options)
- Parameters:
getDBValue()
Returns the value of this field ready to be stored in the database.
- Defined in i2ce/modules/Forms/lib/fields/I2CE_FormField_YESNO.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/lib/fields/I2CE_FormField_YESNO.php on line 68
- Signature: public function getDisplayValue($entry)
- 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
- I2CE_Entry $entry
- Returns: mixed
isValid()
Checks to see if the current value for this is set and valid.
- Defined in i2ce/modules/Forms/lib/fields/I2CE_FormField_YESNO.php on line 82
- Signature: public function isValid()
- Returns: boolean
processDOMEditable()
- Defined in i2ce/modules/Forms/lib/fields/I2CE_FormField_YESNO.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/lib/fields/I2CE_FormField_YESNO.php on line 47
- Signature: public function setFromPost($post)
- Parameters:
- array $post
The $_POST array holding the values for this form.
- array $post
Inherited Methods
addHistory()
This public method is inherited from I2CE_FormField->addHistory()
compare()
This public method is inherited from I2CE_FormField->compare()
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()
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()
getForm()
This public method is inherited from I2CE_FormField->getForm()
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()
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()
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()
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()
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()
setForm()
This public method is inherited from I2CE_FormField->setForm()
setFromDB()
This public method is inherited from I2CE_FormField->setFromDB()
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()
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()
getElement()
This protected method is inherited from I2CE_FormField->getElement()
getOptionsByPath()
This protected method is inherited from I2CE_FormField->getOptionsByPath()
optionsHasPath()
This protected method is inherited from I2CE_FormField->optionsHasPath()
setElement()
This protected method is inherited from I2CE_FormField->setElement()
_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
$form
Theis protected variable is inherited from I2CE_FormField->$form
$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
$invalid
Theis protected variable is inherited from I2CE_FormField->$invalid
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()
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()
populateHistory()
This method is inherited from I2CE_FormField->populateHistory()
userMessage()
This method is inherited from I2CE_Fuzzy->userMessage()
Fuzzy Methods
generateLimit_yesno()
This method is implemented by I2CE_Module_FormLimits->generateLimit_YESNO_yesno()
generateLimit_yes()
This method is implemented by I2CE_Module_FormLimits->generateLimit_YESNO_yes()
generateLimit_no()
This method is implemented by I2CE_Module_FormLimits->generateLimit_YESNO_no()
checkLimit_yesno()
This method is implemented by I2CE_Module_FormLimits->checkLimit_YESNO_yesno()
checkLimitString_yesno()
This method is implemented by I2CE_Module_FormLimits->checkLimitString_YESNO_yesno()
getLimitMenu_yesno()
This method is implemented by I2CE_Module_FormLimits->I2CE_FormField_YESNO_DISPLAYFIELDSTYLE_yesno()
processLimitMenu_yesno()
This method is implemented by I2CE_Module_FormLimits->I2CE_FormField_YESNO_PROCESSFIELDSTYLE_yesno()
checkLimit_yes()
This method is implemented by I2CE_Module_FormLimits->checkLimit_YESNO_yes()
checkLimitString_yes()
This method is implemented by I2CE_Module_FormLimits->checkLimitString_YESNO_yes()
getLimitMenu_yes()
This method is implemented by I2CE_Module_FormLimits->I2CE_FormField_YESNO_DISPLAYFIELDSTYLE_yes()
processLimitMenu_yes()
This method is implemented by I2CE_Module_FormLimits->I2CE_FormField_YESNO_PROCESSFIELDSTYLE_yes()
checkLimit_no()
This method is implemented by I2CE_Module_FormLimits->checkLimit_YESNO_no()
checkLimitString_no()
This method is implemented by I2CE_Module_FormLimits->checkLimitString_YESNO_no()
getLimitMenu_no()
This method is implemented by I2CE_Module_FormLimits->I2CE_FormField_YESNO_DISPLAYFIELDSTYLE_no()
processLimitMenu_no()
This method is implemented by I2CE_Module_FormLimits->I2CE_FormField_YESNO_PROCESSFIELDSTYLE_no()
