Class: I2CE FormField MAPPED (Development)

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

This article describes the abstract class I2CE_FormField_MAPPED .

• Extends the class: I2CE_FormField_DB_STRING.
• Child Classes:
  • I2CE_FormField_MAP
    • iHRIS_FormField_CURRENCY
    • I2CE_FormField_REMAP
  • I2CE_FormField_MAP_MULT
    • 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_MAPPED.php on line 33
• Author: Carl Leitner <litlfred@ibiblio.org>
• Since: v3.2.69

@filesource Class I2CE_FormField_MAPPED

Variables

$alternate_limits

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAPPED.php on line 163
• Type: protected $alternate_limits

Methods

__call()

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAPPED.php on line 486
• Signature: public function __call($method,$params)
• Parameters:
  • $method
  • $params

_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_MAPPED.php on line 518
• Signature: protected function _create_DOMEditable_ajax_list($node,$template,$form_node,$show_hidden,$multiple)
• 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
  • int $multiple
    set to true if multiple selections are allowed
    • Default Value: false
• Returns: mixed
  DOMNode or an array of DOMNodes to add.

_hasMethod()

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

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAPPED.php on line 402
• Signature: protected function _processDOMEditable($node,$template,$form_node,$display)
• Parameters:
  • $node
  • $template
  • $form_node
  • $display
• Returns: array
  of DOMNode

canSelectAnyForm()

Checks to see if this field can have map to any form or not. Set to true in meta/form_any

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAPPED.php on line 120
• Signature: public function canSelectAnyForm()
• Returns: boolean

getAdditionalLimits()

Gets any additional dynamic limits

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAPPED.php on line 217
• Signature: protected function getAdditionalLimits($template,$node,$limit)
• Parameters:
  • I2CE_Tempalte $template
  • DOMElment $node
  • mixed $limit
    a json encoded string of limit data or an array of limit data
• Returns: array
  who keys are selectable form norms with additional limits and values are the limit data

getComponentizedValue()

Componentizes the given $db_value based on component

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAPPED.php on line 42
• 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()

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAPPED.php on line 54
• Signature: abstract public function getDefaultDisplayStyle($type)
• Parameters:
  • $type

getDisplayReport()

Return a report name to use for getting the display data for this mapped field instead of using the direct data or from cached tables when that may be very slow. This is generally for more complicated displays using a tree view.

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAPPED.php on line 150
• Signature: public function getDisplayReport($type)
• Parameters:
  • string $type
    • Default Value: 'default'
• Returns: string

getDisplayedFields()

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAPPED.php on line 91
• Signature: public function getDisplayedFields($type,$check_forms)
• Parameters:
  • $type
    • Default Value: 'default'
  • $check_forms
    • Default Value: true

getDisplayedStyle()

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAPPED.php on line 76
• Signature: public function getDisplayedStyle($type)
• Parameters:
  • $type
    • Default Value: 'default'

getFormLimits()

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAPPED.php on line 171
• Signature: public function getFormLimits($type)
• Parameters:
  • $type
    • Default Value: 'default'

getFormOrders()

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAPPED.php on line 107
• Signature: public function getFormOrders($type)
• Parameters:
  • $type
    • Default Value: 'default'

getMapOptions()

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAPPED.php on line 301
• Signature: public function getMapOptions($type,$show_hidden,$flat,$add_limits)
• Parameters:
  • $type
    • Default Value: 'default'
  • $show_hidden
    • Default Value: 0
  • $flat
    • Default Value: true
  • $add_limits
    • Default Value: array()
• Returns: array
  where keys are ids, values are arrays with the following keys 'value', 'display'

getSQLComponentization()

Componentizes the given $db_value based on component

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAPPED.php on line 51
• 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()

Checks to see which forms this form can map to.

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAPPED.php on line 129
• Signature: public function getSelectableForms()
• Returns: array()

processDOMEditable()

Set up the default editable display for this form field.

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAPPED.php on line 386
• Signature: public function processDOMEditable($node,$template,$form_node)
• Parameters:
  • $node
  • $template
  • $form_node
• Returns: array
  of DOMNode

processHeaderEditable()

Process the header of an editable node

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAPPED.php on line 343
• Signature: protected function processHeaderEditable($template,$node,$head_node)
• Parameters:
  • I2CE_Template $template
  • DOMNode $node
  • DOMNode $head_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_MAPPED.php on line 66
