Currency Class Reference

Inheritance diagram for Currency:

Public Member Functions
	__construct (\Magento\Framework\Event\ManagerInterface $eventManager, \Magento\Framework\Locale\ResolverInterface $localeResolver, \Magento\Framework\CurrencyFactory $currencyFactory)
	getDefaultCurrency ()
	getCurrency ($currency)

Data Fields
const	DEFAULT_CURRENCY = 'USD'
const	CURRENCY_OPTION_SYMBOL = 'symbol'
const	CURRENCY_OPTION_CURRENCY = 'currency'
const	CURRENCY_OPTION_NAME = 'name'
const	CURRENCY_OPTION_DISPLAY = 'display'

Protected Attributes
	$_eventManager = null
	$_localeResolver
	$_currencyFactory

Static Protected Attributes
static	$_currencyCache = []

Detailed Description

Definition at line 8 of file Currency.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\Event\ManagerInterface	$eventManager,
		\Magento\Framework\Locale\ResolverInterface	$localeResolver,
		\Magento\Framework\CurrencyFactory	$currencyFactory
	)

Parameters

\Magento\Framework\Event\ManagerInterface	$eventManager
ResolverInterface	$localeResolver
\Magento\Framework\CurrencyFactory	$currencyFactory

Definition at line 53 of file Currency.php.

      {
        $this->_eventManager = $eventManager;
        $this->_localeResolver = $localeResolver;
        $this->_currencyFactory = $currencyFactory;
    }

Member Function Documentation

getCurrency()

getCurrency

(

$currency

)

Create Currency object for current locale

Parameters

string

$currency

Returns

\Magento\Framework\Currency

Implements CurrencyInterface.

Definition at line 74 of file Currency.php.

    {
        \Magento\Framework\Profiler::start('locale/currency');
        if (!isset(self::$_currencyCache[$this->_localeResolver->getLocale()][$currency])) {
            $options = [];
            try {
                $currencyObject = $this->_currencyFactory->create(
                    ['options' => $currency, 'locale' => $this->_localeResolver->getLocale()]
                );
            } catch (\Exception $e) {
                $currencyObject = $this->_currencyFactory->create(
                    ['options' => $this->getDefaultCurrency(), 'locale' => $this->_localeResolver->getLocale()]
                );
                $options[self::CURRENCY_OPTION_NAME] = $currency;
                $options[self::CURRENCY_OPTION_CURRENCY] = $currency;
                $options[self::CURRENCY_OPTION_SYMBOL] = $currency;
            }

            $options = new \Magento\Framework\DataObject($options);
            $this->_eventManager->dispatch(
                'currency_display_options_forming',
                ['currency_options' => $options, 'base_code' => $currency]
            );

            $currencyObject->setFormat($options->toArray());
            self::$_currencyCache[$this->_localeResolver->getLocale()][$currency] = $currencyObject;
        }
        \Magento\Framework\Profiler::stop('locale/currency');
        return self::$_currencyCache[$this->_localeResolver->getLocale()][$currency];
    }

getDefaultCurrency()

getDefaultCurrency

(

)

Retrieve default currency code

Returns

string

Implements CurrencyInterface.

Definition at line 66 of file Currency.php.

    {
        return self::DEFAULT_CURRENCY;
    }

Field Documentation

$_currencyCache

$_currencyCache = []

staticprotected

Definition at line 29 of file Currency.php.

$_currencyFactory

$_currencyFactory

protected

Definition at line 46 of file Currency.php.

$_eventManager

$_eventManager = null

protected

Definition at line 36 of file Currency.php.

$_localeResolver

$_localeResolver

protected

Definition at line 41 of file Currency.php.

CURRENCY_OPTION_CURRENCY

const CURRENCY_OPTION_CURRENCY = 'currency'

Definition at line 20 of file Currency.php.

CURRENCY_OPTION_DISPLAY

const CURRENCY_OPTION_DISPLAY = 'display'

Definition at line 24 of file Currency.php.

CURRENCY_OPTION_NAME

const CURRENCY_OPTION_NAME = 'name'

Definition at line 22 of file Currency.php.

CURRENCY_OPTION_SYMBOL

const CURRENCY_OPTION_SYMBOL = 'symbol'

#+ Currency Options

Definition at line 18 of file Currency.php.

DEFAULT_CURRENCY

const DEFAULT_CURRENCY = 'USD'

Default currency

Definition at line 13 of file Currency.php.

---

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

• vendor/magento/framework/Locale/Currency.php