|
|
| (15 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| This article describes the class ''I2CE_FormField_INT_LIST''.
| | #REDIRECT [[Class: I2CE_FormField_INT_LIST (4.1.7)]] |
| *Extends the class: [[Class: I2CE_FormField_DB_STRING | I2CE_FormField_DB_STRING]].
| |
| *Parent Classses: [[Class: I2CE_FormField_DB_STRING | I2CE_FormField_DB_STRING]] [[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_INT_LIST.php modules/Forms/lib/fields/I2CE_FormField_INT_LIST.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==
| |
| ===getDBValue()===
| |
| *Signature: public function getDBValue()
| |
| ===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 ]
| |
| ===getFromDB()===
| |
| Return the value of this field from the database format for the given type @param integer $type The type of the field to be returned.
| |
| *Signature: public function getFromDB($value)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $value
| |
| ===getValue()===
| |
| *Signature: public function getValue()
| |
| ===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
| |
| ===setFromDB()===
| |
| Sets the value of this field from the database format.
| |
| *Signature: public function setFromDB($value)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $value
| |
| ===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.
| |
| ===setValueLookup()===
| |
| Sets the value of this mapped field from a lookup value. Any linked fields should be known at this point so this should find the correct value.
| |
| *Signature: public function setValueLookup($lookup_value)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $lookup_value
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]<br/>Returns true if the value has been set to something
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
