Class: I2CE FormField MAPPED

This article describes the abstract class I2CE_FormField_MAPPED.

• Extends the class: I2CE_FormField_DB_STRING.
• Parent Classses: I2CE_FormField_DB_STRING I2CE_FormField I2CE_Fuzzy
• Child Classes:
  • I2CE_FormField_MAP
    • iHRIS_FormField_CURRENCY
  • I2CE_FormField_MAP_MULT
• Location: Part of the module Lists in the package I2CE
• Source: Defined in the file modules/Forms/modules/Lists/lib/I2CE_FormField_MAPPED.php
• Author: Carl Leitner <litlfred@ibiblio.org>
• Since: v3.2.69

@filesource Class I2CE_FormField_MAPPED

Methods

__call()

• Signature: public function __call($method,$params)
• Parameters:
  • $method
  • $params

_hasMethod()

• Signature: public function _hasMethod($method,$getFuzzy,$returnErrors)
• Parameters:
  • $method
  • $getFuzzy
    • Default Value: false
  • $returnErrors
    • Default Value: false

_processDOMEditable()

Set up the default editable display for this form field.

• Signature: protected function _processDOMEditable($node,$template,$form_node,$display)
• Parameters:
  • $node
  • $template
  • $form_node
  • $display
• Returns: array
  of DOMNode

getComponentizedValue()

Componentizes the given $db_value based on component

• Signature: abstract 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

getDefaultDisplayStyle()

• Signature: abstract public function getDefaultDisplayStyle($type)
• Parameters:
  • $type

getDisplayedFields()

• Signature: public function getDisplayedFields($type)
• Parameters:
  • $type
    • Default Value: 'default'

getDisplayedStyle()

• Signature: public function getDisplayedStyle($type)
• Parameters:
  • $type
    • Default Value: 'default'

getFormLimits()

• Signature: public function getFormLimits($type)
• Parameters:
  • $type
    • Default Value: 'default'

getFormOrders()

• Signature: public function getFormOrders($type)
• Parameters:
  • $type
    • Default Value: 'default'

getMapOptions()

• Signature: public function getMapOptions($type)
• Parameters:
  • $type
    • Default Value: 'default'
• Returns: array
  where keys are ids, values are arrays with the following keys 'value', 'display', possibly 'title'

getSQLComponentization()

Componentizes the given $db_value based on component

• Signature: abstract 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

getSelectableForms()

• Signature: public function getSelectableForms()

processDOMEditable()

Set up the default editable display for this form field.

• Signature: public function processDOMEditable($node,$template,$form_node)
• Parameters:
  • $node
  • $template
  • $form_node
• Returns: array
  of DOMNode

setValueLookup()

Sets the value of this mapped field from a lookup value. Any linked fields should be known at this point so this should find the correct value.

• Signature: public function setValueLookup($lookup_value)
• Parameters:
  • string $lookup_value
• Returns: boolean
  Returns true if the value has been set to something