|
|
| (15 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| This article describes the ''abstract'' class ''I2CE_FormField_MAPPED''.
| | #REDIRECT [[Class: I2CE_FormField_MAPPED (4.1.7)]] |
| *Extends the class: [[Class: I2CE_FormField_DB_STRING | I2CE_FormField_DB_STRING]].
| |
| *Parent Classses: [[Class: I2CE_FormField_DB_STRING | I2CE_FormField_DB_STRING]] [[Class: I2CE_FormField | I2CE_FormField]] [[Class: I2CE_Fuzzy | I2CE_Fuzzy]]
| |
| *Child Classes:
| |
| ** [[Class: I2CE_FormField_MAP | I2CE_FormField_MAP]]
| |
| *** [[Class: iHRIS_FormField_CURRENCY | iHRIS_FormField_CURRENCY]]
| |
| ** [[Class: I2CE_FormField_MAP_MULT | I2CE_FormField_MAP_MULT]]
| |
| *Location: Part of the module [[I2CE Module List#Lists|Lists]] in the package [https://launchpad.net/i2ce I2CE]
| |
| *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.0-release/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_FormField_MAPPED.php 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: [http://www.php.net/manual/en/language.types.array.php array ]<br/>of DOMNode
| |
| ===getComponentizedValue()===
| |
| Componentizes the given $db_value based on 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.array.php array ] $forms <br/>of stirng. The form names which we wish to componentize.
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $component <br/>The component we wish to encode
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]<br/>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: [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()===
| |
| Componentizes the given $db_value based on 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.array.php array ] $forms <br/>of stirng. The form names which we wish to componentize.
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $component <br/>The component we wish to encode
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]<br/>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: [http://www.php.net/manual/en/language.types.array.php array ]<br/>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:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $lookup_value
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]<br/>Returns true if the value has been set to something
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
