eZCurrency Class Reference
[Locale system]
Locale aware currency class.
More...
List of all members.
Detailed Description
Locale aware currency class.
eZCurrency handles currency values and allows for easy output with toString() and conversion with adjustValue().
A new instance of eZCurrency will automaticly use the current locale, if you however want a different locale use the setLocale() function. The current locale can be fetched with locale().
Change the currency value with setValue() or convert it to a new currency type with adjustValue() and setLocale(). If you want more detiled information on the currency use type(), name() and shortName().
Text output is done with toString() which returns a representation according to the current locale.
- See also:
-
eZLocale
Definition at line ezcurrency.php.
Constructor & Destructor Documentation
| eZCurrency::eZCurrency |
( |
$ |
value |
) |
|
|
|
|
Creates a new eZCurrency object with the currency value $value. $value can be a numerical value or an eZCurrency object in which case the value is extracted and copied.
Definition at line ezcurrency.php.
References value(). |
Member Function Documentation
| eZCurrency::adjustValue |
( |
$ |
old_scale, |
|
|
$ |
new_scale |
|
) |
|
|
|
|
Adjust the value so that it can be represented in a different currency. The $old_scale is a float value which represents the current currency rate while $new_scale represents the new currency rate. All rates should be calculated from the dollar which then gets the rate 1.0.
Definition at line ezcurrency.php.
References Value. |
|
|
Returns the name of the currency, for instance Norwegian Kroner or US dollar.
Definition at line ezcurrency.php.
References Locale. |
| eZCurrency::setLocale |
( |
&$ |
locale |
) |
|
|
|
|
Sets the locale to $locale which is used in text output.
Definition at line ezcurrency.php.
References locale(). |
| eZCurrency::setValue |
( |
$ |
value |
) |
|
|
| eZCurrency::shortName |
( |
|
) |
|
|
|
|
Returns a 3 letter name for the currency, for instance NOK or USD.
Definition at line ezcurrency.php.
References Locale. |
|
|
Returns the currency symbol, for instance kr for NOK or $ for USD.
Definition at line ezcurrency.php.
References Locale. |
| & eZCurrency::toString |
( |
|
) |
|
|
|
|
Returns a text representation of the currency according to the current locale.
Definition at line ezcurrency.php.
References Locale. |
The documentation for this class was generated from the following file:
| 
