MAGETWO-32756: [GITHUB] Access to the currency code and symbol from price templates #941

Author: Yu Tang

app/code/Magento/Directory/Model/Currency.php

@@ -311,6 +311,16 @@ public function formatTxt($price, $options = [])
         return $this->_localeCurrency->getCurrency($this->getCode())->toCurrency($price, $options);
     }
 
+    /**
+     * Return currency symbol for current locale and currency code
+     *
+     * @return string
+     */
+    public function getCurrencySymbol()
+    {
+        return $this->_localeCurrency->getCurrency($this->getCode())->getSymbol();
+    }
+
     /**
      * @return string
      */

app/code/Magento/Directory/Model/PriceCurrency.php

@@ -117,6 +117,16 @@ public function getCurrency($scope = null, $currency = null)
         return $currentCurrency;
     }
 
+    /**
+     * @param null|string|bool|int|\Magento\Framework\App\ScopeInterface $scope
+     * @param \Magento\Framework\Model\AbstractModel|string|null $currency
+     * @return string
+     */
+    public function getCurrencySymbol($scope = null, $currency = null)
+    {
+        return $this->getCurrency($scope, $currency)->getCurrencySymbol();
+    }
+
     /**
      * Get store model
      *

app/code/Magento/Directory/Test/Unit/Model/CurrencyTest.php

@@ -0,0 +1,55 @@
+<?php
+/**
+ * Copyright © 2015 Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Directory\Test\Unit\Model;
+
+use Magento\Directory\Model\Currency;
+
+class CurrencyTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @var Currency
+     */
+    protected $currency;
+
+    protected $currencyCode = 'USD';
+
+    /**
+     * @var \Magento\Framework\Locale\CurrencyInterface|\PHPUnit_Framework_MockObject_MockObject
+     */
+    protected $localeCurrencyMock;
+
+    public function setUp()
+    {
+        $this->localeCurrencyMock = $this->getMock('\Magento\Framework\Locale\CurrencyInterface');
+
+        $objectManager = new \Magento\Framework\TestFramework\Unit\Helper\ObjectManager($this);
+        $this->currency = $objectManager->getObject('Magento\Directory\Model\Currency', [
+            'localeCurrency' => $this->localeCurrencyMock,
+            'data' => [
+                'currency_code' => $this->currencyCode,
+            ]
+        ]);
+    }
+
+    public function testGetCurrencySymbol()
+    {
+        $currencySymbol = '$';
+
+        $currencyMock = $this->getMockBuilder('\Magento\Framework\Currency')
+            ->disableOriginalConstructor()
+            ->getMock();
+        $currencyMock->expects($this->once())
+            ->method('getSymbol')
+            ->willReturn($currencySymbol);
+
+        $this->localeCurrencyMock->expects($this->once())
+            ->method('getCurrency')
+            ->with($this->currencyCode)
+            ->willReturn($currencyMock);
+        $this->assertEquals($currencySymbol, $this->currency->getCurrencySymbol());
+    }
+}

app/code/Magento/Directory/Test/Unit/Model/PriceCurrencyTest.php

@@ -168,6 +168,18 @@ public function testConvertAndFormat()
         ));
     }
 
+    public function testGetCurrencySymbol()
+    {
+        $storeId = 2;
+        $currencySymbol = '$';
+
+        $currencyMock = $this->getCurrentCurrencyMock();
+        $currencyMock->expects($this->once())
+            ->method('getCurrencySymbol')
+            ->willReturn($currencySymbol);
+        $this->assertEquals($currencySymbol, $this->priceCurrency->getCurrencySymbol($storeId, $currencyMock));
+    }
+
     protected function getCurrentCurrencyMock()
     {
         $currency = $this->getMockBuilder('Magento\Directory\Model\Currency')

lib/internal/Magento/Framework/Pricing/PriceCurrencyInterface.php

@@ -89,4 +89,11 @@ public function round($price);
      * @return \Magento\Framework\Model\AbstractModel
      */
     public function getCurrency($scope = null, $currency = null);
+
+    /**
+     * @param null|string|bool|int|\Magento\Framework\App\ScopeInterface $scope
+     * @param \Magento\Framework\Model\AbstractModel|string|null $currency
+     * @return string
+     */
+    public function getCurrencySymbol($scope = null, $currency = null);
 }

lib/internal/Magento/Framework/Pricing/Render/Amount.php

@@ -142,6 +142,14 @@ public function getDisplayCurrencyCode()
         return $this->priceCurrency->getCurrency()->getCurrencyCode();
     }
 
+    /**
+     * @return string
+     */
+    public function getDisplayCurrencySymbol()
+    {
+        return $this->priceCurrency->getCurrencySymbol();
+    }
+
     /**
      * @return bool
      */

lib/internal/Magento/Framework/Pricing/Render/AmountRenderInterface.php

@@ -50,6 +50,11 @@ public function getPrice();
      */
     public function getDisplayCurrencyCode();
 
+    /**
+     * @return string
+     */
+    public function getDisplayCurrencySymbol();
+
     /**
      * @return string
      */

lib/internal/Magento/Framework/Pricing/Test/Unit/Render/AmountTest.php

@@ -127,6 +127,15 @@ public function testFormatCurrency()
         $this->assertEquals($result, $this->model->formatCurrency($amount, $includeContainer, $precision));
     }
 
+    public function testGetDisplayCurrencySymbol()
+    {
+        $currencySymbol = '$';
+        $this->priceCurrency->expects($this->once())
+            ->method('getCurrencySymbol')
+            ->willReturn($currencySymbol);
+        $this->assertEquals($currencySymbol, $this->model->getDisplayCurrencySymbol());
+    }
+
     /**
      * Test case for getAdjustmentRenders method through toHtml()
      */