Class CurrencyFormat
Currency Format Helper
Provides conversion routines to and from currency strings and float values.
Uses Blesta's Currencies model which provides automatic caching for increased
performance.
Methods summary
public
|
#
__construct( integer $company_id = null )
Construct a new CurrencyFormat object
Construct a new CurrencyFormat object
Parameters
- $company_id
- The ID of the company to work off of
See
|
public
integer
|
#
setCompany( integer $company_id )
Set the company ID to work off of
Set the company ID to work off of
Parameters
- $company_id
- The ID of the company to work off of
Returns
integer
Returns the ID of the previously set company ID (null of none set)
|
public
string
|
#
format( float $value, string $currency, array $options = null )
Formats the float value into a currency string. Conversions are cached
to provide increased performance. To clear cache see CurrencyFormat::clear()
Formats the float value into a currency string. Conversions are cached
to provide increased performance. To clear cache see CurrencyFormat::clear()
Parameters
- $value
- The decimal value to convert
- $currency
- The ISO 4217 currency code format to apply to $value
- $options
An array of options to control the format (optional), if not set
the options are pulled from the company settings. Options include:
- prefix Whether or not to include the prefix symbol (if one exists) true/false default true
- suffix Whether or not to include the suffix symbold (if one exists) true/false default true
- code Whether or not to include the currency code in the
result (if one exists) true/false default company setting
- with_separator Whether or not to include the separator (, or sometimes . or space) in the
result true/false default true
- html_code Whether or not to wrap the currency code with HTML true/false (default false).
If true, will produce currency code like USD
- decimals The number of decimal places (precision) (optional, default null to use the currency's
defined precision)
Returns
string
The formatted value
See
|
public
string
|
#
cast( string $value, string $currency, integer $decimals = null )
Casts the currency string into a float value. Conversions are cached to
provide increased performance. To clear cache see CurrencyFormat::clear()
Casts the currency string into a float value. Conversions are cached to
provide increased performance. To clear cache see CurrencyFormat::clear()
Parameters
- $value
- A currency value
- $currency
- The ISO 4217 currency code format representing $value
- $decimals
The number of decimal places (precision) (optional, default null to use the currency's
defined precision) Returns
string
The value in decimal format based on ISO 31-0
See
|
public
|
#
truncateDecimal( string $value, integer $min, char $decimal_char = '.' )
Removes trailing zeros from a string preserving $min decimal places
Removes trailing zeros from a string preserving $min decimal places
Parameters
- $value
- The decimal value in string format
- $min
- The minimum number of decimal places
- $decimal_char
- The character used in $value for decimal representation
Retrun
string The format decimal value with trailing zeros removed up to the $min value
|
public
|
#
clear( )
Clears the currency format cache. Useful if you made modifications to the
currency settings and need to continue conversion using those new
settings.
Clears the currency format cache. Useful if you made modifications to the
currency settings and need to continue conversion using those new
settings.
|