Class: I2CE FormField MAP MULT (4.0.12)

The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

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

This article describes the class I2CE_FormField_MAP_MULT .

Extends the class: I2CE_FormField_MAPPED.
Location: Part of the module Lists in the package I2CE 4.0.12-release
Source: Defined in the file modules/Forms/modules/Lists/lib/I2CE_FormField_MAP_MULT.php on line 28
Author: Luke Duncan <lduncan@intrahealth.org>
Since: v3.2.0

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

Methods

create_DOMEditable_list()

Creates a drop down list of options.

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAP_MULT.php on line 222
Signature: protected function create_DOMEditable_list($node,$template,$form_node,$show_hidden)
Parameters:
- DOMNode $node
  the node we wish to add the drop down list under
- I2CE_Template $template
- $form_node
- boolean $show_hidden
  Show the hidden members of the list, defaults to false.
  - Default Value: false
Returns: mixed
DOMNode or an array of DOMNodes to add.

getComponentizedValue()

Componentizes the given $db_value based on component

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAP_MULT.php on line 76
Signature: public function getComponentizedValue($db_value,$forms,$component)
Parameters:
- string $db_value
  The non-componentized value
- array $forms
  of stirng. The form names which we wish to componentize.
- string $component
  The component we wish to encode
Returns: string
The componentized db_value

getDBValue()

Return the DB value for this form field.

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAP_MULT.php on line 160
Signature: public function getDBValue()
Returns: string

getDefaultDisplayStyle()

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAP_MULT.php on line 99
Signature: public function getDefaultDisplayStyle($type)
Parameters:
- $type

getDisplayValue()

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

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAP_MULT.php on line 202
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
Returns: mixed

getFromDB()

Return the value of this field from the database format for the given type.

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAP_MULT.php on line 115
Signature: public function getFromDB($value)
Parameters:
- mixed $value

getSQLComponentization()

Componentizes the given $db_value based on component

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAP_MULT.php on line 95
Signature: public function getSQLComponentization($db_ref,$forms,$component)
Parameters:
- string $db_ref
  The reference to the data
- array $forms
  of stirng. The form names which we wish to componentize.
- string $component
  The component we wish to encode
Returns: string
The componentized db_value

getSingleValueFromDB()

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAP_MULT.php on line 103
Signature: protected function getSingleValueFromDB($value)
Parameters:
- $value

getValue()

Return the native value for this form field.

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAP_MULT.php on line 149
Signature: public function getValue()
Returns: array

isValid()

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

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAP_MULT.php on line 172
Signature: public function isValid()
Returns: boolean

remapField()

Hooked method to remap a given id on a given form and field @param I2CE_List $lsit

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAP_MULT.php on line 37
Signature: public function remapField($form,$oldid,$newid)
Parameters:
- $form
- string $oldid
- string $newid

setFromPost()

Sets the value of this field from the posted form.

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAP_MULT.php on line 132
Signature: public function setFromPost($post)
Parameters:
- array $post
  The $_POST array holding the values for this form.