Class: I2CE FormField MAPPED: Difference between revisions
No edit summary |
No edit summary |
||
| Line 9: | Line 9: | ||
===__call()=== | ===__call()=== | ||
*Signature: public function __call($method,$params) | *Signature: public function __call($method,$params) | ||
Parameters: | *Parameters: | ||
*$method | *$method | ||
*$params | *$params | ||
===_hasMethod()=== | ===_hasMethod()=== | ||
*Signature: public function _hasMethod($method,$getFuzzy,$returnErrors) | *Signature: public function _hasMethod($method,$getFuzzy,$returnErrors) | ||
Parameters: | *Parameters: | ||
*$method | *$method | ||
*$getFuzzy | *$getFuzzy | ||
**Default Value: false | ***Default Value: false | ||
*$returnErrors | *$returnErrors | ||
**Default Value: false | ***Default Value: false | ||
===_processDOMEditable()=== | ===_processDOMEditable()=== | ||
Set up the default editable display for this form field. | Set up the default editable display for this form field. | ||
*Signature: protected function _processDOMEditable($node,$template,$form_node,$display) | *Signature: protected function _processDOMEditable($node,$template,$form_node,$display) | ||
* | *Parameters: | ||
Parameters: | |||
*$node | *$node | ||
*$template | *$template | ||
*$form_node | *$form_node | ||
*$display | *$display | ||
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>of DOMNode | |||
===getComponentizedValue()=== | ===getComponentizedValue()=== | ||
Componentizes the given $db_value based on component | Componentizes the given $db_value based on component | ||
*Signature: abstract public function getComponentizedValue($db_value,$forms,$component) | *Signature: abstract public function getComponentizedValue($db_value,$forms,$component) | ||
* | *Parameters: | ||
** [http://www.php.net/manual/en/language.types.string.php string ] $db_value <br/>The non-componentized value | |||
* [http://www.php.net/manual/en/language.types. | ** [http://www.php.net/manual/en/language.types.array.php array ] $forms <br/>of stirng. The form names which we wish to componentize. | ||
* [http://www.php.net/manual/en/language.types. | ** [http://www.php.net/manual/en/language.types.string.php string ] $component <br/>The component we wish to encode | ||
* [http://www.php.net/manual/en/language.types.string.php string ] | *Returns: [http://www.php.net/manual/en/language.types.string.php string ]<br/>The componentized db_value | ||
===getDefaultDisplayStyle()=== | ===getDefaultDisplayStyle()=== | ||
*Signature: abstract public function getDefaultDisplayStyle($type) | *Signature: abstract public function getDefaultDisplayStyle($type) | ||
Parameters: | *Parameters: | ||
*$type | *$type | ||
===getDisplayedFields()=== | ===getDisplayedFields()=== | ||
*Signature: public function getDisplayedFields($type) | *Signature: public function getDisplayedFields($type) | ||
Parameters: | *Parameters: | ||
*$type | *$type | ||
**Default Value: 'default' | ***Default Value: 'default' | ||
===getDisplayedStyle()=== | ===getDisplayedStyle()=== | ||
*Signature: public function getDisplayedStyle($type) | *Signature: public function getDisplayedStyle($type) | ||
Parameters: | *Parameters: | ||
*$type | *$type | ||
**Default Value: 'default' | ***Default Value: 'default' | ||
===getFormLimits()=== | ===getFormLimits()=== | ||
*Signature: public function getFormLimits($type) | *Signature: public function getFormLimits($type) | ||
Parameters: | *Parameters: | ||
*$type | *$type | ||
**Default Value: 'default' | ***Default Value: 'default' | ||
===getFormOrders()=== | ===getFormOrders()=== | ||
*Signature: public function getFormOrders($type) | *Signature: public function getFormOrders($type) | ||
Parameters: | *Parameters: | ||
*$type | *$type | ||
**Default Value: 'default' | ***Default Value: 'default' | ||
===getMapOptions()=== | ===getMapOptions()=== | ||
*Signature: public function getMapOptions($type) | *Signature: public function getMapOptions($type) | ||
* | *Parameters: | ||
Parameters: | |||
*$type | *$type | ||
**Default Value: 'default' | ***Default Value: 'default' | ||
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>where keys are ids, values are arrays with the following keys 'value', 'display', possibly 'title' | |||
===getSQLComponentization()=== | ===getSQLComponentization()=== | ||
Componentizes the given $db_value based on component | Componentizes the given $db_value based on component | ||
*Signature: abstract public function getSQLComponentization($db_ref,$forms,$component) | *Signature: abstract public function getSQLComponentization($db_ref,$forms,$component) | ||
* | *Parameters: | ||
** [http://www.php.net/manual/en/language.types.string.php string ] $db_ref <br/>The reference to the data | |||
* [http://www.php.net/manual/en/language.types. | ** [http://www.php.net/manual/en/language.types.array.php array ] $forms <br/>of stirng. The form names which we wish to componentize. | ||
* [http://www.php.net/manual/en/language.types. | ** [http://www.php.net/manual/en/language.types.string.php string ] $component <br/>The component we wish to encode | ||
* [http://www.php.net/manual/en/language.types.string.php string ] | *Returns: [http://www.php.net/manual/en/language.types.string.php string ]<br/>The componentized db_value | ||
===getSelectableForms()=== | ===getSelectableForms()=== | ||
*Signature: public function getSelectableForms() | *Signature: public function getSelectableForms() | ||
| Line 80: | Line 80: | ||
Set up the default editable display for this form field. | Set up the default editable display for this form field. | ||
*Signature: public function processDOMEditable($node,$template,$form_node) | *Signature: public function processDOMEditable($node,$template,$form_node) | ||
* | *Parameters: | ||
Parameters: | |||
*$node | *$node | ||
*$template | *$template | ||
*$form_node | *$form_node | ||
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>of DOMNode | |||
===setValueLookup()=== | ===setValueLookup()=== | ||
Sets the value of this mapped field from a lookup value. | 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. | ||
Any linked fields should be known at this point so this should | |||
find the correct value. | |||
*Signature: public function setValueLookup($lookup_value) | *Signature: public function setValueLookup($lookup_value) | ||
* | *Parameters: | ||
** [http://www.php.net/manual/en/language.types.string.php string ] $lookup_value <br/>; | |||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]<br/>Returns true if the value has been set to something | |||
==Inherited Variables== | ==Inherited Variables== | ||
===$name=== | ===$name=== | ||
Revision as of 23:40, 16 October 2009
This article desrcibes the1 class I2CE_FormField_MAPPED.
- Extends the class: I2CE_FormField_DB_STRING.
- 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:
- 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:
- 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
;
- string $lookup_value
- Returns: boolean
Returns true if the value has been set to something
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
$form
Theis protected variable is inherited from I2CE_FormField->$form
$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
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_contains()
This method is inherited from I2CE_FormField_DB_STRING->generateLimit_contains()
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_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()
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()
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()
populateHistory()
This method is inherited from I2CE_FormField->populateHistory()
userMessage()
This method is inherited from I2CE_Fuzzy->userMessage()