• Signature: public function remapField($form,$oldid,$newid)
• Parameters:
  • $form
  • string $oldid
  • string $newid

restoreLimits()

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAPPED.php on line 168
• Signature: public function restoreLimits($type)
• Parameters:
  • $type
    • Default Value: 'default'

setAlternateLimits()

• Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_FormField_MAPPED.php on line 165
• Signature: public function setAlternateLimits($limits,$type)
• Parameters:
  • $limits
  • $type
    • Default Value: 'default'

Inherited Methods

isValid()

This public method is inherited from I2CE_FormField_DB_STRING->isValid()

__construct()

This public method is inherited from I2CE_FormField->__construct()

addHistory()

This public method is inherited from I2CE_FormField->addHistory()

cleanup()

This public method is inherited from I2CE_FormField->cleanup()

compare()

This public method is inherited from I2CE_FormField->compare()

compareEntryDate()

This public method is inherited from I2CE_FormField->compareEntryDate()

createField()

This public method is inherited from I2CE_FormField->createField()

firstHistory()

This public method is inherited from I2CE_FormField->firstHistory()

getAttribute()

This public method is inherited from I2CE_FormField->getAttribute()

getContainer()

This public method is inherited from I2CE_FormField->getContainer()

getDBType()

This public method is inherited from I2CE_FormField->getDBType()

getDBValue()

This public method is inherited from I2CE_FormField->getDBValue()

getDisplayNode()

This public method is inherited from I2CE_FormField->getDisplayNode()

getDisplayValue()

This public method is inherited from I2CE_FormField->getDisplayValue()

getDisplays()

This public method is inherited from I2CE_FormField->getDisplays()

getElement()

This public method is inherited from I2CE_FormField->getElement()

getFromDB()

This public method is inherited from I2CE_FormField->getFromDB()

getHTMLName()

This public method is inherited from I2CE_FormField->getHTMLName()

getHeader()

This public method is inherited from I2CE_FormField->getHeader()

getHistory()

This public method is inherited from I2CE_FormField->getHistory()

getHref()

This public method is inherited from I2CE_FormField->getHref()

getInvalid()

This public method is inherited from I2CE_FormField->getInvalid()

getMDB2Type()

This public method is inherited from I2CE_FormField->getMDB2Type()

getName()

This public method is inherited from I2CE_FormField->getName()

getOption()

This public method is inherited from I2CE_FormField->getOption()

getString()

This public method is inherited from I2CE_FormField->getString()

getTypeString()

This public method is inherited from I2CE_FormField->getTypeString()

getValue()

This public method is inherited from I2CE_FormField->getValue()

hasAttribute()

This public method is inherited from I2CE_FormField->hasAttribute()

hasDisplay()

This public method is inherited from I2CE_FormField->hasDisplay()

hasHeader()

This public method is inherited from I2CE_FormField->hasHeader()

hasInvalid()

This public method is inherited from I2CE_FormField->hasInvalid()

hasNextHistory()

This public method is inherited from I2CE_FormField->hasNextHistory()

hasOption()

This public method is inherited from I2CE_FormField->hasOption()

isInDB()

This public method is inherited from I2CE_FormField->isInDB()

isSameValue()

This public method is inherited from I2CE_FormField->isSameValue()

issetValue()

This public method is inherited from I2CE_FormField->issetValue()

nextHistory()

This public method is inherited from I2CE_FormField->nextHistory()

postprocessDOMEditable()

This public method is inherited from I2CE_FormField->postprocessDOMEditable()

processDOM()

This public method is inherited from I2CE_FormField->processDOM()

processDOMNotEditable()

This public method is inherited from I2CE_FormField->processDOMNotEditable()

setAttribute()

This public method is inherited from I2CE_FormField->setAttribute()

setContainer()

This public method is inherited from I2CE_FormField->setContainer()

setDefaultOptions()

This public method is inherited from I2CE_FormField->setDefaultOptions()

setElement()

This public method is inherited from I2CE_FormField->setElement()

setFromDB()

This public method is inherited from I2CE_FormField->setFromDB()

setFromPost()

This public method is inherited from I2CE_FormField->setFromPost()

setHTMLName()

