Inheritance diagram for Currency:

Public Member Functions
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Locale\FormatInterface $localeFormat, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Directory\Helper\Data $directoryHelper, \Magento\Directory\Model\Currency\FilterFactory $currencyFilterFactory, \Magento\Framework\Locale\CurrencyInterface $localeCurrency, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[], CurrencyConfig $currencyConfig=null)

	getCode ()

	getCurrencyCode ()

	getRates ()

	setRates (array $rates)

	load ($id, $field=null)

	getRate ($toCurrency)

	getAnyRate ($toCurrency)

	convert ($price, $toCurrency=null)

	getFilter ()

	format ($price, $options=[], $includeContainer=true, $addBrackets=false)

	formatPrecision ( $price, $precision, $options=[], $includeContainer=true, $addBrackets=false)

	formatTxt ($price, $options=[])

	getCurrencySymbol ()

	getOutputFormat ()

	getConfigAllowCurrencies ()

	getConfigDefaultCurrencies ()

	getConfigBaseCurrencies ()

	getCurrencyRates ($currency, $toCurrencies=null)

	saveRates ($rates)

Public Member Functions inherited from AbstractModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	__sleep ()

	__wakeup ()

	setIdFieldName ($name)

	getIdFieldName ()

	getId ()

	setId ($value)

	isDeleted ($isDeleted=null)

	hasDataChanges ()

	setData ($key, $value=null)

	unsetData ($key=null)

	setDataChanges ($value)

	getOrigData ($key=null)

	setOrigData ($key=null, $data=null)

	dataHasChangedFor ($field)

	getResourceName ()

	getResourceCollection ()

	getCollection ()

	load ($modelId, $field=null)

	beforeLoad ($identifier, $field=null)

	afterLoad ()

	isSaveAllowed ()

	setHasDataChanges ($flag)

	save ()

	afterCommitCallback ()

	isObjectNew ($flag=null)

	beforeSave ()

	validateBeforeSave ()

	getCacheTags ()

	cleanModelCache ()

	afterSave ()

	delete ()

	beforeDelete ()

	afterDelete ()

	afterDeleteCommit ()

	getResource ()

	getEntityId ()

	setEntityId ($entityId)

	clearInstance ()

	getStoredData ()

	getEventPrefix ()

Public Member Functions inherited from DataObject
	__construct (array $data=[])

	addData (array $arr)

	setData ($key, $value=null)

	unsetData ($key=null)

	getData ($key='', $index=null)

	getDataByPath ($path)

	getDataByKey ($key)

	setDataUsingMethod ($key, $args=[])

	getDataUsingMethod ($key, $args=null)

	hasData ($key='')

	toArray (array $keys=[])

	convertToArray (array $keys=[])

	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	toJson (array $keys=[])

	convertToJson (array $keys=[])

	toString ($format='')

	__call ($method, $args)

	isEmpty ()

	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')

	debug ($data=null, &$objects=[])

	offsetSet ($offset, $value)

	offsetExists ($offset)

	offsetUnset ($offset)

	offsetGet ($offset)

Data Fields
const	XML_PATH_CURRENCY_ALLOW = 'currency/options/allow'

const	XML_PATH_CURRENCY_DEFAULT = 'currency/options/default'

const	XML_PATH_CURRENCY_BASE = 'currency/options/base'

Protected Member Functions
	_construct ()

Protected Member Functions inherited from AbstractModel
	_construct ()

	_init ($resourceModel)

	_setResourceModel ($resourceName, $collectionName=null)

	_getResource ()

	_getEventData ()

	_beforeLoad ($modelId, $field=null)

	_afterLoad ()

	_hasModelChanged ()

	_getValidatorBeforeSave ()

	_createValidatorBeforeSave ()

	_getValidationRulesBeforeSave ()

	_clearReferences ()

	_clearData ()

Protected Member Functions inherited from DataObject
	_getData ($key)

	_underscore ($name)

Protected Attributes
	$_filter

	$_rates

	$_localeFormat

	$_storeManager

	$_directoryHelper

	$_currencyFilterFactory

	$_localeCurrency

