Class: I2CE FormField MAP MULT (Development)

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.
Child Classes:
- I2CE_FormField_MAP_MULTUNION
Location: Part of the module Lists in the package I2CE 4.1-dev
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

checkStyle_ajax_list()

Check to see if the ajax_list style is allowed.

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

createCheckBox()

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAP_MULT.php on line 399
Signature: protected function createCheckBox($template,$node,$data,$selected)
Parameters:
- $template
- $node
- $data
- $selected

createCheckboxTree()

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAP_MULT.php on line 350
Signature: protected function createCheckboxTree($template,$treeNode,$data,$selected)
Parameters:
- $template
- $treeNode
- $data
- $selected

create_DOMEditable_ajax_list()

Creates an ajax set of drop downs that are populated during the page load with web services and as you select each level.

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAP_MULT.php on line 485
Signature: protected function create_DOMEditable_ajax_list($node,$template,$form_node,$show_hidden)
Parameters:
- DOMNode $node
  the node that requested this drop down
- I2CE_Template $template
- $form_node
- int $show_hidden
  0=non-hidden, 1=All, 2=hidden only. Defaults to 0
  - Default Value: 0
Returns: mixed
DOMNode or an array of DOMNodes to add.

create_DOMEditable_checkbox()

Creates a drop down list of options.

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAP_MULT.php on line 274
Signature: protected function create_DOMEditable_checkbox($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
- int $show_hidden
  0=non-hidden, 1=All, 2=hidden only. Defaults to 0
  - Default Value: 0
Returns: mixed
DOMNode or an array of DOMNodes to add.

create_DOMEditable_checkbox_tree()

Creates a drop down list of options.

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAP_MULT.php on line 315
Signature: protected function create_DOMEditable_checkbox_tree($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
- int $show_hidden
  0=non-hidden, 1=All, 2=hidden only. Defaults to 0
  - Default Value: 0
Returns: mixed
DOMNode or an array of DOMNodes to add.

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 435
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
- int $show_hidden
  0=non-hidden, 1=All, 2=hidden only. Defaults to 0
  - Default Value: 0
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 173
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

getDisplayNode()

Return the display value of this form field as a DOM Node.

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAP_MULT.php on line 238
Signature: public function getDisplayNode($node,$template)
Parameters:
- DOMNode $node
- I2CE_Template $template
Returns: DOMNode

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 219
Signature: public function getDisplayValue($entry,$style)
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
- $style
  - Default Value: 'default'
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 119
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 107
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 162
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 189
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 136
Signature: public function setFromPost($post)
Parameters:
- array $post
  The $_POST array holding the values for this form.