Class: I2CE FormField MAP (4.1.7)

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 (versions) .

This article describes the class I2CE_FormField_MAP .

Extends the class: I2CE_FormField_MAPPED.
Child Classes:
- iHRIS_FormField_CURRENCY
- I2CE_FormField_REMAP
Location: Part of the module Lists in the package I2CE 4.1.7-release
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

_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 489
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
- string $style
  Defaults to 'default'
  - Default Value: 'default'
Returns: mixed

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 313
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 273
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.

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 324
Signature: protected function create_DOMEditable_tree($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.

ensureStyle()

Ensures that the given style has been defined. If so, returns that style, otherwise returns 'default' @param string

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAP.php on line 555
Signature: protected function ensureStyle($style)
Parameters:
- $style

getComponentizedValue()

Componentizes the given $db_value based on component

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

getDisplayNode()

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAP.php on line 93
Signature: public function getDisplayNode($node,$template)
Parameters:
- $node
- $template

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 253
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 133
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 178
Signature: public function getMappedForm()
Returns: string.

getMappedFormObject()

Return the mapped form object.

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAP.php on line 217
Signature: public function getMappedFormObject($populate)
Parameters:
- boolean $populate
  - Default Value: true
Returns: I2CE_Form

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 190
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 76
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 167
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 236
Signature: public function isValid()
Returns: boolean

isValidForm()

Check to see if the given form is a valid form to reference

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAP.php on line 467
Signature: protected function isValidForm($form)
Parameters:
- string $form
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 159
Signature: public function issetValue()
Returns: boolean

processDOMEditable_reportSelect()

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAP.php on line 373
Signature: public function processDOMEditable_reportSelect($node,$template,$form_node)
Parameters:
- DOMNode $node
- I2CE_Template $template
- DOMNode $form_node

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.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.php on line 145
Signature: public function setFromPost($post)
Parameters:
- array $post
  The $_POST array holding the values for this form.