|
|
| (16 intermediate revisions by one other user not shown) |
| Line 1: |
Line 1: |
| This article describes the class ''I2CE_FormField_BOOL''.
| | #REDIRECT [[Class: I2CE_FormField_BOOL (4.1.12)]] |
| *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_BOOL.php modules/Forms/lib/fields/I2CE_FormField_BOOL.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_truefalse()===
| |
| This method is implemented by [[Class: I2CE_Module_FormLimits#generateLimit_BOOL_truefalse() | I2CE_Module_FormLimits->generateLimit_BOOL_truefalse() ]]
| |
| ===generateLimit_true()===
| |
| This method is implemented by [[Class: I2CE_Module_FormLimits#generateLimit_BOOL_true() | I2CE_Module_FormLimits->generateLimit_BOOL_true() ]]
| |
| ===generateLimit_false()===
| |
| This method is implemented by [[Class: I2CE_Module_FormLimits#generateLimit_BOOL_false() | I2CE_Module_FormLimits->generateLimit_BOOL_false() ]]
| |
| ===checkLimit_truefalse()===
| |
| This method is implemented by [[Class: I2CE_Module_FormLimits#checkLimit_BOOL_truefalse() | I2CE_Module_FormLimits->checkLimit_BOOL_truefalse() ]]
| |
| ===checkLimitString_truefalse()===
| |
| This method is implemented by [[Class: I2CE_Module_FormLimits#checkLimitString_BOOL_truefalse() | I2CE_Module_FormLimits->checkLimitString_BOOL_truefalse() ]]
| |
| ===getLimitMenu_truefalse()===
| |
| This method is implemented by [[Class: I2CE_Module_FormLimits#I2CE_FormField_BOOL_DISPLAYFIELDSTYLE_truefalse() | I2CE_Module_FormLimits->I2CE_FormField_BOOL_DISPLAYFIELDSTYLE_truefalse() ]]
| |
| ===processLimitMenu_truefalse()===
| |
| This method is implemented by [[Class: I2CE_Module_FormLimits#I2CE_FormField_BOOL_PROCESSFIELDSTYLE_truefalse() | I2CE_Module_FormLimits->I2CE_FormField_BOOL_PROCESSFIELDSTYLE_truefalse() ]]
| |
| ===checkLimit_true()===
| |
| This method is implemented by [[Class: I2CE_Module_FormLimits#checkLimit_BOOL_true() | I2CE_Module_FormLimits->checkLimit_BOOL_true() ]]
| |
| ===checkLimitString_true()===
| |
| This method is implemented by [[Class: I2CE_Module_FormLimits#checkLimitString_BOOL_true() | I2CE_Module_FormLimits->checkLimitString_BOOL_true() ]]
| |
| ===getLimitMenu_true()===
| |
| This method is implemented by [[Class: I2CE_Module_FormLimits#I2CE_FormField_BOOL_DISPLAYFIELDSTYLE_true() | I2CE_Module_FormLimits->I2CE_FormField_BOOL_DISPLAYFIELDSTYLE_true() ]]
| |
| ===processLimitMenu_true()===
| |
| This method is implemented by [[Class: I2CE_Module_FormLimits#I2CE_FormField_BOOL_PROCESSFIELDSTYLE_true() | I2CE_Module_FormLimits->I2CE_FormField_BOOL_PROCESSFIELDSTYLE_true() ]]
| |
| ===checkLimit_false()===
| |
| This method is implemented by [[Class: I2CE_Module_FormLimits#checkLimit_BOOL_false() | I2CE_Module_FormLimits->checkLimit_BOOL_false() ]]
| |
| ===checkLimitString_false()===
| |
| This method is implemented by [[Class: I2CE_Module_FormLimits#checkLimitString_BOOL_false() | I2CE_Module_FormLimits->checkLimitString_BOOL_false() ]]
| |
| ===getLimitMenu_false()===
| |
| This method is implemented by [[Class: I2CE_Module_FormLimits#I2CE_FormField_BOOL_DISPLAYFIELDSTYLE_false() | I2CE_Module_FormLimits->I2CE_FormField_BOOL_DISPLAYFIELDSTYLE_false() ]]
| |
| ===processLimitMenu_false()===
| |
| This method is implemented by [[Class: I2CE_Module_FormLimits#I2CE_FormField_BOOL_PROCESSFIELDSTYLE_false() | I2CE_Module_FormLimits->I2CE_FormField_BOOL_PROCESSFIELDSTYLE_false() ]]
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
