Carrier Class Reference

Inheritance diagram for Carrier:

Public Member Functions
	__construct (\Magento\Framework\App\Helper\Context $context, \Magento\Framework\Locale\ResolverInterface $localeResolver)
	getOnlineCarrierCodes ($store=null)
	getCarrierConfigValue ($carrierCode, $configPath, $store=null)
	convertMeasureWeight ($value, $sourceWeightMeasure, $toWeightMeasure)
	convertMeasureDimension ($value, $sourceDimensionMeasure, $toDimensionMeasure)
	getMeasureWeightName ($key)
	getMeasureDimensionName ($key)
	isCountryInEU ($countryCode, $storeId=null)
Public Member Functions inherited from AbstractHelper
	__construct (Context $context)
	isModuleOutputEnabled ($moduleName=null)

Data Fields
const	XML_PATH_CARRIERS_ROOT = 'carriers'
const	XML_PATH_EU_COUNTRIES_LIST = 'general/country/eu_countries'

Protected Attributes
	$localeResolver
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

Carrier helper

Definition at line 11 of file Carrier.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\Helper\Context	$context,
		\Magento\Framework\Locale\ResolverInterface	$localeResolver
	)

Parameters

\Magento\Framework\App\Helper\Context	$context
\Magento\Framework\Locale\ResolverInterface	$localeResolver

Definition at line 34 of file Carrier.php.

      {
        $this->localeResolver = $localeResolver;
        parent::__construct($context);
    }

Member Function Documentation

convertMeasureDimension()

convertMeasureDimension	(		$value,
			$sourceDimensionMeasure,
			$toDimensionMeasure
	)

Convert dimensions in different measure types

Parameters

int | float	$value
string	$sourceDimensionMeasure
string	$toDimensionMeasure

Returns

int|null|string

Definition at line 107 of file Carrier.php.

    {
        if ($value) {
            $locale = $this->localeResolver->getLocale();
            $unitDimension = new \Zend_Measure_Length($value, $sourceDimensionMeasure, $locale);
            $unitDimension->setType($toDimensionMeasure);
            return $unitDimension->getValue();
        }
        return null;
    }

convertMeasureWeight()

convertMeasureWeight	(		$value,
			$sourceWeightMeasure,
			$toWeightMeasure
	)

Convert weight in different measure types

Parameters

int | float	$value
string	$sourceWeightMeasure
string	$toWeightMeasure

Returns

int|null|string

Definition at line 88 of file Carrier.php.

    {
        if ($value) {
            $locale = $this->localeResolver->getLocale();
            $unitWeight = new \Zend_Measure_Weight($value, $sourceWeightMeasure, $locale);
            $unitWeight->setType($toWeightMeasure);
            return $unitWeight->getValue();
        }
        return null;
    }

getCarrierConfigValue()

getCarrierConfigValue	(		$carrierCode,
			$configPath,
			$store = null
	)

Get shipping carrier config value

Parameters

string	$carrierCode
string	$configPath
null	$store

Returns

string

Definition at line 71 of file Carrier.php.

    {
        return $this->scopeConfig->getValue(
            sprintf('%s/%s/%s', self::XML_PATH_CARRIERS_ROOT, $carrierCode, $configPath),
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
            $store
        );
    }

getMeasureDimensionName()

getMeasureDimensionName

(

$key

)

Get name of measure by its type

Parameters

string

$key

Returns

string

Definition at line 140 of file Carrier.php.

    {
        $weight = new \Zend_Measure_Length(0);
        $conversionList = $weight->getConversionList();
        if (!empty($conversionList[$key]) && !empty($conversionList[$key][1])) {
            return $conversionList[$key][1];
        }
        return '';
    }

getMeasureWeightName()

getMeasureWeightName

(

$key

)

Get name of measure by its type

Parameters

string

$key

Returns

string

Definition at line 124 of file Carrier.php.

    {
        $weight = new \Zend_Measure_Weight(0);
        $conversionList = $weight->getConversionList();
        if (!empty($conversionList[$key]) && !empty($conversionList[$key][1])) {
            return $conversionList[$key][1];
        }
        return '';
    }

getOnlineCarrierCodes()

getOnlineCarrierCodes

(

$store = null

)

Get online shipping carrier codes

Parameters

int | \Magento\Store\Model\Store | null

$store

Returns

array

Definition at line 48 of file Carrier.php.

    {
        $carriersCodes = [];
        foreach ($this->scopeConfig->getValue(
            self::XML_PATH_CARRIERS_ROOT,
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
            $store
        ) as $carrierCode => $carrier) {
            if (isset($carrier['is_online']) && $carrier['is_online']) {
                $carriersCodes[] = $carrierCode;
            }
        }
        return $carriersCodes;
    }

isCountryInEU()

isCountryInEU	(		$countryCode,
			$storeId = null
	)

Check whether specified country is in EU countries list

Parameters

string	$countryCode
null | int	$storeId

Returns

bool

Definition at line 157 of file Carrier.php.

    {
        $euCountries = explode(
            ',',
            $this->scopeConfig->getValue(
                self::XML_PATH_EU_COUNTRIES_LIST,
                \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
                $storeId
            )
        );

        return in_array($countryCode, $euCountries);
    }

Field Documentation

$localeResolver

Magento Framework Locale ResolverInterface $localeResolver

protected

Locale interface

Definition at line 28 of file Carrier.php.

XML_PATH_CARRIERS_ROOT

const XML_PATH_CARRIERS_ROOT = 'carriers'

Carriers root xml path

Definition at line 16 of file Carrier.php.

XML_PATH_EU_COUNTRIES_LIST

const XML_PATH_EU_COUNTRIES_LIST = 'general/country/eu_countries'

Config path to UE country list

Definition at line 21 of file Carrier.php.

---

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

• vendor/magento/module-shipping/Helper/Carrier.php