This public method is inherited from I2CE_FormField->setHTMLName()

setHeaders()

This public method is inherited from I2CE_FormField->setHeaders()

setHref()

This public method is inherited from I2CE_FormField->setHref()

setInvalid()

This public method is inherited from I2CE_FormField->setInvalid()

setInvalidMessage()

This public method is inherited from I2CE_FormField->setInvalidMessage()

setOption()

This public method is inherited from I2CE_FormField->setOption()

setValue()

This public method is inherited from I2CE_FormField->setValue()

unsetValue()

This public method is inherited from I2CE_FormField->unsetValue()

displayInvalid()

This protected method is inherited from I2CE_FormField->displayInvalid()

getDefaultValue()

This protected method is inherited from I2CE_FormField->getDefaultValue()

getOptionsByPath()

This protected method is inherited from I2CE_FormField->getOptionsByPath()

optionsHasPath()

This protected method is inherited from I2CE_FormField->optionsHasPath()

withinForm()

This protected method is inherited from I2CE_FormField->withinForm()

Inherited Variables

$name

Theis protected variable is inherited from I2CE_FormField->$name

$options

Theis protected variable is inherited from I2CE_FormField->$options

$value

Theis protected variable is inherited from I2CE_FormField->$value

$headers

Theis protected variable is inherited from I2CE_FormField->$headers

$href

Theis protected variable is inherited from I2CE_FormField->$href

$container

Theis protected variable is inherited from I2CE_FormField->$container

$history

Theis protected variable is inherited from I2CE_FormField->$history

$history_idx

Theis protected variable is inherited from I2CE_FormField->$history_idx

$attributes

Theis protected variable is inherited from I2CE_FormField->$attributes

$invalid

Theis protected variable is inherited from I2CE_FormField->$invalid

$HTMLName

Theis protected variable is inherited from I2CE_FormField->$HTMLName

Inherited Fuzzy Methods

generateLimit_in()

This method is inherited from I2CE_FormField_DB_STRING->generateLimit_in()

generateLimit_equals()

This method is inherited from I2CE_FormField_DB_STRING->generateLimit_equals()

generateLimit_greaterthan()

This method is inherited from I2CE_FormField_DB_STRING->generateLimit_greaterthan()

generateLimit_lessthan()

This method is inherited from I2CE_FormField_DB_STRING->generateLimit_lessthan()

generateLimit_greaterthan_equals()

This method is inherited from I2CE_FormField_DB_STRING->generateLimit_greaterthan_equals()

generateLimit_lessthan_equals()

This method is inherited from I2CE_FormField_DB_STRING->generateLimit_lessthan_equals()

generateLimit_between()

This method is inherited from I2CE_FormField_DB_STRING->generateLimit_between()

generateLimit_like()

This method is inherited from I2CE_FormField_DB_STRING->generateLimit_like()

generateLimit_lowerlike()

This method is inherited from I2CE_FormField_DB_STRING->generateLimit_lowerlike()

generateLimit_lowerequals()

This method is inherited from I2CE_FormField_DB_STRING->generateLimit_lowerequals()

generateLimit_contains()

This method is inherited from I2CE_FormField_DB_STRING->generateLimit_contains()

generateLimit_startswith()

This method is inherited from I2CE_FormField_DB_STRING->generateLimit_startswith()

checkLimit_in()

This method is inherited from I2CE_FormField_DB_STRING->checkLimit_in()

checkLimitString_in()

This method is inherited from I2CE_FormField_DB_STRING->checkLimitString_in()

getLimitMenu_in()

This method is inherited from I2CE_FormField_DB_STRING->getLimitMenu_in()

processLimitMenu_in()

This method is inherited from I2CE_FormField_DB_STRING->processLimitMenu_in()

checkLimit_equals()

This method is inherited from I2CE_FormField_DB_STRING->checkLimit_equals()

checkLimitString_equals()

This method is inherited from I2CE_FormField_DB_STRING->checkLimitString_equals()

getLimitMenu_equals()

This method is inherited from I2CE_FormField_DB_STRING->getLimitMenu_equals()

processLimitMenu_equals()

This method is inherited from I2CE_FormField_DB_STRING->processLimitMenu_equals()

checkLimit_greaterthan()

This method is inherited from I2CE_FormField_DB_STRING->checkLimit_greaterthan()

