Class: I2CE FormField YESNO: Difference between revisions

From IHRIS Wiki
No edit summary
 
(15 intermediate revisions by the same user not shown)
Line 1: Line 1:
This article describes the class ''I2CE_FormField_YESNO''.
#REDIRECT [[Class: I2CE_FormField_YESNO (4.1.7)]]
*Extends the class: [[Class: I2CE_FormField_DB_INT | I2CE_FormField_DB_INT]].
*Parent Classses:  [[Class: I2CE_FormField_DB_INT | I2CE_FormField_DB_INT]] [[Class: I2CE_FormField | I2CE_FormField]] [[Class: I2CE_Fuzzy | I2CE_Fuzzy]]
*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.0-release/annotate/head:/modules/Forms/lib/fields/I2CE_FormField_YESNO.php modules/Forms/lib/fields/I2CE_FormField_YESNO.php]
*Author: Luke Duncan <lduncan@intrahealth.org>
*Since: v2.0.0
Class for defining all the database fields used by a [[Class: I2CE_Form | ]] object.
==Methods==
===__construct()===
Create a new instance of a I2CE_FormField
*Signature: public function __construct($name,$options)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $name
** [http://www.php.net/manual/en/language.types.array.php array ] $options <br/>A list of options for this form field.
===getDBValue()===
Returns the value of this field ready to be stored in the database.
*Signature: public function getDBValue()
*Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]
===getDisplayValue()===
Returns the value of this field as a human readable format.
*Signature: public function getDisplayValue($entry)
*Parameters:
** [[Class: I2CE_Entry | I2CE_Entry]] $entry <br/>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
*Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]
===isValid()===
Checks to see if the current value for this is set and valid.
*Signature: public function isValid()
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
===processDOMEditable()===
*Signature: public function processDOMEditable($node,$template,$form_node)
*Parameters:
**$node
**$template
**$form_node
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>of DOMNode
===setFromPost()===
Sets the value of this field from the posted form.
*Signature: public function setFromPost($post)
*Parameters:
** [http://www.php.net/manual/en/language.types.array.php array ] $post <br/>The $_POST array holding the values for this form.
==Fuzzy Methods==
===generateLimit_yesno()===
This method is implemented by [[Class: I2CE_Module_FormLimits#generateLimit_YESNO_yesno() | I2CE_Module_FormLimits->generateLimit_YESNO_yesno() ]]
===generateLimit_yes()===
This method is implemented by [[Class: I2CE_Module_FormLimits#generateLimit_YESNO_yes() | I2CE_Module_FormLimits->generateLimit_YESNO_yes() ]]
===generateLimit_no()===
This method is implemented by [[Class: I2CE_Module_FormLimits#generateLimit_YESNO_no() | I2CE_Module_FormLimits->generateLimit_YESNO_no() ]]
===checkLimit_yesno()===
This method is implemented by [[Class: I2CE_Module_FormLimits#checkLimit_YESNO_yesno() | I2CE_Module_FormLimits->checkLimit_YESNO_yesno() ]]
===checkLimitString_yesno()===
This method is implemented by [[Class: I2CE_Module_FormLimits#checkLimitString_YESNO_yesno() | I2CE_Module_FormLimits->checkLimitString_YESNO_yesno() ]]
===getLimitMenu_yesno()===
This method is implemented by [[Class: I2CE_Module_FormLimits#I2CE_FormField_YESNO_DISPLAYFIELDSTYLE_yesno() | I2CE_Module_FormLimits->I2CE_FormField_YESNO_DISPLAYFIELDSTYLE_yesno() ]]
===processLimitMenu_yesno()===
This method is implemented by [[Class: I2CE_Module_FormLimits#I2CE_FormField_YESNO_PROCESSFIELDSTYLE_yesno() | I2CE_Module_FormLimits->I2CE_FormField_YESNO_PROCESSFIELDSTYLE_yesno() ]]
===checkLimit_yes()===
This method is implemented by [[Class: I2CE_Module_FormLimits#checkLimit_YESNO_yes() | I2CE_Module_FormLimits->checkLimit_YESNO_yes() ]]
===checkLimitString_yes()===
This method is implemented by [[Class: I2CE_Module_FormLimits#checkLimitString_YESNO_yes() | I2CE_Module_FormLimits->checkLimitString_YESNO_yes() ]]
===getLimitMenu_yes()===
This method is implemented by [[Class: I2CE_Module_FormLimits#I2CE_FormField_YESNO_DISPLAYFIELDSTYLE_yes() | I2CE_Module_FormLimits->I2CE_FormField_YESNO_DISPLAYFIELDSTYLE_yes() ]]
===processLimitMenu_yes()===
This method is implemented by [[Class: I2CE_Module_FormLimits#I2CE_FormField_YESNO_PROCESSFIELDSTYLE_yes() | I2CE_Module_FormLimits->I2CE_FormField_YESNO_PROCESSFIELDSTYLE_yes() ]]
===checkLimit_no()===
This method is implemented by [[Class: I2CE_Module_FormLimits#checkLimit_YESNO_no() | I2CE_Module_FormLimits->checkLimit_YESNO_no() ]]
===checkLimitString_no()===
This method is implemented by [[Class: I2CE_Module_FormLimits#checkLimitString_YESNO_no() | I2CE_Module_FormLimits->checkLimitString_YESNO_no() ]]
===getLimitMenu_no()===
This method is implemented by [[Class: I2CE_Module_FormLimits#I2CE_FormField_YESNO_DISPLAYFIELDSTYLE_no() | I2CE_Module_FormLimits->I2CE_FormField_YESNO_DISPLAYFIELDSTYLE_no() ]]
===processLimitMenu_no()===
This method is implemented by [[Class: I2CE_Module_FormLimits#I2CE_FormField_YESNO_PROCESSFIELDSTYLE_no() | I2CE_Module_FormLimits->I2CE_FormField_YESNO_PROCESSFIELDSTYLE_no() ]]
 
 
[[Category:Class Documentation]]

Latest revision as of 08:39, 23 August 2013