Inheritance diagram for Data:

Public Member Functions
	__construct (\Magento\Framework\App\Helper\Context $context, \Magento\Framework\App\Cache\Type\Config $configCacheType, \Magento\Directory\Model\ResourceModel\Country\Collection $countryCollection, \Magento\Directory\Model\ResourceModel\Region\CollectionFactory $regCollectionFactory, \Magento\Framework\Json\Helper\Data $jsonHelper, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Directory\Model\CurrencyFactory $currencyFactory)

	getRegionCollection ()

	getCountryCollection ($store=null)

	getRegionJson ()

	currencyConvert ($amount, $from, $to=null)

	getCountriesWithOptionalZip ($asJson=false)

	isZipCodeOptional ($countryCode)

	getCountriesWithStatesRequired ($asJson=false)

	isShowNonRequiredState ()

	isRegionRequired ($countryId)

	getBaseCurrencyCode ()

	getDefaultCountry ($store=null)

	getTopCountryCodes ()

	getWeightUnit ()

Public Member Functions inherited from AbstractHelper
	__construct (Context $context)

	isModuleOutputEnabled ($moduleName=null)

Data Fields
const	OPTIONAL_ZIP_COUNTRIES_CONFIG_PATH = 'general/country/optional_zip_countries'

const	XML_PATH_STATES_REQUIRED = 'general/region/state_required'

const	XML_PATH_DISPLAY_ALL_STATES = 'general/region/display_all'

const	XML_PATH_DEFAULT_COUNTRY = 'general/country/default'

const	XML_PATH_DEFAULT_LOCALE = 'general/locale/code'

const	XML_PATH_DEFAULT_TIMEZONE = 'general/locale/timezone'

const	XML_PATH_TOP_COUNTRIES = 'general/country/destinations'

const	XML_PATH_WEIGHT_UNIT = 'general/locale/weight_unit'

Protected Attributes
	$_countryCollection

	$_regionCollection

	$_regionJson

	$_currencyCache = []

	$_optZipCountries = null

	$_configCacheType

	$_regCollectionFactory

	$jsonHelper

	$_storeManager

	$_currencyFactory

Protected Attributes inherited from AbstractHelper
	$_moduleName

	$_request

	$_moduleManager

	$_logger

	$_urlBuilder

	$_httpHeader

	$_eventManager

	$_remoteAddress

	$urlEncoder

	$urlDecoder

	$scopeConfig

	$_cacheConfig

Additional Inherited Members
Protected Member Functions inherited from AbstractHelper
	_getRequest ()

	_getModuleName ()

	_getUrl ($route, $params=[])

Detailed Description

Directory data helper

@api

Since: 100.0.2

Definition at line 17 of file Data.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\App\Helper\Context	$context,
		\Magento\Framework\App\Cache\Type\Config	$configCacheType,
		\Magento\Directory\Model\ResourceModel\Country\Collection	$countryCollection,
		\Magento\Directory\Model\ResourceModel\Region\CollectionFactory	$regCollectionFactory,
		\Magento\Framework\Json\Helper\Data	$jsonHelper,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Directory\Model\CurrencyFactory	$currencyFactory
	)

Parameters

\Magento\Framework\App\Helper\Context	$context
\Magento\Framework\App\Cache\Type\Config	$configCacheType
\Magento\Directory\Model\ResourceModel\Country\Collection	$countryCollection
\Magento\Directory\Model\ResourceModel\Region\CollectionFactory	$regCollectionFactory

Definition at line 122 of file Data.php.

       {
         parent::__construct($context);
         $this->_configCacheType = $configCacheType;
         $this->_countryCollection = $countryCollection;
         $this->_regCollectionFactory = $regCollectionFactory;
         $this->jsonHelper = $jsonHelper;
         $this->_storeManager = $storeManager;
         $this->_currencyFactory = $currencyFactory;
     }

Member Function Documentation

◆ currencyConvert()

currencyConvert	(	$amount,
		$from,
		$to = `null`
	)

Convert currency

Parameters

float	$amount
string	$from
string	$to

Returns: float @SuppressWarnings(PHPMD.ShortVariable)

Definition at line 203 of file Data.php.

     {
         if (empty($this->_currencyCache[$from])) {
             $this->_currencyCache[$from] = $this->_currencyFactory->create()->load($from);
         }
         if ($to === null) {
             $to = $this->_storeManager->getStore()->getCurrentCurrencyCode();
         }
         $converted = $this->_currencyCache[$from]->convert($amount, $to);
         return $converted;
     }

◆ getBaseCurrencyCode()

getBaseCurrencyCode ( )

Retrieve application base currency code

Returns: string

Definition at line 304 of file Data.php.

     {
         return $this->scopeConfig->getValue(\Magento\Directory\Model\Currency::XML_PATH_CURRENCY_BASE, 'default');
     }