checkLimitString_greaterthan()

This method is inherited from I2CE_FormField_DB_STRING->checkLimitString_greaterthan()

getLimitMenu_greaterthan()

This method is inherited from I2CE_FormField_DB_STRING->getLimitMenu_greaterthan()

processLimitMenu_greaterthan()

This method is inherited from I2CE_FormField_DB_STRING->processLimitMenu_greaterthan()

checkLimit_lessthan()

This method is inherited from I2CE_FormField_DB_STRING->checkLimit_lessthan()

checkLimitString_lessthan()

This method is inherited from I2CE_FormField_DB_STRING->checkLimitString_lessthan()

getLimitMenu_lessthan()

This method is inherited from I2CE_FormField_DB_STRING->getLimitMenu_lessthan()

processLimitMenu_lessthan()

This method is inherited from I2CE_FormField_DB_STRING->processLimitMenu_lessthan()

checkLimit_greaterthan_equals()

This method is inherited from I2CE_FormField_DB_STRING->checkLimit_greaterthan_equals()

checkLimitString_greaterthan_equals()

This method is inherited from I2CE_FormField_DB_STRING->checkLimitString_greaterthan_equals()

getLimitMenu_greaterthan_equals()

This method is inherited from I2CE_FormField_DB_STRING->getLimitMenu_greaterthan_equals()

processLimitMenu_greaterthan_equals()

This method is inherited from I2CE_FormField_DB_STRING->processLimitMenu_greaterthan_equals()

checkLimit_lessthan_equals()

This method is inherited from I2CE_FormField_DB_STRING->checkLimit_lessthan_equals()

checkLimitString_lessthan_equals()

This method is inherited from I2CE_FormField_DB_STRING->checkLimitString_lessthan_equals()

getLimitMenu_lessthan_equals()

This method is inherited from I2CE_FormField_DB_STRING->getLimitMenu_lessthan_equals()

processLimitMenu_lessthan_equals()

This method is inherited from I2CE_FormField_DB_STRING->processLimitMenu_lessthan_equals()

checkLimit_between()

This method is inherited from I2CE_FormField_DB_STRING->checkLimit_between()

checkLimitString_between()

This method is inherited from I2CE_FormField_DB_STRING->checkLimitString_between()

getLimitMenu_between()

This method is inherited from I2CE_FormField_DB_STRING->getLimitMenu_between()

processLimitMenu_between()

This method is inherited from I2CE_FormField_DB_STRING->processLimitMenu_between()

checkLimit_like()

This method is inherited from I2CE_FormField_DB_STRING->checkLimit_like()

checkLimitString_like()

This method is inherited from I2CE_FormField_DB_STRING->checkLimitString_like()

getLimitMenu_like()

This method is inherited from I2CE_FormField_DB_STRING->getLimitMenu_like()

processLimitMenu_like()

This method is inherited from I2CE_FormField_DB_STRING->processLimitMenu_like()

checkLimit_lowerlike()

This method is inherited from I2CE_FormField_DB_STRING->checkLimit_lowerlike()

checkLimitString_lowerlike()

This method is inherited from I2CE_FormField_DB_STRING->checkLimitString_lowerlike()

getLimitMenu_lowerlike()

This method is inherited from I2CE_FormField_DB_STRING->getLimitMenu_lowerlike()

processLimitMenu_lowerlike()

This method is inherited from I2CE_FormField_DB_STRING->processLimitMenu_lowerlike()

checkLimit_lowerequals()

This method is inherited from I2CE_FormField_DB_STRING->checkLimit_lowerequals()

checkLimitString_lowerequals()

This method is inherited from I2CE_FormField_DB_STRING->checkLimitString_lowerequals()

getLimitMenu_lowerequals()

This method is inherited from I2CE_FormField_DB_STRING->getLimitMenu_lowerequals()

processLimitMenu_lowerequals()

This method is inherited from I2CE_FormField_DB_STRING->processLimitMenu_lowerequals()

checkLimit_contains()

This method is inherited from I2CE_FormField_DB_STRING->checkLimit_contains()

checkLimitString_contains()

This method is inherited from I2CE_FormField_DB_STRING->checkLimitString_contains()

getLimitMenu_contains()

