MC-42486: Region ID and Country ID values and not properly converted in Email templates

devarul · devarul · commit de09ded65973 · 2021-06-07T19:45:06.000+05:30
- Added the dynamic template variables for region and country in order to fetch these variables in email templates.
diff --git a/app/code/Magento/Email/Model/AbstractTemplate.php b/app/code/Magento/Email/Model/AbstractTemplate.php
@@ -15,6 +15,8 @@
 use Magento\Store\Model\ScopeInterface;
 use Magento\Store\Model\Store;
 use Magento\MediaStorage\Helper\File\Storage\Database;
+use \Magento\Directory\Api\CountryInformationAcquirerInterface;
+use \Magento\Directory\Model\RegionFactory;
 
 /**
  * Template model class.
@@ -58,6 +60,16 @@ abstract class AbstractTemplate extends AbstractModel implements TemplateTypesIn
      */
     const XML_PATH_DESIGN_EMAIL_LOGO_HEIGHT = 'design/email/logo_height';
 
+    /**
+     * Email country id
+     */
+    const XML_PATH_GENERAL_STORE_INFORMATION_COUNTRY_ID = 'general/store_information/country_id';
+
+    /**
+     * Email region id
+     */
+    const XML_PATH_GENERAL_STORE_INFORMATION_REGION_ID = 'general/store_information/region_id';
+
     /**
      * Configuration of design package for template
      *
@@ -165,6 +177,16 @@ abstract class AbstractTemplate extends AbstractModel implements TemplateTypesIn
      */
     private $urlModel;
 
+    /**
+     * @var \Magento\Directory\Api\CountryInformationAcquirerInterface
+     */
+    protected $countryInformationAcquirerInterface;
+
+    /**
+     * @var \Magento\Directory\Model\RegionFactory
+     */
+    protected $regionFactory;
+
     /**
      * @var Database
      */
@@ -183,6 +205,8 @@ abstract class AbstractTemplate extends AbstractModel implements TemplateTypesIn
      * @param \Magento\Email\Model\TemplateFactory $templateFactory
      * @param \Magento\Framework\Filter\FilterManager $filterManager
      * @param \Magento\Framework\UrlInterface $urlModel
+     * @param CountryInformationAcquirerInterface $countryInformationAcquirerInterface
+     * @param RegionFactory $regionFactory
      * @param array $data
      * @param Database $fileStorageDatabase
      *
@@ -201,6 +225,8 @@ public function __construct(
         \Magento\Email\Model\TemplateFactory $templateFactory,
         \Magento\Framework\Filter\FilterManager $filterManager,
         \Magento\Framework\UrlInterface $urlModel,
+        CountryInformationAcquirerInterface $countryInformationAcquirerInterface,
+        RegionFactory $regionFactory,
         array $data = [],
         Database $fileStorageDatabase = null
     ) {
@@ -216,6 +242,8 @@ public function __construct(
         $this->templateFactory = $templateFactory;
         $this->filterManager = $filterManager;
         $this->urlModel = $urlModel;
+        $this->countryInformationAcquirerInterface = $countryInformationAcquirerInterface;
+        $this->regionFactory = $regionFactory;
         $this->fileStorageDatabase = $fileStorageDatabase ?:
             \Magento\Framework\App\ObjectManager::getInstance()->get(Database::class);
         parent::__construct($context, $registry, null, null, $data);
@@ -512,6 +540,12 @@ protected function addEmailVariables($variables, $storeId)
                 $store
             );
         }
+        if (!isset($variables['store_country'])) {
+            $variables['store_country'] = $this->getCountryName($store);
+        }
+        if (!isset($variables['store_region'])) {
+            $variables['store_region'] = $this->getRegionName($store);
+        }
         // If template is text mode, don't include styles
         if (!$this->isPlain() && !isset($variables['template_styles'])) {
             $variables['template_styles'] = $this->getTemplateStyles();
@@ -773,4 +807,46 @@ public function getUrl(Store $store, $route = '', $params = [])
         }
         return $url->getUrl($route, $params);
     }
+
+    /**
+     * Get country name for the specified store.
+     *
+     * @param Store $store
+     * @return string
+     */
+    protected function getCountryName($store)
+    {
+        $countryName = '';
+        $store = $this->storeManager->getStore($store);
+        $countryId = $this->scopeConfig->getValue(
+            self::XML_PATH_GENERAL_STORE_INFORMATION_COUNTRY_ID,
+            ScopeInterface::SCOPE_STORE,
+            $store
+        );
+        if($countryId) {
+            $countryName = $this->countryInformationAcquirerInterface->getCountryInfo($countryId)->getFullNameLocale();
+        }
+        return $countryName;
+    }
+
+    /**
+     * Get region name for the specified store.
+     *
+     * @param Store $store
+     * @return string
+     */
+    protected function getRegionName($store)
+    {
+        $regionName = '';
+        $store = $this->storeManager->getStore($store);
+        $regionId = $this->scopeConfig->getValue(
+            self::XML_PATH_GENERAL_STORE_INFORMATION_REGION_ID,
+            ScopeInterface::SCOPE_STORE,
+            $store
+        );
+        if($regionId) {
+            $regionName = $this->regionFactory->create()->load($regionId)->getName();
+        }
+        return $regionName;
+    }
 }