◆ getCountriesWithOptionalZip()

getCountriesWithOptionalZip ( $asJson = false )

Return ISO2 country codes, which have optional Zip/Postal pre-configured

Parameters

bool $asJson

Returns: array|string

Definition at line 221 of file Data.php.

     {
         if (null === $this->_optZipCountries) {
             $value = trim(
                 $this->scopeConfig->getValue(
                     self::OPTIONAL_ZIP_COUNTRIES_CONFIG_PATH,
                     ScopeInterface::SCOPE_STORE
                 )
             );
             $this->_optZipCountries = preg_split('/\,/', $value, 0, PREG_SPLIT_NO_EMPTY);
         }
         if ($asJson) {
             return $this->jsonHelper->jsonEncode($this->_optZipCountries);
         }
         return $this->_optZipCountries;
     }

◆ getCountriesWithStatesRequired()

getCountriesWithStatesRequired ( $asJson = false )

Returns the list of countries, for which region is required

Parameters

boolean $asJson

Returns: array

Definition at line 256 of file Data.php.

     {
         $value = trim(
             $this->scopeConfig->getValue(
                 self::XML_PATH_STATES_REQUIRED,
                 ScopeInterface::SCOPE_STORE
             )
         );
         $countryList = preg_split('/\,/', $value, 0, PREG_SPLIT_NO_EMPTY);
         if ($asJson) {
             return $this->jsonHelper->jsonEncode($countryList);
         }
         return $countryList;
     }

◆ getCountryCollection()

getCountryCollection ( $store = null )

Retrieve country collection

Parameters

null | int | string | \Magento\Store\Model\Store $store

Returns: \Magento\Directory\Model\ResourceModel\Country\Collection

Definition at line 160 of file Data.php.

     {
         if (!$this->_countryCollection->isLoaded()) {
             $this->_countryCollection->loadByStore($store);
         }
         return $this->_countryCollection;
     }

◆ getDefaultCountry()

getDefaultCountry ( $store = null )

Return default country code

Parameters

\Magento\Store\Model\Store | string | int $store

Returns: string

Definition at line 315 of file Data.php.

     {
         return $this->scopeConfig->getValue(
             self::XML_PATH_DEFAULT_COUNTRY,
             ScopeInterface::SCOPE_STORE,
             $store
         );
     }

◆ getRegionCollection()

getRegionCollection ( )

Retrieve region collection

Returns: \Magento\Directory\Model\ResourceModel\Region\Collection

Definition at line 145 of file Data.php.

     {
         if (!$this->_regionCollection) {
             $this->_regionCollection = $this->_regCollectionFactory->create();
             $this->_regionCollection->addCountryFilter($this->getAddress()->getCountryId())->load();
         }
         return $this->_regionCollection;
     }

◆ getRegionJson()

getRegionJson ( )

Retrieve regions data json

Returns: string

Definition at line 173 of file Data.php.

     {
         \Magento\Framework\Profiler::start('TEST: ' . __METHOD__, ['group' => 'TEST', 'method' => __METHOD__]);
         if (!$this->_regionJson) {
             $cacheKey = 'DIRECTORY_REGIONS_JSON_STORE' . $this->_storeManager->getStore()->getId();
             $json = $this->_configCacheType->load($cacheKey);
             if (empty($json)) {
                 $regions = $this->getRegionData();
                 $json = $this->jsonHelper->jsonEncode($regions);
                 if ($json === false) {
                     $json = 'false';
                 }
                 $this->_configCacheType->save($json, $cacheKey);
             }
             $this->_regionJson = $json;
         }
 
         \Magento\Framework\Profiler::stop('TEST: ' . __METHOD__);
         return $this->_regionJson;
     }

◆ getTopCountryCodes()

getTopCountryCodes ( )

Retrieve list of codes of the most used countries

Returns: array

Definition at line 361 of file Data.php.

     {
         $configValue = (string)$this->scopeConfig->getValue(
             self::XML_PATH_TOP_COUNTRIES,
             ScopeInterface::SCOPE_STORE
         );
         return !empty($configValue) ? explode(',', $configValue) : [];
     }

◆ getWeightUnit()

getWeightUnit ( )

Retrieve weight unit

Returns: string

Definition at line 375 of file Data.php.

     {
         return $this->scopeConfig->getValue(self::XML_PATH_WEIGHT_UNIT, ScopeInterface::SCOPE_STORE);
     }

◆ isRegionRequired()

isRegionRequired ( $countryId )

Returns flag, which indicates whether region is required for specified country

Parameters

string $countryId

Returns: bool

Definition at line 290 of file Data.php.

     {
         $countyList = $this->getCountriesWithStatesRequired();
         if (!is_array($countyList)) {
             return false;
         }
         return in_array($countryId, $countyList);
     }

