Class: iHRIS FormField CURRENCY (4.1.7)

From IHRIS Wiki
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.


This article describes the class iHRIS_FormField_CURRENCY .

@copyright Copyright © 2007, 2008 IntraHealth International, Inc. Class for defining all the database fields used by a object.

Methods

add()

Add the given value to the value of this field.

compare()

Compares this form field agains the given form field.

create_DOMEditable_list()

Creates a drop down list of options.

getComponentizedValue()

Componentizes the given $db_value based on component

getDBValue()

getDefaultDisplayStyle()

Return the default display style for this mapped field.

getDisplayNode()

Return the display value of this form field as a DOM Node.

getDisplayValue()

Returns the value of this field as a human readable format.

  • Defined in common/modules/Currency/lib/iHRIS_FormField_CURRENCY.php on line 187
  • Signature: public function getDisplayValue($entry,$number_format)
  • Parameters:
    • I2CE_Entry $entry
      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
    • boolean $number_format
      If true, call number_format on the returned value.
      • Default Value: false
  • Returns: mixed

getDisplayedFields()

Return the displayed fields for this field. CURRENCY field types can only select the current field.

getDisplayedStyle()

Return the displayed style for the given display type. CURRENCT field can only have one option so ignore anything given.

getFormLimits()

Return the form limits for this field. CURRENCY doesn't support form limits for now.

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.

getSQLComponentization()

Componentizes the given $db_value based on component

getSelectableForms()

Return the selectable forms for this field. CURRENCY field types can only select "currency" forms.

getValue()

isValid()

Checks to see if the current value for this is set and valid.

multiply()

Multiply the value of this field by the given value.

setFromPost()

Sets the value of this field from the posted form.

Inherited Methods

_getDisplayValue()

This public method is inherited from I2CE_FormField_MAP->_getDisplayValue()

checkStyle_tree()

This public method is inherited from I2CE_FormField_MAP->checkStyle_tree()

getMappedForm()

This public method is inherited from I2CE_FormField_MAP->getMappedForm()

getMappedFormObject()

This public method is inherited from I2CE_FormField_MAP->getMappedFormObject()

getMappedID()

This public method is inherited from I2CE_FormField_MAP->getMappedID()

issetValue()

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

processDOMEditable_reportSelect()

This public method is inherited from I2CE_FormField_MAP->processDOMEditable_reportSelect()

remapField()

This public method is inherited from I2CE_FormField_MAP->remapField()

create_DOMEditable_tree()

This protected method is inherited from I2CE_FormField_MAP->create_DOMEditable_tree()

ensureStyle()

This protected method is inherited from I2CE_FormField_MAP->ensureStyle()

getDefaultValue()

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

isValidForm()

This protected method is inherited from I2CE_FormField_MAP->isValidForm()

__call()

This public method is inherited from I2CE_FormField_MAPPED->__call()

_hasMethod()

This public method is inherited from I2CE_FormField_MAPPED->_hasMethod()

canSelectAnyForm()

This public method is inherited from I2CE_FormField_MAPPED->canSelectAnyForm()

getDisplayReport()

This public method is inherited from I2CE_FormField_MAPPED->getDisplayReport()

getFormOrders()

This public method is inherited from I2CE_FormField_MAPPED->getFormOrders()

getMapOptions()

This public method is inherited from I2CE_FormField_MAPPED->getMapOptions()

processDOMEditable()

This public method is inherited from I2CE_FormField_MAPPED->processDOMEditable()

restoreLimits()

This public method is inherited from I2CE_FormField_MAPPED->restoreLimits()

setAlternateLimits()

This public method is inherited from I2CE_FormField_MAPPED->setAlternateLimits()

_processDOMEditable()

This protected method is inherited from I2CE_FormField_MAPPED->_processDOMEditable()

getAdditionalLimits()

This protected method is inherited from I2CE_FormField_MAPPED->getAdditionalLimits()

processHeaderEditable()

This protected method is inherited from I2CE_FormField_MAPPED->processHeaderEditable()

__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()

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()

getDisplays()

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

getElement()

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

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()

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()

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()

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()

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

$alternate_limits

Theis protected variable is inherited from I2CE_FormField_MAPPED->$alternate_limits

$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

Inherited Fuzzy Methods

generateLimit_within()

This method is inherited from I2CE_FormField_MAP->generateLimit_within()

checkLimit_within()

This method is inherited from I2CE_FormField_MAP->checkLimit_within()

checkLimitString_within()

This method is inherited from I2CE_FormField_MAP->checkLimitString_within()

getLimitMenu_within()

This method is inherited from I2CE_FormField_MAP->getLimitMenu_within()

processLimitMenu_within()

This method is inherited from I2CE_FormField_MAP->processLimitMenu_within()

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()