PriceCurrency Class Reference

Inheritance diagram for PriceCurrency:

Public Member Functions
	__construct (StoreManagerInterface $storeManager, CurrencyFactory $currencyFactory, Logger $logger)
	convert ($amount, $scope=null, $currency=null)
	convertAndRound ($amount, $scope=null, $currency=null, $precision=self::DEFAULT_PRECISION)
	format ( $amount, $includeContainer=true, $precision=self::DEFAULT_PRECISION, $scope=null, $currency=null)
	convertAndFormat ( $amount, $includeContainer=true, $precision=self::DEFAULT_PRECISION, $scope=null, $currency=null)
	getCurrency ($scope=null, $currency=null)
	getCurrencySymbol ($scope=null, $currency=null)
	round ($price)

Protected Member Functions
	getStore ($scope=null)

Protected Attributes
	$storeManager
	$currencyFactory
	$logger

Additional Inherited Members
Data Fields inherited from PriceCurrencyInterface
const	DEFAULT_PRECISION = 2

Detailed Description

Class PriceCurrency model for convert and format price value

Definition at line 16 of file PriceCurrency.php.

Constructor & Destructor Documentation

__construct()

__construct	(	StoreManagerInterface	$storeManager,
		CurrencyFactory	$currencyFactory,
		Logger	$logger
	)

Parameters

\Magento\Store\Model\StoreManagerInterface	$storeManager
CurrencyFactory	$currencyFactory
Logger	$logger

Definition at line 38 of file PriceCurrency.php.

      {
        $this->storeManager = $storeManager;
        $this->currencyFactory = $currencyFactory;
        $this->logger = $logger;
    }

Member Function Documentation

convert()

convert	(		$amount,
			$scope = null,
			$currency = null
	)

{Convert price value

Parameters

float	$amount
null | string | bool | int | \Magento\Framework\App\ScopeInterface	$scope
\Magento\Framework\Model\AbstractModel | string | null	$currency

Returns

float

}

Implements PriceCurrencyInterface.

Definition at line 51 of file PriceCurrency.php.

    {
        $currentCurrency = $this->getCurrency($scope, $currency);

        return $this->getStore($scope)
            ->getBaseCurrency()
            ->convert($amount, $currentCurrency);
    }

convertAndFormat()

convertAndFormat	(		$amount,
			$includeContainer = true,
			$precision = self::DEFAULT_PRECISION,
			$scope = null,
			$currency = null
	)

{Convert and format price value

Parameters

float	$amount
bool	$includeContainer
int	$precision
null | string | bool | int | \Magento\Framework\App\ScopeInterface	$scope
\Magento\Framework\Model\AbstractModel | string | null	$currency

Returns

string

}

Implements PriceCurrencyInterface.

Definition at line 87 of file PriceCurrency.php.

      {
        $amount = $this->convert($amount, $scope, $currency);

        return $this->format($amount, $includeContainer, $precision, $scope, $currency);
    }

convertAndRound()

convertAndRound	(		$amount,
			$scope = null,
			$currency = null,
			$precision = self::DEFAULT_PRECISION
	)

{Convert and round price value

Parameters

float	$amount
null | string | bool | int | \Magento\Framework\App\ScopeInterface	$scope
\Magento\Framework\Model\AbstractModel | string | null	$currency
int	$precision

Returns

float

}

Implements PriceCurrencyInterface.

Definition at line 63 of file PriceCurrency.php.

    {
        $currentCurrency = $this->getCurrency($scope, $currency);
        $convertedValue = $this->getStore($scope)->getBaseCurrency()->convert($amount, $currentCurrency);
        return round($convertedValue, $precision);
    }

format()

format	(		$amount,
			$includeContainer = true,
			$precision = self::DEFAULT_PRECISION,
			$scope = null,
			$currency = null
	)

{Format price value

Parameters

float	$amount
bool	$includeContainer
int	$precision
null | string | bool | int | \Magento\Framework\App\ScopeInterface	$scope
\Magento\Framework\Model\AbstractModel | string | null	$currency

Returns

float

}

Implements PriceCurrencyInterface.

Definition at line 73 of file PriceCurrency.php.

      {
        return $this->getCurrency($scope, $currency)
            ->formatPrecision($amount, $precision, [], $includeContainer);
    }

getCurrency()

getCurrency	(		$scope = null,
			$currency = null
	)

{Get currency model

Parameters

null | string | bool | int | \Magento\Framework\App\ScopeInterface	$scope
\Magento\Framework\Model\AbstractModel | string | null	$currency

Returns

\Magento\Framework\Model\AbstractModel

}

Implements PriceCurrencyInterface.

Definition at line 102 of file PriceCurrency.php.

    {
        if ($currency instanceof Currency) {
            $currentCurrency = $currency;
        } elseif (is_string($currency)) {
            $currency = $this->currencyFactory->create()
                ->load($currency);
            $baseCurrency = $this->getStore($scope)
                ->getBaseCurrency();
            $currentCurrency = $baseCurrency->getRate($currency) ? $currency : $baseCurrency;
        } else {
            $currentCurrency = $this->getStore($scope)
                ->getCurrentCurrency();
        }

        return $currentCurrency;
    }

getCurrencySymbol()

getCurrencySymbol	(		$scope = null,
			$currency = null
	)

Parameters

null | string | bool | int | \Magento\Framework\App\ScopeInterface	$scope
\Magento\Framework\Model\AbstractModel | string | null	$currency

Returns

string

Implements PriceCurrencyInterface.

Definition at line 125 of file PriceCurrency.php.

    {
        return $this->getCurrency($scope, $currency)->getCurrencySymbol();
    }

getStore()

getStore (   $scope = null )

protected

Get store model

Parameters

null | string | bool | int | ScopeInterface

$scope

Returns

Store

Definition at line 136 of file PriceCurrency.php.

    {
        try {
            if (!$scope instanceof Store) {
                $scope = $this->storeManager->getStore($scope);
            }
        } catch (\Exception $e) {
            $this->logger->critical($e);
            $scope = $this->storeManager->getStore();
        }

        return $scope;
    }

round()

round

(

$price

)

Round price

Parameters

float

$price

Returns

float

Implements PriceCurrencyInterface.

Definition at line 156 of file PriceCurrency.php.

    {
        return round($price, 2);
    }

Field Documentation

$currencyFactory

$currencyFactory

protected

Definition at line 26 of file PriceCurrency.php.

$logger

$logger

protected

Definition at line 31 of file PriceCurrency.php.

$storeManager

$storeManager

protected

Definition at line 21 of file PriceCurrency.php.

---

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

• vendor/magento/module-directory/Model/PriceCurrency.php