interface Openclerk\Currencies \ Currency

All known implementing classes:
CexGigahash, Bitcoin, Blackcoin, Darkcoin, Digitalcoin, Dogecoin, Feathercoin, Hobonickels, Ixcoin, Litecoin, Megacoin, Namecoin, Netcoin, Novacoin, NuBits, NuShares, Nxt, Peercoin, Primecoin, Reddcoin, Ripple, Storjcoin, Terracoin, Vericoin, Vertcoin, Viacoin, Worldcoin, AustralianDollar, CanadianDollar, DanishKrone, Euro, IndianRupee, IsraeliNewShekel, NewZealandDollar, PolishZloty, PoundSterling, Renminbi, SingaporeDollar, SouthKoreanWon, UnitedStatesDollar, CommodityCurrency, Cryptocurrency, FiatCurrency

A "currency" represents some unit of measurement that can be converted into another "currency" unit, e.g. through an Exchange. Can also cover commodities.

This is the base interface; other interfaces will provide additional functionality as necessary.


Method Summary

Name Description
getAbbr() Get the currency code visible to users, which can be of any length and does not need to be unique (but should be). Often just the uppercase of #getCode().
getCode() Get the unique three-letter currency code for this currency, e.g. 'btc' or 'usd'. Must be lowercase. This is not visible to users.
getName() Get the English name of this currency, e.g. "Bitcoin" or "United States Dollar".
isCommodity()
isCryptocurrency()
isFiat()

public function getAbbr()

Get the currency code visible to users, which can be of any length and does not need to be unique (but should be). Often just the uppercase of #getCode().


public function getCode()

Get the unique three-letter currency code for this currency, e.g. 'btc' or 'usd'. Must be lowercase. This is not visible to users.


public function getName()

Get the English name of this currency, e.g. "Bitcoin" or "United States Dollar".


public function isCommodity()

Returns:
true if this can be considered a "commodity", e.g. "ghs"

public function isCryptocurrency()

Returns:
true if this can be considered a "cryptocurrency", e.g. "btc"

public function isFiat()

Returns:
true if this can be considered a "fiat currency", e.g. "usd"