CurrencyBundle

class CurrencyBundle extends CurrencyDataProvider implements CurrencyBundleInterface

Default implementation of {@link CurrencyBundleInterface}.

Constants

INDEX_SYMBOL
INDEX_NAME
INDEX_FRACTION_DIGITS
INDEX_ROUNDING_INCREMENT

Methods

	__construct(string $path, BundleEntryReaderInterface $reader, LocaleDataProvider $localeProvider) Creates a new currency bundle.
	getCurrencies()	from CurrencyDataProvider
	getSymbol($currency, $displayLocale = null)	from CurrencyDataProvider
	getName($currency, $displayLocale = null)	from CurrencyDataProvider
	getNames($displayLocale = null)	from CurrencyDataProvider
	getFractionDigits($currency) Data provider for {@link \Symfony\Component\Intl\Currency::getFractionDigits()}.
	getRoundingIncrement($currency) Data provider for {@link \Symfony\Component\Intl\Currency::getRoundingIncrement()}.
	getNumericCode($currency) Data provider for {@link \Symfony\Component\Intl\Currency::getNumericCode()}.	from CurrencyDataProvider
	forNumericCode($numericCode) Data provider for {@link \Symfony\Component\Intl\Currency::forNumericCode()}.	from CurrencyDataProvider
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.
string[]	getLocales() Returns the list of locales that this bundle supports.

Details

__construct(string $path, BundleEntryReaderInterface $reader, LocaleDataProvider $localeProvider)

Creates a new currency bundle.

Parameters

string	$path	The path to the resource bundle.
BundleEntryReaderInterface	$reader	The reader for reading the resource bundle.
LocaleDataProvider	$localeProvider

getCurrencies()

getSymbol($currency, $displayLocale = null)

Parameters

	$currency
	$displayLocale

getName($currency, $displayLocale = null)

Parameters

	$currency
	$displayLocale

getNames($displayLocale = null)

Parameters

$displayLocale

getFractionDigits($currency)

Data provider for {@link \Symfony\Component\Intl\Currency::getFractionDigits()}.

Parameters

$currency

getRoundingIncrement($currency)

Data provider for {@link \Symfony\Component\Intl\Currency::getRoundingIncrement()}.

Parameters

$currency

getNumericCode($currency)

Data provider for {@link \Symfony\Component\Intl\Currency::getNumericCode()}.

Parameters

$currency

forNumericCode($numericCode)

Data provider for {@link \Symfony\Component\Intl\Currency::forNumericCode()}.

Parameters

$numericCode

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.

string[] getLocales()

Returns the list of locales that this bundle supports.

Return Value

string[]

A list of locale codes.

Links:

http://api.symfony.com/master/Symfony/Component/Intl/ResourceBundle/CurrencyBundle.html

doc_Symfony

2016-10-28 06:12:46

Comments