Class: I2CE FormField MAP LINE (4.1.1)

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

This article describes the class I2CE_FormField_MAP_LINE .

Extends the class: I2CE_FormField_MAP.
Location: Part of the module Lists in the package I2CE 4.1.1-release
Source: Defined in the file modules/Forms/modules/Lists/lib/I2CE_FormField_MAP_LINE.php on line 35
Author: Carl Leitner <litlfred@ibiblio.org>
Since: v4.0.8

@filesource Class I2CE_FormField_MAP_LINE

Methods

Creates a drop down list of options.

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAP_LINE.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.

Componentizes the given $db_value based on component

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

Return the DB value for this form field.

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAP_LINE.php on line 99
Signature: public function getDBMAPValue()
Returns: string

get the default display style for the given type of display

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

Get the display format string

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAP_LINE.php on line 194
Signature: public function getDisplayFormatString($type)
Parameters:
- string $type
  Defaults to 'default'
  - Default Value: 'default'
Returns: string

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

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

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_LINE.php on line 85
Signature: public function getFromDB($value)
Parameters:
- mixed $value

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_LINE.php on line 139
Signature: public function getLine()
Returns: string

Componentizes the given $db_value based on component

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

Return the native value for this form field.

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

Checks to see if the value has been set.

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

Sets the value of this field from the posted form.

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