Protected Attributes inherited from AbstractModel
	$_eventPrefix = 'core_abstract'

	$_eventObject = 'object'

	$_idFieldName = 'id'

	$_hasDataChanges = false

	$_origData

	$_isDeleted = false

	$_resource

	$_resourceCollection

	$_resourceName

	$_collectionName

	$_cacheTag = false

	$_dataSaveAllowed = true

	$_isObjectNew = null

	$_validatorBeforeSave = null

	$_eventManager

	$_cacheManager

	$_registry

	$_logger

	$_appState

	$_actionValidator

	$storedData = []

Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Currency model

@api

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since: 100.0.2

Definition at line 21 of file Currency.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\Model\Context	$context,
		\Magento\Framework\Registry	$registry,
		\Magento\Framework\Locale\FormatInterface	$localeFormat,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Directory\Helper\Data	$directoryHelper,
		\Magento\Directory\Model\Currency\FilterFactory	$currencyFilterFactory,
		\Magento\Framework\Locale\CurrencyInterface	$localeCurrency,
		\Magento\Framework\Model\ResourceModel\AbstractResource	$resource = `null`,
		\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection = `null`,
		array	$data = `[]`,
		CurrencyConfig	$currencyConfig = `null`
	)

Parameters

\Magento\Framework\Model\Context	$context
\Magento\Framework\Registry	$registry
\Magento\Framework\Locale\FormatInterface	$localeFormat
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Directory\Helper\Data	$directoryHelper
Currency\FilterFactory	$currencyFilterFactory
\Magento\Framework\Locale\CurrencyInterface	$localeCurrency
\Magento\Framework\Model\ResourceModel\AbstractResource	$resource
\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection
array	$data
CurrencyConfig	$currencyConfig	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 88 of file Currency.php.

       {
         parent::__construct(
             $context,
             $registry,
             $resource,
             $resourceCollection,
             $data
         );
         $this->_localeFormat = $localeFormat;
         $this->_storeManager = $storeManager;
         $this->_directoryHelper = $directoryHelper;
         $this->_currencyFilterFactory = $currencyFilterFactory;
         $this->_localeCurrency = $localeCurrency;
         $this->currencyConfig = $currencyConfig ?: ObjectManager::getInstance()->get(CurrencyConfig::class);
     }

Member Function Documentation

◆ _construct()

_construct ( )

protected

Returns: void

Definition at line 119 of file Currency.php.

     {
         $this->_init(\Magento\Directory\Model\ResourceModel\Currency::class);
     }

◆ convert()

convert	(	$price,
		$toCurrency = `null`
	)

Convert price to currency format

Parameters

float	$price
mixed	$toCurrency

Returns: float

Exceptions

Definition at line 223 of file Currency.php.

     {
         if ($toCurrency === null) {
             return $price;
         } elseif ($rate = $this->getRate($toCurrency)) {
             return (float)$price * (float)$rate;
         }
 
         throw new \Exception(__(
             'Undefined rate from "%1-%2".',
             $this->getCode(),
             $this->getCurrencyCodeFromToCurrency($toCurrency)
         ));
     }

◆ format()

format	(	$price,
		$options = `[]`,
		$includeContainer = `true`,
		$addBrackets = `false`
	)

Format price to currency format

Parameters

float	$price
array	$options
bool	$includeContainer
bool	$addBrackets

Returns: string

Definition at line 278 of file Currency.php.

     {
         return $this->formatPrecision($price, 2, $options, $includeContainer, $addBrackets);
     }

◆ formatPrecision()

formatPrecision	(	$price,
		$precision,
		$options = `[]`,
		$includeContainer = `true`,
		$addBrackets = `false`
	)

Apply currency format to number with specific rounding precision

Parameters

float	$price
int	$precision
array	$options
bool	$includeContainer
bool	$addBrackets

Returns: string

Definition at line 293 of file Currency.php.

       {
         if (!isset($options['precision'])) {
             $options['precision'] = $precision;
         }
         if ($includeContainer) {
             return '<span class="price">' . ($addBrackets ? '[' : '') . $this->formatTxt(
                 $price,
                 $options
             ) . ($addBrackets ? ']' : '') . '</span>';
         }
         return $this->formatTxt($price, $options);
     }

