Class: iHRIS FormField CURRENCY (4.1.7)

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.

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

This article describes the class iHRIS_FormField_CURRENCY .

Extends the class: I2CE_FormField_MAP.
Location: Part of the module Currency in the package iHRIS Common 4.1.7-release
Source: Defined in the file modules/Currency/lib/iHRIS_FormField_CURRENCY.php on line 31
Author: Luke Duncan <lduncan@intrahealth.org>
Since: v2.0.0

Methods

add()

Add the given value to the value of this field.

Defined in common/modules/Currency/lib/iHRIS_FormField_CURRENCY.php on line 215
Signature: public function add($value)
Parameters:
- $value

compare()

Compares this form field agains the given form field.

Defined in common/modules/Currency/lib/iHRIS_FormField_CURRENCY.php on line 245
Signature: public function compare($db_value)
Parameters:
- mixed $db_value
  Either a DB Value or an I2CE_FormField
Returns: -1,0,1

create_DOMEditable_list()

Creates a drop down list of options.

Defined in common/modules/Currency/lib/iHRIS_FormField_CURRENCY.php on line 282
Signature: protected function create_DOMEditable_list($node,$template,$form_node,$show_hidden)
Parameters:
- DOMNode $node
  the node we wish to add the drop down list under
- I2CE_Template $template
- $form_node
- boolean $show_hidden
  Show the hidden members of the list, defaults to false.
  - Default Value: false
Returns: mixed
DOMNode or an array of DOMNodes to add.

getComponentizedValue()

Componentizes the given $db_value based on component

Defined in common/modules/Currency/lib/iHRIS_FormField_CURRENCY.php on line 41
Signature: 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

getDBValue()

Defined in common/modules/Currency/lib/iHRIS_FormField_CURRENCY.php on line 154
Signature: public function getDBValue()

getDefaultDisplayStyle()

Return the default display style for this mapped field.

Defined in common/modules/Currency/lib/iHRIS_FormField_CURRENCY.php on line 66
Signature: public function getDefaultDisplayStyle($type)
Parameters:
- string $type
Returns: string

getDisplayNode()

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

Defined in common/modules/Currency/lib/iHRIS_FormField_CURRENCY.php on line 171
Signature: public function getDisplayNode($node,$template)
Parameters:
- DOMNode $node
- I2CE_Template $template
Returns: DOMNode

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.

Defined in common/modules/Currency/lib/iHRIS_FormField_CURRENCY.php on line 86
Signature: public function getDisplayedFields($display,$check_forms)
Parameters:
- string $display
  - Default Value: 'default'
- $check_forms
  - Default Value: true
Returns: array

getDisplayedStyle()

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

Defined in common/modules/Currency/lib/iHRIS_FormField_CURRENCY.php on line 76
Signature: public function getDisplayedStyle($display)
Parameters:
- string $display
  - Default Value: 'default'
Returns: string

getFormLimits()

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

Defined in common/modules/Currency/lib/iHRIS_FormField_CURRENCY.php on line 105
Signature: public function getFormLimits($type)
Parameters:
- string $type
  - Default Value: 'default'
Returns: 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.

Defined in common/modules/Currency/lib/iHRIS_FormField_CURRENCY.php on line 115
Signature: public function getFromDB($value)
Parameters:
- mixed $value

getSQLComponentization()

Componentizes the given $db_value based on component

Defined in common/modules/Currency/lib/iHRIS_FormField_CURRENCY.php on line 54
Signature: 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