Money\CurrencyPair Class Reference

Inheritance diagram for Money\CurrencyPair:

Public Member Functions
	__construct (Currency $baseCurrency, Currency $counterCurrency, $conversionRatio)
	equals (CurrencyPair $other)
	getBaseCurrency ()
	getConversionRatio ()
	getCounterCurrency ()
	jsonSerialize ()

Static Public Member Functions
static	createFromIso ($iso)

Detailed Description

Currency Pair holding a base, a counter currency and a conversion ratio.

Author

Mathias Verraes

See also

http://en.wikipedia.org/wiki/Currency_pair

Definition at line 12 of file CurrencyPair.php.

Constructor & Destructor Documentation

__construct()

Money\CurrencyPair::__construct	(	Currency	$baseCurrency,
		Currency	$counterCurrency,
			$conversionRatio
	)

Parameters

Currency	$baseCurrency
Currency	$counterCurrency
float	$conversionRatio

Exceptions

Definition at line 49 of file CurrencyPair.php.

Member Function Documentation

createFromIso()

static Money\CurrencyPair::createFromIso (   $iso )

static

Creates a new Currency Pair based on "EUR/USD 1.2500" form representation.

Parameters

string

$iso

String representation of the form "EUR/USD 1.2500"

Returns

CurrencyPair

Exceptions

Definition at line 69 of file CurrencyPair.php.

equals()

Money\CurrencyPair::equals

(

CurrencyPair

$other

)

Checks if an other CurrencyPair has the same parameters as this.

Parameters

CurrencyPair

$other

Returns

bool

Definition at line 126 of file CurrencyPair.php.

getBaseCurrency()

Money\CurrencyPair::getBaseCurrency

(

)

Returns the base currency.

Returns

Currency

Definition at line 104 of file CurrencyPair.php.

getConversionRatio()

Money\CurrencyPair::getConversionRatio

(

)

Returns the conversion ratio.

Returns

float

Definition at line 114 of file CurrencyPair.php.

Referenced by Money\Exchange\IndirectExchange\quote().

getCounterCurrency()

Money\CurrencyPair::getCounterCurrency

(

)

Returns the counter currency.

Returns

Currency

Definition at line 94 of file CurrencyPair.php.

jsonSerialize()

Money\CurrencyPair::jsonSerialize

(

)

{}

Returns

array

Definition at line 140 of file CurrencyPair.php.

---

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

• CurrencyPair.php