This method is inherited from I2CE_FormField_DB_STRING->getLimitMenu_contains()

processLimitMenu_contains()

This method is inherited from I2CE_FormField_DB_STRING->processLimitMenu_contains()

checkLimit_startswith()

This method is inherited from I2CE_FormField_DB_STRING->checkLimit_startswith()

checkLimitString_startswith()

This method is inherited from I2CE_FormField_DB_STRING->checkLimitString_startswith()

getLimitMenu_startswith()

This method is inherited from I2CE_FormField_DB_STRING->getLimitMenu_startswith()

processLimitMenu_startswith()

This method is inherited from I2CE_FormField_DB_STRING->processLimitMenu_startswith()

cachedTableReference()

This method is inherited from I2CE_FormField->cachedTableReference()

isNumeric()

This method is inherited from I2CE_FormField->isNumeric()

getLimitStyles()

This method is inherited from I2CE_FormField->getLimitStyles()

generateLimit()

This method is inherited from I2CE_FormField->generateLimit()

describeLimit()

This method is inherited from I2CE_FormField->describeLimit()

generateLimit_null()

This method is inherited from I2CE_FormField->generateLimit_null()

generateLimit_not_null()

This method is inherited from I2CE_FormField->generateLimit_not_null()

generateLimit_null_not_null()

This method is inherited from I2CE_FormField->generateLimit_null_not_null()

checkLimit_null()

This method is inherited from I2CE_FormField->checkLimit_null()

checkLimit_not_null()

This method is inherited from I2CE_FormField->checkLimit_not_null()

checkLimit_null_not_null()

This method is inherited from I2CE_FormField->checkLimit_null_not_null()

checkLimitString_null()

This method is inherited from I2CE_FormField->checkLimitString_null()

checkLimitString_not_null()

This method is inherited from I2CE_FormField->checkLimitString_not_null()

checkLimitString_null_not_null()

This method is inherited from I2CE_FormField->checkLimitString_null_not_null()

getLimitMenu_null()

This method is inherited from I2CE_FormField->getLimitMenu_null()

getLimitMenu_not_null()

This method is inherited from I2CE_FormField->getLimitMenu_not_null()

getLimitMenu_null_not_null()

This method is inherited from I2CE_FormField->getLimitMenu_null_not_null()

processLimitMenu_null()

This method is inherited from I2CE_FormField->processLimitMenu_null()

processLimitMenu_not_null()

This method is inherited from I2CE_FormField->processLimitMenu_not_null()

processLimitMenu_null_not_null()

This method is inherited from I2CE_FormField->processLimitMenu_null_not_null()

generateLimit_max_parent()

This method is inherited from I2CE_FormField->generateLimit_max_parent()

generateLimit_min_parent()

This method is inherited from I2CE_FormField->generateLimit_min_parent()

generateLimit_max_parent_form()

This method is inherited from I2CE_FormField->generateLimit_max_parent_form()

generateLimit_min_parent_form()

This method is inherited from I2CE_FormField->generateLimit_min_parent_form()

getLimitMenu_max_parent()

This method is inherited from I2CE_FormField->getLimitMenu_max_parent()

getLimitMenu_min_parent()

This method is inherited from I2CE_FormField->getLimitMenu_min_parent()

getLimitMenu_max_parent_form()

This method is inherited from I2CE_FormField->getLimitMenu_max_parent_form()

getLimitMenu_min_parent_form()

This method is inherited from I2CE_FormField->getLimitMenu_min_parent_form()

processLimitMenu_max_parent()

This method is inherited from I2CE_FormField->processLimitMenu_max_parent()

processLimitMenu_min_parent()

This method is inherited from I2CE_FormField->processLimitMenu_min_parent()

processLimitMenu_max_parent_form()

This method is inherited from I2CE_FormField->processLimitMenu_max_parent_form()

processLimitMenu_min_parent_form()

This method is inherited from I2CE_FormField->processLimitMenu_min_parent_form()

save()

This method is inherited from I2CE_FormField->save()

globalFieldUpdate()

This method is inherited from I2CE_FormField->globalFieldUpdate()

populateHistory()

This method is inherited from I2CE_FormField->populateHistory()

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()

Inherited Fuzzy CLI Methods

cachedTableReference()

This method is inherited from I2CE_FormField->cachedTableReference()