Omnipay\Common\Currency Class Reference

Public Member Functions
	getCode ()
	getDecimals ()
	getNumeric ()

Static Public Member Functions
static	all ()
static	find ($code)

Detailed Description

Currency class

This class abstracts certain functionality around currency objects, currency codes and currency numbers relating to global currencies used in the Omnipay system.

Definition at line 15 of file lib/vendor/omnipay/common/src/Omnipay/Common/Currency.php.

Member Function Documentation

all()

static Omnipay\Common\Currency::all ( )

static

Get an array of all supported currencies

Returns

array

Definition at line 82 of file lib/vendor/omnipay/common/src/Omnipay/Common/Currency.php.

Referenced by Omnipay\Common\CurrencyTest\testAll().

find()

static Omnipay\Common\Currency::find (   $code )

static

Find a specific currency

Parameters

string

$code

The three letter currency code

Returns

mixed A Currency object, or null if no currency was found

Definition at line 67 of file lib/vendor/omnipay/common/src/Omnipay/Common/Currency.php.

Referenced by Omnipay\Common\Message\AbstractRequest\getCurrencyDecimalPlaces(), Omnipay\Common\Message\AbstractRequest\getCurrencyNumeric(), Omnipay\Common\CurrencyTest\testFind(), Omnipay\Common\CurrencyTest\testFindLowercase(), and Omnipay\Common\CurrencyTest\testUnknownCurrencyReturnsNull().

getCode()

Omnipay\Common\Currency::getCode

(

)

Get the three letter code for the currency

Returns

string

Definition at line 36 of file lib/vendor/omnipay/common/src/Omnipay/Common/Currency.php.

getDecimals()

Omnipay\Common\Currency::getDecimals

(

)

Get the number of decimal places for this currency

Returns

int

Definition at line 56 of file lib/vendor/omnipay/common/src/Omnipay/Common/Currency.php.

getNumeric()

Omnipay\Common\Currency::getNumeric

(

)

Get the numeric code for this currency

Returns

string

Definition at line 46 of file lib/vendor/omnipay/common/src/Omnipay/Common/Currency.php.

---

The documentation for this class was generated from the following file:

• lib/vendor/omnipay/common/src/Omnipay/Common/Currency.php