MAGETWO-56941: [Github] Allowed countries for customer address in admin using storeview configuration #2946

Author: Sergii Kovalenko

app/code/Magento/Customer/Model/Customer/DataProvider.php

@@ -61,7 +61,7 @@ class DataProvider extends \Magento\Ui\DataProvider\AbstractDataProvider
     /**
      * @var CountryWithWebsites
      */
-    private $countryByWebsiteSource;
+    private $countryWithWebsiteSource;
 
     /**
      * @var \Magento\Customer\Model\Config\Share
@@ -321,7 +321,7 @@ protected function getAttributesMeta(Type $entityType)
 
             if ($attribute->usesSource()) {
                 if ($code == AddressInterface::COUNTRY_ID) {
-                    $meta[$code]['arguments']['data']['config']['options'] = $this->getCountryByWebsiteSource()
+                    $meta[$code]['arguments']['data']['config']['options'] = $this->getcountryWithWebsiteSource()
                         ->getAllOptions();
                 } else {
                     $meta[$code]['arguments']['data']['config']['options'] = $attribute->getSource()->getAllOptions();
@@ -342,19 +342,23 @@ protected function getAttributesMeta(Type $entityType)
     }
 
     /**
+     * Retrieve Country With Websites Source
+     *
      * @deprecated
      * @return CountryWithWebsites
      */
-    private function getCountryByWebsiteSource()
+    private function getCountryWithWebsiteSource()
     {
-        if (!$this->countryByWebsiteSource) {
-            $this->countryByWebsiteSource = ObjectManager::getInstance()->get(CountryWithWebsites::class);
+        if (!$this->countryWithWebsiteSource) {
+            $this->countryWithWebsiteSource = ObjectManager::getInstance()->get(CountryWithWebsites::class);
         }
 
-        return $this->countryByWebsiteSource;
+        return $this->countryWithWebsiteSource;
     }
 
     /**
+     * Retrieve Customer Config Share
+     *
      * @deprecated
      * @return \Magento\Customer\Model\Config\Share
      */
@@ -368,6 +372,8 @@ private function getShareConfig()
     }
 
     /**
+     * Add global scope parameter and filter options to website meta
+     *
      * @param array $meta
      * @return void
      */

app/code/Magento/Customer/Model/Plugin/AllowedCountries.php

