AllowedCountries Class Reference

Public Member Functions
	__construct (ScopeConfigInterface $scopeConfig, StoreManagerInterface $storeManager)
	getAllowedCountries ( $scope=ScopeInterface::SCOPE_WEBSITE, $scopeCode=null)
	makeCountriesUnique (array $allowedCountries)
	getCountriesFromConfig ($scope, $scopeCode)

Data Fields
const	ALLOWED_COUNTRIES_PATH = 'general/country/allow'

Detailed Description

Provider of allowed countries based on configuration settings

@api

Since

100.1.2

Definition at line 19 of file AllowedCountries.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ScopeConfigInterface	$scopeConfig,
		StoreManagerInterface	$storeManager
	)

Parameters

\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig
\Magento\Store\Model\StoreManagerInterface	$storeManager

Returns

void

Definition at line 38 of file AllowedCountries.php.

      {
        $this->scopeConfig = $scopeConfig;
        $this->storeManager = $storeManager;
    }

Member Function Documentation

getAllowedCountries()

getAllowedCountries	(		$scope = ScopeInterface::SCOPE_WEBSITE,
			$scopeCode = null
	)

Retrieve all allowed countries for scope or scopes

Parameters

string	$scope
string | null	$scopeCode

Returns

array

Since

100.1.2

Definition at line 54 of file AllowedCountries.php.

      {
        if ($scopeCode === null) {
            $scopeCode = $this->getDefaultScopeCode($scope);
        }

        switch ($scope) {
            case ScopeInterface::SCOPE_WEBSITES:
            case ScopeInterface::SCOPE_STORES:
                $allowedCountries = [];
                foreach ($scopeCode as $singleFilter) {
                    $allowedCountries = array_merge(
                        $allowedCountries,
                        $this->getCountriesFromConfig($this->getSingleScope($scope), $singleFilter)
                    );
                }
                break;
            default:
                $allowedCountries = $this->getCountriesFromConfig($scope, $scopeCode);
        }

        return $this->makeCountriesUnique($allowedCountries);
    }

getCountriesFromConfig()

getCountriesFromConfig	(		$scope,
			$scopeCode
	)

Takes countries from Countries Config data

Parameters

string	$scope
int	$scopeCode

Returns

array

Since

100.1.2

Definition at line 125 of file AllowedCountries.php.

    {
        return explode(
            ',',
            (string) $this->scopeConfig->getValue(
                self::ALLOWED_COUNTRIES_PATH,
                $scope,
                $scopeCode
            )
        );
    }

makeCountriesUnique()

makeCountriesUnique

(

array

$allowedCountries

)

Return Unique Countries by merging them by keys

Parameters

array

$allowedCountries

Returns

array

Since

100.1.2

Definition at line 112 of file AllowedCountries.php.

    {
        return array_combine($allowedCountries, $allowedCountries);
    }

Field Documentation

ALLOWED_COUNTRIES_PATH

const ALLOWED_COUNTRIES_PATH = 'general/country/allow'

Definition at line 21 of file AllowedCountries.php.

---

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

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