Class: iHRIS FormField CURRENCY: Difference between revisions

From IHRIS Wiki
No edit summary
 
(20 intermediate revisions by the same user not shown)
Line 1: Line 1:
This article desrcibes the class ''iHRIS_FormField_CURRENCY''.
#REDIRECT [[Class: iHRIS_FormField_CURRENCY (4.1.7)]]
*Extends the class: [[Class: I2CE_FormField_MAP | I2CE_FormField_MAP]].
*Location: Part of the module [[iHRIS Module List#Currency|Currency]] in the package [https://launchpad.net/ihris-common iHRIS Common]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0.0-release/annotate/head:/modules/Currency/lib/iHRIS_FormField_CURRENCY.php modules/Currency/lib/iHRIS_FormField_CURRENCY.php]
*Author: Luke Duncan <lduncan@intrahealth.org>
*Since: v2.0.0
@copyright Copyright &copy; 2007, 2008 IntraHealth International, Inc.    Class for defining all the database fields used by a [[Class: I2CE_Form | ]] object.
==Methods==
===add()===
Add the given value to the value of this field.
*Signature: public function add($value)
*Parameters:
**$value
===compare()===
Compares this form field agains the given form field.
*Signature: public function compare($db_value)
*Parameters:
** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $db_value <br/>Either a DB Value or an I2CE_FormField
*Returns: -1,0,1
===create_DOMEditable_list()===
Creates a drop down list of options.
*Signature: protected function create_DOMEditable_list($node,$template,$form_node,$fields,$forms,$limits)
*Parameters:
** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $node <br/>the node we wish to add the drop down list under @pararm array $fields
** [[Class: I2CE_Template | I2CE_Template]] $template
**$form_node
**$fields
** [http://www.php.net/manual/en/language.types.array.php array ] $forms <br/>The selectable forms for this map.  Order does not matter
** [http://www.php.net/manual/en/language.types.array.php array ] $limits <br/>An array, indexed by form name, of limiting data
*Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]<br/>DOMNode or an array of DOMNodes to add.
===getComponentizedValue()===
Componentizes the given $db_value based on component
*Signature: 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
===getDBValue()===
*Signature: public function getDBValue()
===getDefaultDisplayStyle()===
Return the default display style for this mapped field.
*Signature: public function getDefaultDisplayStyle($type)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $type
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
===getDisplayNode()===
Return the display value of this form field as a DOM Node.
*Signature: public function getDisplayNode($node,$template)
*Parameters:
** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $node
** [[Class: I2CE_Template | I2CE_Template]] $template
*Returns: [http://www.php.net/manual/en/class.domnode.php DOMNode ]
===getDisplayValue()===
Returns the value of this field as a human readable format.
*Signature: public function getDisplayValue($entry,$number_format)
*Parameters:
** [[Class: I2CE_Entry | I2CE_Entry]] $entry <br/>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
** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $number_format <br/>If true, call number_format on the returned value.
***Default Value: false
*Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]
===getDisplayedFields()===
Return the displayed fields for this field.  CURRENCY field types can only select the current field.
*Signature: public function getDisplayedFields($display)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $display
***Default Value: 'default'
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]
===getDisplayedStyle()===
Return the displayed style for the given display type. CURRENCT field can only have one option so ignore anything given.
*Signature: public function getDisplayedStyle($display)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $display
***Default Value: 'default'
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
===getFormLimits()===
Return the form limits for this field.  CURRENCY doesn't support form limits for now.
*Signature: public function getFormLimits($type)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $type
***Default Value: 'default'
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
===getFromDB()===
Return the value of this field from the database format for the given type @param integer $type The type of the field to be returned.
*Signature: public function getFromDB($value)
*Parameters:
** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $value
===getSQLComponentization()===
Componentizes the given $db_value based on component
*Signature: 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()===
Return the selectable forms for this field.  CURRENCY field types can only select "currency" forms.
*Signature: public function getSelectableForms()
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]
===getValue()===
*Signature: public function getValue()
===isValid()===
Checks to see if the current value for this is set and valid.
*Signature: public function isValid()
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
===multiply()===
Multiply the value of this field by the given value.
*Signature: public function multiply($value)
*Parameters:
**$value
===setFromPost()===
Sets the value of this field from the posted form.
*Signature: public function setFromPost($post)
*Parameters:
** [http://www.php.net/manual/en/language.types.array.php array ] $post <br/>The $_POST array holding the values for this form.
==Inherited Variables==
===$name===
Theis protected variable is inherited from [[Class: I2CE_FormField#$name | I2CE_FormField->$name]]
 
===$options===
Theis protected variable is inherited from [[Class: I2CE_FormField#$options | I2CE_FormField->$options]]
 
===$value===
Theis protected variable is inherited from [[Class: I2CE_FormField#$value | I2CE_FormField->$value]]
 
===$headers===
Theis protected variable is inherited from [[Class: I2CE_FormField#$headers | I2CE_FormField->$headers]]
 
===$href===
Theis protected variable is inherited from [[Class: I2CE_FormField#$href | I2CE_FormField->$href]]
 
===$form===
Theis protected variable is inherited from [[Class: I2CE_FormField#$form | I2CE_FormField->$form]]
 
===$history===
Theis protected variable is inherited from [[Class: I2CE_FormField#$history | I2CE_FormField->$history]]
 
===$history_idx===
Theis protected variable is inherited from [[Class: I2CE_FormField#$history_idx | I2CE_FormField->$history_idx]]
 
===$attributes===
Theis protected variable is inherited from [[Class: I2CE_FormField#$attributes | I2CE_FormField->$attributes]]
 
===$invalid===
Theis protected variable is inherited from [[Class: I2CE_FormField#$invalid | I2CE_FormField->$invalid]]
==Inherited Fuzzy Methods==
===generateLimit_in()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#generateLimit_in() | I2CE_FormField_DB_STRING->generateLimit_in()]]
 
===generateLimit_equals()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#generateLimit_equals() | I2CE_FormField_DB_STRING->generateLimit_equals()]]
 
===generateLimit_greaterthan()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#generateLimit_greaterthan() | I2CE_FormField_DB_STRING->generateLimit_greaterthan()]]
 
===generateLimit_lessthan()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#generateLimit_lessthan() | I2CE_FormField_DB_STRING->generateLimit_lessthan()]]
 
===generateLimit_greaterthan_equals()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#generateLimit_greaterthan_equals() | I2CE_FormField_DB_STRING->generateLimit_greaterthan_equals()]]
 
===generateLimit_lessthan_equals()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#generateLimit_lessthan_equals() | I2CE_FormField_DB_STRING->generateLimit_lessthan_equals()]]
 
===generateLimit_between()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#generateLimit_between() | I2CE_FormField_DB_STRING->generateLimit_between()]]
 
===generateLimit_like()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#generateLimit_like() | I2CE_FormField_DB_STRING->generateLimit_like()]]
 
===generateLimit_lowerlike()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#generateLimit_lowerlike() | I2CE_FormField_DB_STRING->generateLimit_lowerlike()]]
 
===generateLimit_contains()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#generateLimit_contains() | I2CE_FormField_DB_STRING->generateLimit_contains()]]
 
===checkLimit_in()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#checkLimit_in() | I2CE_FormField_DB_STRING->checkLimit_in()]]
 
===checkLimitString_in()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#checkLimitString_in() | I2CE_FormField_DB_STRING->checkLimitString_in()]]
 
===getLimitMenu_in()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#getLimitMenu_in() | I2CE_FormField_DB_STRING->getLimitMenu_in()]]
 
===processLimitMenu_in()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#processLimitMenu_in() | I2CE_FormField_DB_STRING->processLimitMenu_in()]]
 
===checkLimit_equals()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#checkLimit_equals() | I2CE_FormField_DB_STRING->checkLimit_equals()]]
 
===checkLimitString_equals()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#checkLimitString_equals() | I2CE_FormField_DB_STRING->checkLimitString_equals()]]
 
===getLimitMenu_equals()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#getLimitMenu_equals() | I2CE_FormField_DB_STRING->getLimitMenu_equals()]]
 
===processLimitMenu_equals()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#processLimitMenu_equals() | I2CE_FormField_DB_STRING->processLimitMenu_equals()]]
 
===checkLimit_greaterthan()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#checkLimit_greaterthan() | I2CE_FormField_DB_STRING->checkLimit_greaterthan()]]
 
===checkLimitString_greaterthan()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#checkLimitString_greaterthan() | I2CE_FormField_DB_STRING->checkLimitString_greaterthan()]]
 
===getLimitMenu_greaterthan()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#getLimitMenu_greaterthan() | I2CE_FormField_DB_STRING->getLimitMenu_greaterthan()]]
 
===processLimitMenu_greaterthan()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#processLimitMenu_greaterthan() | I2CE_FormField_DB_STRING->processLimitMenu_greaterthan()]]
 
===checkLimit_lessthan()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#checkLimit_lessthan() | I2CE_FormField_DB_STRING->checkLimit_lessthan()]]
 
===checkLimitString_lessthan()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#checkLimitString_lessthan() | I2CE_FormField_DB_STRING->checkLimitString_lessthan()]]
 
===getLimitMenu_lessthan()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#getLimitMenu_lessthan() | I2CE_FormField_DB_STRING->getLimitMenu_lessthan()]]
 
===processLimitMenu_lessthan()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#processLimitMenu_lessthan() | I2CE_FormField_DB_STRING->processLimitMenu_lessthan()]]
 
===checkLimit_greaterthan_equals()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#checkLimit_greaterthan_equals() | I2CE_FormField_DB_STRING->checkLimit_greaterthan_equals()]]
 
===checkLimitString_greaterthan_equals()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#checkLimitString_greaterthan_equals() | I2CE_FormField_DB_STRING->checkLimitString_greaterthan_equals()]]
 
===getLimitMenu_greaterthan_equals()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#getLimitMenu_greaterthan_equals() | I2CE_FormField_DB_STRING->getLimitMenu_greaterthan_equals()]]
 
===processLimitMenu_greaterthan_equals()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#processLimitMenu_greaterthan_equals() | I2CE_FormField_DB_STRING->processLimitMenu_greaterthan_equals()]]
 
===checkLimit_lessthan_equals()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#checkLimit_lessthan_equals() | I2CE_FormField_DB_STRING->checkLimit_lessthan_equals()]]
 
===checkLimitString_lessthan_equals()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#checkLimitString_lessthan_equals() | I2CE_FormField_DB_STRING->checkLimitString_lessthan_equals()]]
 
===getLimitMenu_lessthan_equals()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#getLimitMenu_lessthan_equals() | I2CE_FormField_DB_STRING->getLimitMenu_lessthan_equals()]]
 
===processLimitMenu_lessthan_equals()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#processLimitMenu_lessthan_equals() | I2CE_FormField_DB_STRING->processLimitMenu_lessthan_equals()]]
 
===checkLimit_between()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#checkLimit_between() | I2CE_FormField_DB_STRING->checkLimit_between()]]
 
===checkLimitString_between()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#checkLimitString_between() | I2CE_FormField_DB_STRING->checkLimitString_between()]]
 
===getLimitMenu_between()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#getLimitMenu_between() | I2CE_FormField_DB_STRING->getLimitMenu_between()]]
 
===processLimitMenu_between()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#processLimitMenu_between() | I2CE_FormField_DB_STRING->processLimitMenu_between()]]
 
===checkLimit_like()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#checkLimit_like() | I2CE_FormField_DB_STRING->checkLimit_like()]]
 
===checkLimitString_like()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#checkLimitString_like() | I2CE_FormField_DB_STRING->checkLimitString_like()]]
 
===getLimitMenu_like()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#getLimitMenu_like() | I2CE_FormField_DB_STRING->getLimitMenu_like()]]
 
===processLimitMenu_like()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#processLimitMenu_like() | I2CE_FormField_DB_STRING->processLimitMenu_like()]]
 
===checkLimit_lowerlike()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#checkLimit_lowerlike() | I2CE_FormField_DB_STRING->checkLimit_lowerlike()]]
 
===checkLimitString_lowerlike()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#checkLimitString_lowerlike() | I2CE_FormField_DB_STRING->checkLimitString_lowerlike()]]
 
===getLimitMenu_lowerlike()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#getLimitMenu_lowerlike() | I2CE_FormField_DB_STRING->getLimitMenu_lowerlike()]]
 
===processLimitMenu_lowerlike()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#processLimitMenu_lowerlike() | I2CE_FormField_DB_STRING->processLimitMenu_lowerlike()]]
 
===checkLimit_contains()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#checkLimit_contains() | I2CE_FormField_DB_STRING->checkLimit_contains()]]
 
===checkLimitString_contains()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#checkLimitString_contains() | I2CE_FormField_DB_STRING->checkLimitString_contains()]]
 
===getLimitMenu_contains()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#getLimitMenu_contains() | I2CE_FormField_DB_STRING->getLimitMenu_contains()]]
 
===processLimitMenu_contains()===
This method is inherited from [[Class: I2CE_FormField_DB_STRING#processLimitMenu_contains() | I2CE_FormField_DB_STRING->processLimitMenu_contains()]]
 
===cachedTableReference()===
This method is inherited from [[Class: I2CE_FormField#cachedTableReference() | I2CE_FormField->cachedTableReference()]]
 
===isNumeric()===
This method is inherited from [[Class: I2CE_FormField#isNumeric() | I2CE_FormField->isNumeric()]]
 
===getLimitStyles()===
This method is inherited from [[Class: I2CE_FormField#getLimitStyles() | I2CE_FormField->getLimitStyles()]]
 
===generateLimit()===
This method is inherited from [[Class: I2CE_FormField#generateLimit() | I2CE_FormField->generateLimit()]]
 
===generateLimit_null()===
This method is inherited from [[Class: I2CE_FormField#generateLimit_null() | I2CE_FormField->generateLimit_null()]]
 
===generateLimit_not_null()===
This method is inherited from [[Class: I2CE_FormField#generateLimit_not_null() | I2CE_FormField->generateLimit_not_null()]]
 
===generateLimit_null_not_null()===
This method is inherited from [[Class: I2CE_FormField#generateLimit_null_not_null() | I2CE_FormField->generateLimit_null_not_null()]]
 
===checkLimit_null()===
This method is inherited from [[Class: I2CE_FormField#checkLimit_null() | I2CE_FormField->checkLimit_null()]]
 
===checkLimit_not_null()===
This method is inherited from [[Class: I2CE_FormField#checkLimit_not_null() | I2CE_FormField->checkLimit_not_null()]]
 
===checkLimit_null_not_null()===
This method is inherited from [[Class: I2CE_FormField#checkLimit_null_not_null() | I2CE_FormField->checkLimit_null_not_null()]]
 
===checkLimitString_null()===
This method is inherited from [[Class: I2CE_FormField#checkLimitString_null() | I2CE_FormField->checkLimitString_null()]]
 
===checkLimitString_not_null()===
This method is inherited from [[Class: I2CE_FormField#checkLimitString_not_null() | I2CE_FormField->checkLimitString_not_null()]]
 
===checkLimitString_null_not_null()===
This method is inherited from [[Class: I2CE_FormField#checkLimitString_null_not_null() | I2CE_FormField->checkLimitString_null_not_null()]]
 
===getLimitMenu_null()===
This method is inherited from [[Class: I2CE_FormField#getLimitMenu_null() | I2CE_FormField->getLimitMenu_null()]]
 
===getLimitMenu_not_null()===
This method is inherited from [[Class: I2CE_FormField#getLimitMenu_not_null() | I2CE_FormField->getLimitMenu_not_null()]]
 
===getLimitMenu_null_not_null()===
This method is inherited from [[Class: I2CE_FormField#getLimitMenu_null_not_null() | I2CE_FormField->getLimitMenu_null_not_null()]]
 
===processLimitMenu_null()===
This method is inherited from [[Class: I2CE_FormField#processLimitMenu_null() | I2CE_FormField->processLimitMenu_null()]]
 
===processLimitMenu_not_null()===
This method is inherited from [[Class: I2CE_FormField#processLimitMenu_not_null() | I2CE_FormField->processLimitMenu_not_null()]]
 
===processLimitMenu_null_not_null()===
This method is inherited from [[Class: I2CE_FormField#processLimitMenu_null_not_null() | I2CE_FormField->processLimitMenu_null_not_null()]]
 
===generateLimit_max_parent()===
This method is inherited from [[Class: I2CE_FormField#generateLimit_max_parent() | I2CE_FormField->generateLimit_max_parent()]]
 
===generateLimit_min_parent()===
This method is inherited from [[Class: I2CE_FormField#generateLimit_min_parent() | I2CE_FormField->generateLimit_min_parent()]]
 
===generateLimit_max_parent_form()===
This method is inherited from [[Class: I2CE_FormField#generateLimit_max_parent_form() | I2CE_FormField->generateLimit_max_parent_form()]]
 
===generateLimit_min_parent_form()===
This method is inherited from [[Class: I2CE_FormField#generateLimit_min_parent_form() | I2CE_FormField->generateLimit_min_parent_form()]]
 
===getLimitMenu_max_parent()===
This method is inherited from [[Class: I2CE_FormField#getLimitMenu_max_parent() | I2CE_FormField->getLimitMenu_max_parent()]]
 
===getLimitMenu_min_parent()===
This method is inherited from [[Class: I2CE_FormField#getLimitMenu_min_parent() | I2CE_FormField->getLimitMenu_min_parent()]]
 
===getLimitMenu_max_parent_form()===
This method is inherited from [[Class: I2CE_FormField#getLimitMenu_max_parent_form() | I2CE_FormField->getLimitMenu_max_parent_form()]]
 
===getLimitMenu_min_parent_form()===
This method is inherited from [[Class: I2CE_FormField#getLimitMenu_min_parent_form() | I2CE_FormField->getLimitMenu_min_parent_form()]]
 
===processLimitMenu_max_parent()===
This method is inherited from [[Class: I2CE_FormField#processLimitMenu_max_parent() | I2CE_FormField->processLimitMenu_max_parent()]]
 
===processLimitMenu_min_parent()===
This method is inherited from [[Class: I2CE_FormField#processLimitMenu_min_parent() | I2CE_FormField->processLimitMenu_min_parent()]]
 
===processLimitMenu_max_parent_form()===
This method is inherited from [[Class: I2CE_FormField#processLimitMenu_max_parent_form() | I2CE_FormField->processLimitMenu_max_parent_form()]]
 
===processLimitMenu_min_parent_form()===
This method is inherited from [[Class: I2CE_FormField#processLimitMenu_min_parent_form() | I2CE_FormField->processLimitMenu_min_parent_form()]]
 
===save()===
This method is inherited from [[Class: I2CE_FormField#save() | I2CE_FormField->save()]]
 
===populateHistory()===
This method is inherited from [[Class: I2CE_FormField#populateHistory() | I2CE_FormField->populateHistory()]]
 
===userMessage()===
This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]]
 
 
[[Category:Class Documentation]]

Latest revision as of 08:56, 23 August 2013