@@ -40,23 +40,24 @@ public function __construct(
 
     /**
      * Retrieve all allowed countries or specific by scope depends on customer share setting
+     *
      * @param \Magento\Directory\Model\AllowedCountries $subject
      * @param string | null $filter
      * @param string $scope
      */
     public function beforeGetAllowedCountries(
         \Magento\Directory\Model\AllowedCountries $subject,
-        $filter = null,
+        $scopeCode = null,
         $scope = ScopeInterface::SCOPE_WEBSITE
     ) {
         if ($this->shareConfig->isGlobalScope()) {
             //Check if we have shared accounts - than merge all website allowed countries
-            $filter = array_map(function (WebsiteInterface $website) {
+            $scopeCode = array_map(function (WebsiteInterface $website) {
                 return $website->getId();
             }, $this->storeManager->getWebsites());
             $scope = ScopeInterface::SCOPE_WEBSITES;
         }
 
-        return [$filter, $scope];
+        return [$scopeCode, $scope];
     }
 }

app/code/Magento/Customer/Model/ResourceModel/Address/Attribute/Source/CountryWithWebsites.php

@@ -46,19 +46,19 @@ class CountryWithWebsites extends \Magento\Eav\Model\Entity\Attribute\Source\Tab
      * @param \Magento\Eav\Model\ResourceModel\Entity\Attribute\Option\CollectionFactory $attrOptionCollectionFactory
      * @param \Magento\Eav\Model\ResourceModel\Entity\Attribute\OptionFactory $attrOptionFactory
      * @param \Magento\Directory\Model\ResourceModel\Country\CollectionFactory $countriesFactory
-     * @param AllowedCountries $allowedCountries
+     * @param AllowedCountries $allowedCountriesReader
      * @param \Magento\Store\Model\StoreManagerInterface $storeManager
      */
     public function __construct(
         \Magento\Eav\Model\ResourceModel\Entity\Attribute\Option\CollectionFactory $attrOptionCollectionFactory,
         \Magento\Eav\Model\ResourceModel\Entity\Attribute\OptionFactory $attrOptionFactory,
         \Magento\Directory\Model\ResourceModel\Country\CollectionFactory $countriesFactory,
-        \Magento\Directory\Model\AllowedCountries $allowedCountries,
+        \Magento\Directory\Model\AllowedCountries $allowedCountriesReader,
         \Magento\Store\Model\StoreManagerInterface $storeManager,
         \Magento\Customer\Model\Config\Share $shareConfig
     ) {
         $this->countriesFactory = $countriesFactory;
-        $this->allowedCountriesReader = $allowedCountries;
+        $this->allowedCountriesReader = $allowedCountriesReader;
         $this->storeManager = $storeManager;
         $this->shareConfig = $shareConfig;
         parent::__construct($attrOptionCollectionFactory, $attrOptionFactory);
@@ -106,6 +106,7 @@ public function getAllOptions()
 
     /**
      * Create Countries Collection with all countries
+     *
      * @return \Magento\Directory\Model\ResourceModel\Country\Collection
      */
     private function createCountriesCollection()

app/code/Magento/Customer/Setup/UpgradeData.php

@@ -46,6 +46,11 @@ class UpgradeData implements UpgradeDataInterface
      */
     protected $eavConfig;
 
+    /**
+     * @var StoreManagerInterface
+     */
+    private $storeManager;
+
     /**
      * @param CustomerSetupFactory $customerSetupFactory
      * @param IndexerRegistry $indexerRegistry
@@ -135,16 +140,23 @@ public function upgrade(ModuleDataSetupInterface $setup, ModuleContextInterface
     }
 
     /**
+     * Retrieve Store Manager
+     *
      * @deprecated
      * @return StoreManagerInterface
      */
     private function getStoreManager()
     {
-        return \Magento\Framework\App\ObjectManager::getInstance()->get(StoreManagerInterface::class);
+        if (!$this->storeManager) {
+            $this->storeManager = ObjectManager::getInstance()->get(StoreManagerInterface::class);
+        }
+
+        return $this->storeManager;
     }
 
     /**
      * Retrieve Allowed Countries Reader
+     *
      * @deprecated
      * @return AllowedCountries
      */
@@ -158,6 +170,8 @@ private function getAllowedCountriesReader()
     }
 
     /**
+     * Merge allowed countries between different scopes
+     *
      * @param array $countries
      * @param array $newCountries
      * @param string $identifier
@@ -176,6 +190,8 @@ private function mergeAllowedCountries(array $countries, array $newCountries, $i
     }
 
     /**
+     * Merge allowed countries from stores to websites
+     *
      * @param SetupInterface $setup
      * @return void
      */

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

@@ -12,7 +12,7 @@
 use Magento\Store\Model\StoreManagerInterface;
 
 /**
- * Class CountryHandler.
+ * Class CountryHandler
  */
 class AllowedCountries
 {
@@ -43,38 +43,65 @@ public function __construct(
 
     /**
      * Retrieve all allowed countries for scope or scopes
-     * @param string | null $filter
+     *
+     * @param string | null $scopeCode
      * @param string $scope
      * @return array
      */
     public function getAllowedCountries(
-        $filter = null,
+        $scopeCode = null,
         $scope = ScopeInterface::SCOPE_WEBSITE
     ) {
-        if (empty($filter)) {
-            $filter = $this->storeManager->getWebsite()->getId();
+        if (empty($scopeCode)) {
+            $scopeCode = $this->getDefaultScopeCode($scope);
         }
 
         switch ($scope) {
             case ScopeInterface::SCOPE_WEBSITES:
             case ScopeInterface::SCOPE_STORES:
                 $allowedCountries = [];
-                foreach ($filter as $singleFilter) {
+                foreach ($scopeCode as $singleFilter) {
                     $allowedCountries = array_merge(
                         $allowedCountries,
                         $this->getCountriesFromConfig($this->getSingleScope($scope), $singleFilter)
                     );
                 }
                 break;
             default:
-                $allowedCountries = $this->getCountriesFromConfig($scope, $filter);
+                $allowedCountries = $this->getCountriesFromConfig($scope, $scopeCode);
         }
 
         return $this->getUniqueCountries($allowedCountries);
     }
 
     /**
-     * Return Unique Countries by merging them by keys.
+     * Resolve scope code by scope
+     *
+     * @throws \InvalidArgumentException
+     * @param $scope
+     * @return array|int
+     */
+    private function getDefaultScopeCode($scope)
+    {
+        switch ($scope) {
+            case ScopeInterface::SCOPE_WEBSITE:
+                return $this->storeManager->getWebsite()->getId();
+            case ScopeInterface::SCOPE_STORE:
+                return $this->storeManager->getStore()->getId();
+            case ScopeInterface::SCOPE_GROUP:
+                return $this->storeManager->getGroup()->getId();
+            case ScopeInterface::SCOPE_WEBSITES:
+                return [$this->storeManager->getWebsite()->getId()];
+            case ScopeInterface::SCOPE_STORES:
+                return [$this->storeManager->getStore()->getId()];
+            default:
+                throw new \InvalidArgumentException("Invalid scope is specified");
+        }
+    }
+
+    /**
+     * Return Unique Countries by merging them by keys
+     *
      * @param array $allowedCountries
      * @return array
      */
@@ -85,24 +112,26 @@ private function getUniqueCountries(array $allowedCountries)
 
     /**
      * Takes countries from Countries Config data
+     *
      * @param string $scope
-     * @param int $filter
+     * @param int $scopeCode
      * @return array
      */
-    private function getCountriesFromConfig($scope, $filter)
+    private function getCountriesFromConfig($scope, $scopeCode)
     {
         return explode(
             ',',
             (string) $this->scopeConfig->getValue(
                 self::ALLOWED_COUNTRIES_PATH,
                 $scope,
-                $filter
+                $scopeCode
             )
         );
     }
 
     /**
      * Return Single Scope
+     *
      * @param string $scope
      * @return string
      */

app/code/Magento/Directory/Model/ResourceModel/Country/Collection.php

@@ -12,7 +12,6 @@
 namespace Magento\Directory\Model\ResourceModel\Country;
 use Magento\Directory\Model\AllowedCountries;
 use Magento\Framework\App\ObjectManager;
-use Magento\Store\Model\ScopeInterface;
 
 /**
  * Class Collection
@@ -59,7 +58,7 @@ class Collection extends \Magento\Framework\Model\ResourceModel\Db\Collection\Ab
     /**
      * @var AllowedCountries
      */
-    private $allowedCountries;
+    private $allowedCountriesReader;
 
     /**
      * @var string[]
@@ -128,27 +127,28 @@ protected function _construct()
 
     /**
      * Return Allowed Countries reader
+     *
      * @deprecated
      * @return \Magento\Directory\Model\AllowedCountries
      */
     private function getAllowedCountriesReader()
     {
-        if (!$this->allowedCountries) {
-            $this->allowedCountries = ObjectManager::getInstance()->get(AllowedCountries::class);
+        if (!$this->allowedCountriesReader) {
+            $this->allowedCountriesReader = ObjectManager::getInstance()->get(AllowedCountries::class);
         }
 
-        return $this->allowedCountries;
+        return $this->allowedCountriesReader;
     }
 
     /**
-     * Apply allowed countries by specific scope: store, website, etc.
-     * @param string $filter
-     * @param string $scope
-     * @return self
+     * Load allowed countries for current store
+     *
+     * @param null|int|string|\Magento\Store\Model\Store $store
+     * @return \Magento\Directory\Model\ResourceModel\Country\Collection
      */
-    private function loadByScope($filter, $scope = ScopeInterface::SCOPE_STORE)
+    public function loadByStore($store = null)
     {
-        $allowedCountries = $this->getAllowedCountriesReader()->getAllowedCountries($filter, $scope);
+        $allowedCountries = $this->getAllowedCountriesReader()->getAllowedCountries($store);
 
         if (!empty($allowedCountries)) {
             $this->addFieldToFilter("country_id", ['in' => $allowedCountries]);
@@ -157,17 +157,6 @@ private function loadByScope($filter, $scope = ScopeInterface::SCOPE_STORE)
         return $this;
     }
 
-    /**
-     * Load allowed countries for current store
-     *
-     * @param null|int|string|\Magento\Store\Model\Store $store
-     * @return \Magento\Directory\Model\ResourceModel\Country\Collection
-     */
-    public function loadByStore($store = null)
-    {
-        return $this->loadByScope($store, ScopeInterface::SCOPE_STORE);
-    }
-
     /**
      * Loads Item By Id
      *

app/code/Magento/Sales/Block/Adminhtml/Order/Create/Form/Address.php

@@ -6,12 +6,9 @@
 namespace Magento\Sales\Block\Adminhtml\Order\Create\Form;
 
 use Magento\Backend\Model\Session\Quote;
-use Magento\Directory\Model\AllowedCountries;
-use Magento\Directory\Model\ResourceModel\Country\Collection;
 use Magento\Framework\App\ObjectManager;
 use Magento\Framework\Data\Form\Element\AbstractElement;
 use Magento\Framework\Pricing\PriceCurrencyInterface;
-use Magento\Store\Model\ScopeInterface;
 
 /**
  * Order create address form