◆ formatTxt()

formatTxt	(	$price,
		$options = `[]`
	)

Parameters

float	$price
array	$options

Returns: string

Fix problem with 12 000 000, 1 200 000

f - the argument is treated as a float, and presented as a floating-point number (locale aware). F - the argument is treated as a float, and presented as a floating-point number (non-locale aware).

Definition at line 317 of file Currency.php.

     {
         if (!is_numeric($price)) {
             $price = $this->_localeFormat->getNumber($price);
         }
         $price = sprintf("%F", $price);
         return $this->_localeCurrency->getCurrency($this->getCode())->toCurrency($price, $options);
     }

◆ getAnyRate()

getAnyRate ( $toCurrency )

Get currency rate (base=>allowed or allowed=>base)

Parameters

mixed $toCurrency

Returns: float

Definition at line 204 of file Currency.php.

     {
         $code = $this->getCurrencyCodeFromToCurrency($toCurrency);
         $rates = $this->getRates();
         if (!isset($rates[$code])) {
             $rates[$code] = $this->_getResource()->getAnyRate($this->getCode(), $toCurrency);
             $this->setRates($rates);
         }
         return $rates[$code];
     }

◆ getCode()

getCode ( )

Get currency code

Returns: string

Definition at line 129 of file Currency.php.

     {
         return $this->_getData('currency_code');
     }

◆ getConfigAllowCurrencies()

getConfigAllowCurrencies ( )

Retrieve allowed currencies according to config

Returns: array

Definition at line 357 of file Currency.php.

     {
         $allowedCurrencies = $this->currencyConfig->getConfigCurrencies(self::XML_PATH_CURRENCY_ALLOW);
         $appBaseCurrencyCode = $this->_directoryHelper->getBaseCurrencyCode();
         if (!in_array($appBaseCurrencyCode, $allowedCurrencies)) {
             $allowedCurrencies[] = $appBaseCurrencyCode;
         }
         foreach ($this->_storeManager->getStores() as $store) {
             $code = $store->getBaseCurrencyCode();
             if (!in_array($code, $allowedCurrencies)) {
                 $allowedCurrencies[] = $code;
             }
         }
 
         return $allowedCurrencies;
     }

◆ getConfigBaseCurrencies()

getConfigBaseCurrencies ( )

Returns: array

Definition at line 387 of file Currency.php.

     {
         return $this->currencyConfig->getConfigCurrencies(self::XML_PATH_CURRENCY_BASE);
     }

◆ getConfigDefaultCurrencies()

getConfigDefaultCurrencies ( )

Retrieve default currencies according to config

Returns: array

Definition at line 379 of file Currency.php.

     {
         return $this->currencyConfig->getConfigCurrencies(self::XML_PATH_CURRENCY_DEFAULT);
     }

◆ getCurrencyCode()

getCurrencyCode ( )

Get currency code

Returns: string

Definition at line 139 of file Currency.php.

     {
         return $this->_getData('currency_code');
     }

◆ getCurrencyRates()

getCurrencyRates	(	$currency,
		$toCurrencies = `null`
	)

Retrieve currency rates to other currencies

Parameters

string	$currency
array \| null	$toCurrencies

Returns: array

Definition at line 399 of file Currency.php.

     {
         if ($currency instanceof \Magento\Directory\Model\Currency) {
             $currency = $currency->getCode();
         }
         $data = $this->_getResource()->getCurrencyRates($currency, $toCurrencies);
         return $data;
     }

◆ getCurrencySymbol()

getCurrencySymbol ( )

Return currency symbol for current locale and currency code

Returns: string

Definition at line 337 of file Currency.php.

     {
         return $this->_localeCurrency->getCurrency($this->getCode())->getSymbol();
     }

◆ getFilter()

getFilter ( )

Get currency filter

Returns: Filter

Definition at line 260 of file Currency.php.

     {
         if (!$this->_filter) {
             $this->_filter = $this->_currencyFilterFactory->create(['code' => $this->getCode()]);
         }
 
         return $this->_filter;
     }

