Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
All Data Structures Namespaces Files Functions Variables Pages
Public Member Functions | Data Fields | Protected Attributes
Carrier Class Reference
Inheritance diagram for Carrier:
AbstractHelper

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.

37  {
38  $this->localeResolver = $localeResolver;
39  parent::__construct($context);
40  }

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.

108  {
109  if ($value) {
110  $locale = $this->localeResolver->getLocale();
111  $unitDimension = new \Zend_Measure_Length($value, $sourceDimensionMeasure, $locale);
112  $unitDimension->setType($toDimensionMeasure);
113  return $unitDimension->getValue();
114  }
115  return null;
116  }
$value
Definition: gender.phtml:16

◆ 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.

89  {
90  if ($value) {
91  $locale = $this->localeResolver->getLocale();
92  $unitWeight = new \Zend_Measure_Weight($value, $sourceWeightMeasure, $locale);
93  $unitWeight->setType($toWeightMeasure);
94  return $unitWeight->getValue();
95  }
96  return null;
97  }
$value
Definition: gender.phtml:16

◆ 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.

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

◆ getMeasureDimensionName()

getMeasureDimensionName (   $key)

Get name of measure by its type

Parameters
string$key
Returns
string

Definition at line 140 of file Carrier.php.

141  {
142  $weight = new \Zend_Measure_Length(0);
143  $conversionList = $weight->getConversionList();
144  if (!empty($conversionList[$key]) && !empty($conversionList[$key][1])) {
145  return $conversionList[$key][1];
146  }
147  return '';
148  }

◆ getMeasureWeightName()

getMeasureWeightName (   $key)

Get name of measure by its type

Parameters
string$key
Returns
string

Definition at line 124 of file Carrier.php.

125  {
126  $weight = new \Zend_Measure_Weight(0);
127  $conversionList = $weight->getConversionList();
128  if (!empty($conversionList[$key]) && !empty($conversionList[$key][1])) {
129  return $conversionList[$key][1];
130  }
131  return '';
132  }

◆ 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.

49  {
50  $carriersCodes = [];
51  foreach ($this->scopeConfig->getValue(
52  self::XML_PATH_CARRIERS_ROOT,
53  \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
54  $store
55  ) as $carrierCode => $carrier) {
56  if (isset($carrier['is_online']) && $carrier['is_online']) {
57  $carriersCodes[] = $carrierCode;
58  }
59  }
60  return $carriersCodes;
61  }

◆ 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.

158  {
159  $euCountries = explode(
160  ',',
161  $this->scopeConfig->getValue(
162  self::XML_PATH_EU_COUNTRIES_LIST,
163  \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
164  $storeId
165  )
166  );
167 
168  return in_array($countryCode, $euCountries);
169  }

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: