Currency.php

Show:

inherited

Classes
- \Zend_Currency

Table of Contents

Zend Framework

LICENSE This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Currency
Version: $Id$

\Zend_Currency
jump to top

Package: Zend_Currency

Class for handling currency notations

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

 
                NO_SYMBOL
                = 1

 
                USE_SYMBOL
                = 2

 
                USE_SHORTNAME
                = 3

 
                USE_NAME
                = 4

 
                STANDARD
                = 8

 
                RIGHT
                = 16

 
                LEFT
                = 32

Properties

array $_options = array('position' => self::STANDARD, 'script' => null, 'format' => null, 'display' => self::NO_SYMBOL, 'precision' => 2, 'name' => null, 'currency' => null, 'symbol' => null, 'locale' => null, 'value' => 0, 'service' => null, 'tag' => 'Zend_Locale')

Options array

The following options are available 'position' => Position for the currency sign 'script' => Script for the output 'format' => Locale for numeric output 'display' => Currency detail to show 'precision' => Precision for the currency 'name' => Name for this currency 'currency' => 3 lettered international abbreviation 'symbol' => Currency symbol 'locale' => Locale for this currency 'value' => Money value 'service' => Exchange service to use

Default value

array('position' => self::STANDARD, 'script' => null, 'format' => null, 'display' => self::NO_SYMBOL, 'precision' => 2, 'name' => null, 'currency' => null, 'symbol' => null, 'locale' => null, 'value' => 0, 'service' => null, 'tag' => 'Zend_Locale')

Details

Type: array
See

Methods

__construct(string | array $options = null, string | \Zend_Locale $locale = null) : void

Creates a currency instance. Every supressed parameter is used from the actual or the given locale.

Parameters

Name	Type	Description
$options	string \| array	OPTIONAL Options array or currency short name when string is given
$locale	string \| \Zend_Locale	OPTIONAL locale name

Throws

Exception	Description
\Zend_Currency_Exception	When currency is invalid

__toString() : string

Returns the currency name

Returns

Type	Description
string

_checkOptions(array $options = array()) : array

Internal method for checking the options array

Parameters

Name	Type	Description
$options	array	Options to check

Returns

Type	Description
array

Throws

Exception	Description
\Zend_Currency_Exception	On unknown position
\Zend_Currency_Exception	On unknown locale
\Zend_Currency_Exception	On unknown display
\Zend_Currency_Exception	On precision not between -1 and 30
\Zend_Currency_Exception	On problem with script conversion
\Zend_Currency_Exception	On unknown options

_checkParams(string $currency = null, string | \Zend_Locale $locale = null) : string

Internal function for checking static given locale parameter

Parameters

Name	Type	Description
$currency	string	(Optional) Currency name
$locale	string \| \Zend_Locale	(Optional) Locale to display informations

Returns

Type	Description
string	The extracted locale representation as string

Throws

Exception	Description
\Zend_Currency_Exception	When locale contains no region

_exchangeCurrency(float | integer | \Zend_Currency $value, string | \Zend_Currency $currency) : \unknown

Internal method which calculates the exchanges currency

Parameters

Name	Type	Description
$value	float \| integer \| \Zend_Currency	Compares the currency with this value
$currency	string \| \Zend_Currency	The currency to compare this value from

Returns

Type	Description
\unknown

_extractPattern(string $pattern, float | integer $value) : string

Internal method to extract the currency pattern when a choice is given based on the given value

Parameters

Name	Type	Description
$pattern	string
$value	float \| integer

Returns

Type	Description
string

add(float | integer | \Zend_Currency $value, string | \Zend_Currency $currency = null) : \Zend_Currency

Adds a currency

Parameters

Name	Type	Description
$value	float \| integer \| \Zend_Currency	Add this value to currency
$currency	string \| \Zend_Currency	The currency to add

Returns

Type	Description
\Zend_Currency

clearCache(string $tag = null) : void

static

Clears all set cache data

Parameters

Name	Type	Description
$tag	string	Tag to clear when the default tag name is not used

compare(float | integer | \Zend_Currency $value, string | \Zend_Currency $currency = null) : \Zend_Currency

Compares two currencies

Parameters

Name	Type	Description
$value	float \| integer \| \Zend_Currency	Compares the currency with this value
$currency	string \| \Zend_Currency	The currency to compare this value from

Returns

Type	Description
\Zend_Currency

div(float | integer | \Zend_Currency $value, string | \Zend_Currency $currency = null) : \Zend_Currency

Divides a currency

Parameters

Name	Type	Description
$value	float \| integer \| \Zend_Currency	Divides this value from currency
$currency	string \| \Zend_Currency	The currency to divide

Returns

Type	Description
\Zend_Currency

equals(float | integer | \Zend_Currency $value, string | \Zend_Currency $currency = null) : boolean

Returns true when the two currencies are equal

Parameters

Name	Type	Description
$value	float \| integer \| \Zend_Currency	Compares the currency with this value
$currency	string \| \Zend_Currency	The currency to compare this value from

Returns

Type	Description
boolean

getCache() : \Zend_Cache_Core

static

Returns the set cache

Returns

Type	Description
\Zend_Cache_Core	The set cache

getCurrencyList(string $region = null) : array

Returns a list of currencies which are used in this region a region name should be 2 charachters only (f.e. EG, DE, US) If no region is given, the actual region is used

Parameters

Name	Type	Description
$region	string	OPTIONAL Region to return the currencies for

Returns

Type	Description
array	List of currencies