diff --git a/app/code/Magento/Email/Model/BackendTemplate.php b/app/code/Magento/Email/Model/BackendTemplate.php
@@ -35,6 +35,8 @@ class BackendTemplate extends Template
      * @param \Magento\Email\Model\TemplateFactory $templateFactory
      * @param \Magento\Framework\Filter\FilterManager $filterManager
      * @param \Magento\Framework\UrlInterface $urlModel
+     * @param \Magento\Directory\Api\CountryInformationAcquirerInterface $countryInformationAcquirerInterface
+     * @param \Magento\Directory\Model\RegionFactory $regionFactory
      * @param \Magento\Email\Model\Template\FilterFactory $filterFactory
      * @param \Magento\Config\Model\Config\Structure $structure
      * @param array $data
@@ -55,6 +57,8 @@ public function __construct(
         \Magento\Email\Model\TemplateFactory $templateFactory,
         \Magento\Framework\Filter\FilterManager $filterManager,
         \Magento\Framework\UrlInterface $urlModel,
+        \Magento\Directory\Api\CountryInformationAcquirerInterface $countryInformationAcquirerInterface,
+        \Magento\Directory\Model\RegionFactory $regionFactory,
         \Magento\Email\Model\Template\FilterFactory $filterFactory,
         \Magento\Config\Model\Config\Structure $structure,
         array $data = [],
@@ -74,6 +78,8 @@ public function __construct(
             $templateFactory,
             $filterManager,
             $urlModel,
+            $countryInformationAcquirerInterface,
+            $regionFactory,
             $filterFactory,
             $data,
             $serializer
diff --git a/app/code/Magento/Email/Model/Template.php b/app/code/Magento/Email/Model/Template.php
@@ -118,6 +118,8 @@ class Template extends AbstractTemplate implements \Magento\Framework\Mail\Templ
      * @param TemplateFactory $templateFactory
      * @param \Magento\Framework\Filter\FilterManager $filterManager
      * @param \Magento\Framework\UrlInterface $urlModel
+     * @param \Magento\Directory\Api\CountryInformationAcquirerInterface $countryInformationAcquirerInterface
+     * @param \Magento\Directory\Model\RegionFactory $regionFactory
      * @param Template\FilterFactory $filterFactory
      * @param array $data
      * @param \Magento\Framework\Serialize\Serializer\Json|null $serializer
@@ -138,6 +140,8 @@ public function __construct(
         \Magento\Email\Model\TemplateFactory $templateFactory,
         \Magento\Framework\Filter\FilterManager $filterManager,
         \Magento\Framework\UrlInterface $urlModel,
+        \Magento\Directory\Api\CountryInformationAcquirerInterface $countryInformationAcquirerInterface,
+        \Magento\Directory\Model\RegionFactory $regionFactory,
         \Magento\Email\Model\Template\FilterFactory $filterFactory,
         array $data = [],
         \Magento\Framework\Serialize\Serializer\Json $serializer = null
@@ -158,6 +162,8 @@ public function __construct(
             $templateFactory,
             $filterManager,
             $urlModel,
+            $countryInformationAcquirerInterface,
+            $regionFactory,
             $data
         );
     }
diff --git a/app/code/Magento/Email/view/frontend/email/footer.html b/app/code/Magento/Email/view/frontend/email/footer.html
@@ -6,7 +6,9 @@
 -->
 <!--@subject {{trans "Footer"}} @-->
 <!--@vars {
-"var store.frontend_name":"Store Name"
+"var store.frontend_name":"Store Name",
+"var store_country":"Country Name",
+"var store_region":"Region Name"
 } @-->
 
                     <!-- End Content -->
diff --git a/app/code/Magento/Email/view/frontend/email/header.html b/app/code/Magento/Email/view/frontend/email/header.html
@@ -10,7 +10,9 @@
 "var logo_alt":"Email Logo Alt Text",
 "var logo_height":"Email Logo Image Height",
 "var logo_width":"Email Logo Image Width",
-"var template_styles|raw":"Template CSS"
+"var template_styles|raw":"Template CSS",
+"var store_country":"Country Name",
+"var store_region":"Region Name"
 } @-->
 
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
diff --git a/app/design/frontend/Magento/luma/Magento_Email/email/footer.html b/app/design/frontend/Magento/luma/Magento_Email/email/footer.html
@@ -11,7 +11,9 @@
 "var url_customer_service":"Customer Service URL",
 "var store_phone":"Store Phone",
 "var store_hours":"Store Hours",
-"var store.formatted_address|raw":"Store Address"
+"var store.formatted_address|raw":"Store Address",
+"var store_country":"Country Name",
+"var store_region":"Region Name"
 } @-->
 
                     <!-- End Content -->
