1. interface
  2. Symfony
  3. \
  4. Component
  5. \
  6. Intl
  7. \
  8. ResourceBundle
  9. \
  10. CurrencyBundleInterface

CurrencyBundleInterface

interface CurrencyBundleInterface implements ResourceBundleInterface

Gives access to currency-related ICU data.

Methods

string[]
getLocales()

Returns the list of locales that this bundle supports.

from ResourceBundleInterface
string|null
getCurrencySymbol(string $currency, string $displayLocale = null)

Returns the symbol used for a currency.

string|null
getCurrencyName(string $currency, string $displayLocale = null)

Returns the name of a currency.

string[]
getCurrencyNames(string $displayLocale = null)

Returns the names of all known currencies.

int|null
getFractionDigits(string $currency)

Returns the number of digits after the comma of a currency.

float|int|null
getRoundingIncrement(string $currency)

Returns the rounding increment of a currency.

Details

string[] getLocales()

Returns the list of locales that this bundle supports.

Return Value

string[] A list of locale codes

string|null getCurrencySymbol(string $currency, string $displayLocale = null)

Returns the symbol used for a currency.

Parameters

string $currency A currency code (e.g. "EUR")
string $displayLocale Optional. The locale to return the result in Defaults to {@link \Locale::getDefault()}.

Return Value

string|null The currency symbol or NULL if not found

string|null getCurrencyName(string $currency, string $displayLocale = null)

Returns the name of a currency.

Parameters

string $currency A currency code (e.g. "EUR")
string $displayLocale Optional. The locale to return the name in Defaults to {@link \Locale::getDefault()}.

Return Value

string|null The name of the currency or NULL if not found

string[] getCurrencyNames(string $displayLocale = null)

Returns the names of all known currencies.

Parameters

string $displayLocale Optional. The locale to return the names in Defaults to {@link \Locale::getDefault()}.

Return Value

string[] A list of currency names indexed by currency codes

int|null getFractionDigits(string $currency)

Returns the number of digits after the comma of a currency.

Parameters

string $currency A currency code (e.g. "EUR")

Return Value

int|null The number of digits after the comma or NULL if not found

float|int|null getRoundingIncrement(string $currency)

Returns the rounding increment of a currency.

The rounding increment indicates to which number a currency is rounded. For example, 1230 rounded to the nearest 50 is 1250. 1.234 rounded to the nearest 0.65 is 1.3.

Parameters

string $currency A currency code (e.g. "EUR")

Return Value

float|int|null The rounding increment or NULL if not found