◆ getOutputFormat()

getOutputFormat ( )

Returns: string

Definition at line 345 of file Currency.php.

     {
         $formatted = $this->formatTxt(0);
         $number = $this->formatTxt(0, ['display' => \Magento\Framework\Currency::NO_SYMBOL]);
         return str_replace($this->trimUnicodeDirectionMark($number), '%s', $formatted);
     }

◆ getRate()

getRate ( $toCurrency )

Get currency rate (only base => allowed)

Parameters

mixed $toCurrency

Returns: float

Definition at line 187 of file Currency.php.

     {
         $code = $this->getCurrencyCodeFromToCurrency($toCurrency);
         $rates = $this->getRates();
         if (!isset($rates[$code])) {
             $rates[$code] = $this->_getResource()->getRate($this->getCode(), $toCurrency);
             $this->setRates($rates);
         }
         return $rates[$code];
     }

◆ getRates()

getRates ( )

Currency Rates getter

Returns: array

Definition at line 149 of file Currency.php.

     {
         return $this->_rates;
     }

◆ load()

load	(	$id,
		$field = `null`
	)

Loading currency data

Parameters

string	$id
string	$field

Returns: $this @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 174 of file Currency.php.

     {
         $this->unsRate();
         $this->setData('currency_code', $id);
         return $this;
     }

◆ saveRates()

saveRates ( $rates )

Save currency rates

Parameters

array $rates

Returns: $this

Definition at line 414 of file Currency.php.

     {
         $this->_getResource()->saveRates($rates);
         return $this;
     }

◆ setRates()

setRates ( array $rates )

Currency Rates setter

Parameters

array $rates Currency Rates

Returns: $this

Definition at line 160 of file Currency.php.

     {
         $this->_rates = $rates;
         return $this;
     }

Field Documentation

◆ $_currencyFilterFactory

$_currencyFilterFactory

protected

Definition at line 62 of file Currency.php.

◆ $_directoryHelper

$_directoryHelper

protected

Definition at line 57 of file Currency.php.

◆ $_filter

$_filter

protected

Definition at line 35 of file Currency.php.

◆ $_localeCurrency

$_localeCurrency

protected

Definition at line 67 of file Currency.php.

◆ $_localeFormat

$_localeFormat

protected

Definition at line 47 of file Currency.php.

◆ $_rates

$_rates

protected

Definition at line 42 of file Currency.php.

◆ $_storeManager

$_storeManager

protected

Definition at line 52 of file Currency.php.

◆ XML_PATH_CURRENCY_ALLOW

const XML_PATH_CURRENCY_ALLOW = 'currency/options/allow'

CONFIG path constants

Definition at line 26 of file Currency.php.

◆ XML_PATH_CURRENCY_BASE

const XML_PATH_CURRENCY_BASE = 'currency/options/base'

Definition at line 30 of file Currency.php.

◆ XML_PATH_CURRENCY_DEFAULT

const XML_PATH_CURRENCY_DEFAULT = 'currency/options/default'

Definition at line 28 of file Currency.php.

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

vendor/magento/module-directory/Model/Currency.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _construct()

◆ convert()

◆ format()

◆ formatPrecision()

◆ formatTxt()

◆ getAnyRate()

◆ getCode()

◆ getConfigAllowCurrencies()

◆ getConfigBaseCurrencies()

◆ getConfigDefaultCurrencies()

◆ getCurrencyCode()

◆ getCurrencyRates()

◆ getCurrencySymbol()

◆ getFilter()

◆ getOutputFormat()

◆ getRate()

◆ getRates()

◆ load()

◆ saveRates()

◆ setRates()

Field Documentation

◆ $_currencyFilterFactory

◆ $_directoryHelper

◆ $_filter

◆ $_localeCurrency

◆ $_localeFormat

◆ $_rates

◆ $_storeManager

◆ XML_PATH_CURRENCY_ALLOW

◆ XML_PATH_CURRENCY_BASE

◆ XML_PATH_CURRENCY_DEFAULT