getLocale() : string

Returns the actual set locale

Returns

Type	Description
string

getName(string $currency = null, string | \Zend_Locale $locale = null) : string

Returns the actual or details of other currency names

Parameters

Name	Type	Description
$currency	string	(Optional) Currency's short name
$locale	string \| \Zend_Locale	(Optional) The locale

Returns

Type	Description
string

getRegionList(string $currency = null) : array

Returns a list of regions where this currency is or was known

Parameters

Name	Type	Description
$currency	string	OPTIONAL Currency's short name

Returns

Type	Description
array	List of regions

Throws

Exception	Description
\Zend_Currency_Exception	When no currency was defined

getService() : \Zend_Service

Returns the set service class

Returns

Type	Description
\Zend_Service

getShortName(string $currency = null, string | \Zend_Locale $locale = null) : string

Returns the actual or details of other currency shortnames

Parameters

Name	Type	Description
$currency	string	OPTIONAL Currency's name
$locale	string \| \Zend_Locale	OPTIONAL The locale

Returns

Type	Description
string

getSymbol(string $currency = null, string | \Zend_Locale $locale = null) : string

Returns the actual or details of other currency symbols, when no symbol is available it returns the currency shortname (f.e. FIM for Finnian Mark)

Parameters

Name	Type	Description
$currency	string	(Optional) Currency name
$locale	string \| \Zend_Locale	(Optional) Locale to display informations

Returns

Type	Description
string

getValue() : float

Returns the value

Returns

Type	Description
float

hasCache() : boolean

static

Returns true when a cache is set

Returns

Type	Description
boolean

isLess(float | integer | \Zend_Currency $value, string | \Zend_Currency $currency = null) : boolean

Returns true when the currency is less than the given value

Parameters

Name	Type	Description
$value	float \| integer \| \Zend_Currency	Compares the currency with this value
$currency	string \| \Zend_Currency	The currency to compare this value from

Returns

Type	Description
boolean

isMore(float | integer | \Zend_Currency $value, string | \Zend_Currency $currency = null) : boolean

Returns true when the currency is more than the given value

Parameters

Name	Type	Description
$value	float \| integer \| \Zend_Currency	Compares the currency with this value
$currency	string \| \Zend_Currency	The currency to compare this value from

Returns

Type	Description
boolean

mod(float | integer | \Zend_Currency $value, string | \Zend_Currency $currency = null) : \Zend_Currency

Calculates the modulo from a currency

Parameters

Name	Type	Description
$value	float \| integer \| \Zend_Currency	Calculate modulo from this value
$currency	string \| \Zend_Currency	The currency to calculate the modulo

Returns

Type	Description
\Zend_Currency

mul(float | integer | \Zend_Currency $value, string | \Zend_Currency $currency = null) : \Zend_Currency

Multiplies a currency

Parameters

Name	Type	Description
$value	float \| integer \| \Zend_Currency	Multiplies this value from currency
$currency	string \| \Zend_Currency	The currency to multiply

Returns

Type	Description
\Zend_Currency

removeCache() : void

static

Removes any set cache

setCache(\Zend_Cache_Core $cache) : void

static

Sets a cache for Zend_Currency

Parameters

Name	Type	Description
$cache	\Zend_Cache_Core	Cache to set

setFormat(array $options = array()) : \Zend_Currency

Sets the formating options of the localized currency string If no parameter is passed, the standard setting of the actual set locale will be used

Parameters

Name	Type	Description
$options	array	(Optional) Options to set

Returns

Type	Description
\Zend_Currency

setLocale(string | \Zend_Locale $locale = null) : \Zend_Currency

Sets a new locale for data retreivement Example: 'de_XX' will be set to 'de' because 'de_XX' does not exist 'xx_YY' will be set to 'root' because 'xx' does not exist

Parameters

Name	Type	Description
$locale	string \| \Zend_Locale	(Optional) Locale for parsing input

Returns

Type	Description
\Zend_Currency	Provides fluent interface

Throws

Exception	Description
\Zend_Currency_Exception	When the given locale does not exist

setService(string | \Zend_Currency_CurrencyInterface $service) : \Zend_Currency

Sets a new exchange service

Parameters

Name	Type	Description
$service	string \| \Zend_Currency_CurrencyInterface	Service class

Returns

Type	Description
\Zend_Currency

setValue(float | integer | \Zend_Currency $value, string | \Zend_Currency $currency = null) : \Zend_Currency

Adds a currency

Parameters

Name	Type	Description
$value	float \| integer \| \Zend_Currency	Add this value to currency
$currency	string \| \Zend_Currency	The currency to add

Returns

Type	Description
\Zend_Currency

sub(float | integer | \Zend_Currency $value, string | \Zend_Currency $currency = null) : \Zend_Currency

Substracts a currency

Parameters

Name	Type	Description
$value	float \| integer \| \Zend_Currency	Substracts this value from currency
$currency	string \| \Zend_Currency	The currency to substract

Returns

Type	Description
\Zend_Currency

toCurrency(integer | float $value = null, array $options = array()) : string

Returns a localized currency string

Parameters

Name	Type	Description
$value	integer \| float	OPTIONAL Currency value
$options	array	OPTIONAL options to set temporary

Returns

Type	Description
string

Throws

Exception	Description
\Zend_Currency_Exception	When the value is not a number

toString() : string

Returns the actual currency name

Returns

Type	Description
string

Currency.php

\Zend_Currencyjump to top

Constants

Properties

Methods

\Zend_Currency
jump to top