◆ isShowNonRequiredState()

isShowNonRequiredState ( )

Return, whether non-required state should be shown

Returns: bool

Definition at line 276 of file Data.php.

     {
         return (bool)$this->scopeConfig->getValue(
             self::XML_PATH_DISPLAY_ALL_STATES,
             ScopeInterface::SCOPE_STORE
         );
     }

◆ isZipCodeOptional()

isZipCodeOptional ( $countryCode )

Check whether zip code is optional for specified country code

Parameters

string $countryCode

Returns: boolean

Definition at line 244 of file Data.php.

     {
         $this->getCountriesWithOptionalZip();
         return in_array($countryCode, $this->_optZipCountries);
     }

Field Documentation

◆ $_configCacheType

$_configCacheType

protected

Definition at line 91 of file Data.php.

◆ $_countryCollection

$_countryCollection

protected

Definition at line 58 of file Data.php.

◆ $_currencyCache

$_currencyCache = []

protected

Definition at line 79 of file Data.php.

◆ $_currencyFactory

$_currencyFactory

protected

Definition at line 111 of file Data.php.

◆ $_optZipCountries

$_optZipCountries = null

protected

Definition at line 86 of file Data.php.

◆ $_regCollectionFactory

$_regCollectionFactory

protected

Definition at line 96 of file Data.php.

◆ $_regionCollection

$_regionCollection

protected

Definition at line 65 of file Data.php.

◆ $_regionJson

$_regionJson

protected

Definition at line 72 of file Data.php.

◆ $_storeManager

$_storeManager

protected

Definition at line 106 of file Data.php.

◆ $jsonHelper

$jsonHelper

protected

Definition at line 101 of file Data.php.

◆ OPTIONAL_ZIP_COUNTRIES_CONFIG_PATH

const OPTIONAL_ZIP_COUNTRIES_CONFIG_PATH = 'general/country/optional_zip_countries'

Config value that lists ISO2 country codes which have optional Zip/Postal pre-configured

Definition at line 22 of file Data.php.

◆ XML_PATH_DEFAULT_COUNTRY

const XML_PATH_DEFAULT_COUNTRY = 'general/country/default'

#+ Path to config value, which is default country

Definition at line 37 of file Data.php.

◆ XML_PATH_DEFAULT_LOCALE

const XML_PATH_DEFAULT_LOCALE = 'general/locale/code'

Definition at line 38 of file Data.php.

◆ XML_PATH_DEFAULT_TIMEZONE

const XML_PATH_DEFAULT_TIMEZONE = 'general/locale/timezone'

Definition at line 39 of file Data.php.

◆ XML_PATH_DISPLAY_ALL_STATES

const XML_PATH_DISPLAY_ALL_STATES = 'general/region/display_all'

Definition at line 32 of file Data.php.

◆ XML_PATH_STATES_REQUIRED

const XML_PATH_STATES_REQUIRED = 'general/region/state_required'

Definition at line 27 of file Data.php.

◆ XML_PATH_TOP_COUNTRIES

const XML_PATH_TOP_COUNTRIES = 'general/country/destinations'

#- Path to config value that contains codes of the most used countries. Such countries can be shown on the top of the country list.

Definition at line 46 of file Data.php.

◆ XML_PATH_WEIGHT_UNIT

const XML_PATH_WEIGHT_UNIT = 'general/locale/weight_unit'

Path to config value that contains weight unit

Definition at line 51 of file Data.php.

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

vendor/magento/module-directory/Helper/Data.php

Public Member Functions

Data Fields

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ currencyConvert()

◆ getBaseCurrencyCode()

◆ getCountriesWithOptionalZip()

◆ getCountriesWithStatesRequired()

◆ getCountryCollection()

◆ getDefaultCountry()

◆ getRegionCollection()

◆ getRegionJson()

◆ getTopCountryCodes()

◆ getWeightUnit()

◆ isRegionRequired()

◆ isShowNonRequiredState()

◆ isZipCodeOptional()

Field Documentation

◆ $_configCacheType

◆ $_countryCollection

◆ $_currencyCache

◆ $_currencyFactory

◆ $_optZipCountries

◆ $_regCollectionFactory

◆ $_regionCollection

◆ $_regionJson

◆ $_storeManager

◆ $jsonHelper

◆ OPTIONAL_ZIP_COUNTRIES_CONFIG_PATH

◆ XML_PATH_DEFAULT_COUNTRY

◆ XML_PATH_DEFAULT_LOCALE

◆ XML_PATH_DEFAULT_TIMEZONE

◆ XML_PATH_DISPLAY_ALL_STATES

◆ XML_PATH_STATES_REQUIRED

◆ XML_PATH_TOP_COUNTRIES

◆ XML_PATH_WEIGHT_UNIT