abstract class Openclerk\Currencies \ CommodityCurrency

All implemented interfaces:
Currency, CurrencyInformation
All known direct subclasses:
CexGigahash

Represents a commodity currency.

This is the base interface; other interfaces will provide additional functionality as necessary. (from Currency)


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.
getCommunityLinks() By default, commodity currencies do not have any community links.
getCurrency() Get the Currency for this CurrencyInformation.
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 getCommunityLinks()

By default, commodity currencies do not have any community links.

Returns:
an array of (url => title) community links, or an empty array if there are none

public function getCurrency()

Get the Currency for this CurrencyInformation. (from getCurrency)


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"