Class: I2CE FormField MAP (Development)

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

This article describes the class I2CE_FormField_MAP .

Extends the class: I2CE_FormField_MAPPED.
Child Classes:
- iHRIS_FormField_CURRENCY
Location: Part of the module Lists in the package I2CE 4.0-dev
Source: Defined in the file modules/Forms/modules/Lists/lib/I2CE_FormField_MAP.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_tree()

Check to see if the tree style is allowed.

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAP.php on line 249
Signature: public function checkStyle_tree()
Returns: boolean

create_DOMEditable_list()

Creates a drop down list of options.

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAP.php on line 222
Signature: protected function create_DOMEditable_list($node,$template,$form_node,$fields,$forms,$limits,$orders,$show_hidden)
Parameters:
- DOMNode $node
  the node we wish to add the drop down list under @pararm array $fields
- I2CE_Template $template
- $form_node
- $fields
- array $forms
  The selectable forms for this map. Order does not matter
- array $limits
  An array, indexed by form name, of limiting data
- array $orders
  An array, indexed by form name, of ordering data
- 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.

create_DOMEditable_tree()

Creates a selectable auto-suggest tree view of the options

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAP.php on line 264
Signature: protected function create_DOMEditable_tree($node,$template,$form_node,$fields,$forms,$limits,$orders,$show_hidden)
Parameters:
- DOMNode $node
  the node that requested this drop down @pararm array $fields
- I2CE_Template $template
- $form_node
- $fields
- array $forms
  The selectable forms for this map. Order does not matter
- array $limits
  An array, indexed by form name, of limiting data
- array $orders
  An array, indexed by form name, of ordering data
- 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.php on line 37
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.php on line 175
Signature: public function getDBValue()
Returns: string

getDefaultDisplayStyle()

get the default display style for the given type of display

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

getDefaultValue()

Gets the default value from the field's data

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAP.php on line 80
Signature: protected function getDefaultValue($fieldData)
Parameters:
- array $fieldData
Returns: array
where the first element is boolean (true if the has been a default value set, false otherwise) and the second element is the default value to be set.

getDisplayValue()

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

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAP.php on line 198
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.php on line 104
Signature: public function getFromDB($value)
Parameters:
- mixed $value

getMappedForm()

Get the form that this field maps to

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAP.php on line 149
Signature: public function getMappedForm()
Returns: string.

getMappedID()

Get the id of the form that this field maps to If not set, returns 0.

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAP.php on line 161
Signature: public function getMappedID()
Returns: string

getSQLComponentization()

Componentizes the given $db_value based on component

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAP.php on line 54
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

getValue()

Return the native value for this form field.

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAP.php on line 138
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.php on line 183
Signature: public function isValid()
Returns: boolean

issetValue()

Checks to see if the value has been set.

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAP.php on line 130
Signature: public function issetValue()
Returns: boolean

setFromPost()

Sets the value of this field from the posted form.

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