Inheritance diagram for AbstractCarrierOnline:

Public Member Functions
	__construct (\Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, \Magento\Quote\Model\Quote\Address\RateResult\ErrorFactory $rateErrorFactory, \Psr\Log\LoggerInterface $logger, Security $xmlSecurity, \Magento\Shipping\Model\Simplexml\ElementFactory $xmlElFactory, \Magento\Shipping\Model\Rate\ResultFactory $rateFactory, \Magento\Quote\Model\Quote\Address\RateResult\MethodFactory $rateMethodFactory, \Magento\Shipping\Model\Tracking\ResultFactory $trackFactory, \Magento\Shipping\Model\Tracking\Result\ErrorFactory $trackErrorFactory, \Magento\Shipping\Model\Tracking\Result\StatusFactory $trackStatusFactory, \Magento\Directory\Model\RegionFactory $regionFactory, \Magento\Directory\Model\CountryFactory $countryFactory, \Magento\Directory\Model\CurrencyFactory $currencyFactory, \Magento\Directory\Helper\Data $directoryData, \Magento\CatalogInventory\Api\StockRegistryInterface $stockRegistry, array $data=[])

	setActiveFlag ($code='active')

	getCarrierCode ()

	getTrackingInfo ($tracking)

	isTrackingAvailable ()

	isCityRequired ()

	isZipCodeRequired ($countryId=null)

	isShippingLabelsAvailable ()

	getAllItems (RateRequest $request)

	proccessAdditionalValidation (\Magento\Framework\DataObject $request)

	requestToShipment ($request)

	returnOfShipment ($request)

	rollBack ($data)

	isGirthAllowed ($countyDest=null, $carrierMethodCode=null)

	setRawRequest ($request)

	getMethodPrice ($cost, $method='')

	parseXml ($xmlContent, $customSimplexml='SimpleXMLElement')

	canCollectRates ()

Public Member Functions inherited from AbstractCarrier
	__construct (\Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, \Magento\Quote\Model\Quote\Address\RateResult\ErrorFactory $rateErrorFactory, \Psr\Log\LoggerInterface $logger, array $data=[])

	getConfigData ($field)

	getConfigFlag ($field)

	requestToShipment ($request)

	returnOfShipment ($request)

	getContainerTypes (\Magento\Framework\DataObject $params=null)

	getCustomizableContainerTypes ()

	getDeliveryConfirmationTypes (\Magento\Framework\DataObject $params=null)

	processAdditionalValidation (\Magento\Framework\DataObject $request)

	proccessAdditionalValidation (\Magento\Framework\DataObject $request)

	isActive ()

	isFixed ()

	isTrackingAvailable ()

	isShippingLabelsAvailable ()

	getSortOrder ()

	getFinalPriceWithHandlingFee ($cost)

	getTotalNumOfBoxes ($weight)

	isStateProvinceRequired ()

	isCityRequired ()

	isZipCodeRequired ($countryId=null)

	getDebugFlag ()

	debugData ($debugData)

	getCarrierCode ()

	getContentTypes (\Magento\Framework\DataObject $params)

Public Member Functions inherited from DataObject
	__construct (array $data=[])

	addData (array $arr)

	setData ($key, $value=null)

	unsetData ($key=null)

	getData ($key='', $index=null)

	getDataByPath ($path)

	getDataByKey ($key)

	setDataUsingMethod ($key, $args=[])

	getDataUsingMethod ($key, $args=null)

	hasData ($key='')

	toArray (array $keys=[])

	convertToArray (array $keys=[])

	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	toJson (array $keys=[])

	convertToJson (array $keys=[])

	toString ($format='')

	__call ($method, $args)

	isEmpty ()

	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')

	debug ($data=null, &$objects=[])

	offsetSet ($offset, $value)

	offsetExists ($offset)

	offsetUnset ($offset)

	offsetGet ($offset)

Public Member Functions inherited from AbstractCarrierInterface
	collectRates (RateRequest $request)

	checkAvailableShipCountries (\Magento\Framework\DataObject $request)

Data Fields
const	USA_COUNTRY_ID = 'US'

const	PUERTORICO_COUNTRY_ID = 'PR'

const	GUAM_COUNTRY_ID = 'GU'

const	GUAM_REGION_CODE = 'GU'

Data Fields inherited from AbstractCarrier
const	DEBUG_KEYS_MASK = '****'

const	USA_COUNTRY_ID = 'US'

const	CANADA_COUNTRY_ID = 'CA'

const	MEXICO_COUNTRY_ID = 'MX'

const	HANDLING_TYPE_PERCENT = 'P'

const	HANDLING_TYPE_FIXED = 'F'

const	HANDLING_ACTION_PERPACKAGE = 'P'

const	HANDLING_ACTION_PERORDER = 'O'

Protected Member Functions
	_getQuotesCacheKey ($requestParams)

	_getCachedQuotes ($requestParams)

	_setCachedQuotes ($requestParams, $response)

	_prepareServiceName ($name)

	_prepareShipmentRequest (\Magento\Framework\DataObject $request)

	_doShipmentRequest (\Magento\Framework\DataObject $request)

	_isUSCountry ($countyId)

	debugErrors ($errors)

	getErrorMessage ()

Protected Member Functions inherited from AbstractCarrier
	_getAllowedContainers (\Magento\Framework\DataObject $params=null)

	_updateFreeMethodQuote ($request)

	_getPerpackagePrice ($cost, $handlingType, $handlingFee)

	_getPerorderPrice ($cost, $handlingType, $handlingFee)

	_debug ($debugData)

	filterDebugData ($data)

Protected Member Functions inherited from DataObject
	_getData ($key)

	_underscore ($name)

Protected Attributes
	$_activeFlag = 'active'

	$_directoryData = null

	$_xmlElFactory

	$_rateFactory

	$_rateMethodFactory

	$_trackFactory

	$_trackErrorFactory

	$_trackStatusFactory

	$_regionFactory

	$_countryFactory

	$_currencyFactory

	$stockRegistry

	$_rawRequest = null

	$xmlSecurity

Protected Attributes inherited from AbstractCarrier
	$_code

	$_rates

	$_numBoxes = 1

	$_freeMethod = 'free_method'

	$_isFixed = false

	$_customizableContainerTypes = []

	$_debugReplacePrivateDataKeys = []

	$_scopeConfig

	$_rateErrorFactory

	$_logger

Protected Attributes inherited from DataObject
	$_data = []

Static Protected Attributes
static	$_quotesCache = []

Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Abstract online shipping carrier model

@api @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since: 100.0.2

Definition at line 22 of file AbstractCarrierOnline.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig,
		\Magento\Quote\Model\Quote\Address\RateResult\ErrorFactory	$rateErrorFactory,
		\Psr\Log\LoggerInterface	$logger,
		Security	$xmlSecurity,
		\Magento\Shipping\Model\Simplexml\ElementFactory	$xmlElFactory,
		\Magento\Shipping\Model\Rate\ResultFactory	$rateFactory,
		\Magento\Quote\Model\Quote\Address\RateResult\MethodFactory	$rateMethodFactory,
		\Magento\Shipping\Model\Tracking\ResultFactory	$trackFactory,
		\Magento\Shipping\Model\Tracking\Result\ErrorFactory	$trackErrorFactory,
		\Magento\Shipping\Model\Tracking\Result\StatusFactory	$trackStatusFactory,
		\Magento\Directory\Model\RegionFactory	$regionFactory,
		\Magento\Directory\Model\CountryFactory	$countryFactory,
		\Magento\Directory\Model\CurrencyFactory	$currencyFactory,
		\Magento\Directory\Helper\Data	$directoryData,
		\Magento\CatalogInventory\Api\StockRegistryInterface	$stockRegistry,
		array	$data = `[]`
	)

Parameters

\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig
\Magento\Quote\Model\Quote\Address\RateResult\ErrorFactory	$rateErrorFactory
\Psr\Log\LoggerInterface	$logger
Security	$xmlSecurity
\Magento\Shipping\Model\Simplexml\ElementFactory	$xmlElFactory
\Magento\Shipping\Model\Rate\ResultFactory	$rateFactory
\Magento\Quote\Model\Quote\Address\RateResult\MethodFactory	$rateMethodFactory
\Magento\Shipping\Model\Tracking\ResultFactory	$trackFactory
\Magento\Shipping\Model\Tracking\Result\ErrorFactory	$trackErrorFactory
\Magento\Shipping\Model\Tracking\Result\StatusFactory	$trackStatusFactory
\Magento\Directory\Model\RegionFactory	$regionFactory
\Magento\Directory\Model\CountryFactory	$countryFactory
\Magento\Directory\Model\CurrencyFactory	$currencyFactory
\Magento\Directory\Helper\Data	$directoryData
\Magento\CatalogInventory\Api\StockRegistryInterface	$stockRegistry
array	$data	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 137 of file AbstractCarrierOnline.php.

       {
         $this->_xmlElFactory = $xmlElFactory;
         $this->_rateFactory = $rateFactory;
         $this->_rateMethodFactory = $rateMethodFactory;
         $this->_trackFactory = $trackFactory;
         $this->_trackErrorFactory = $trackErrorFactory;
         $this->_trackStatusFactory = $trackStatusFactory;
         $this->_regionFactory = $regionFactory;
         $this->_countryFactory = $countryFactory;
         $this->_currencyFactory = $currencyFactory;
         $this->_directoryData = $directoryData;
         $this->stockRegistry = $stockRegistry;
         parent::__construct($scopeConfig, $rateErrorFactory, $logger, $data);
         $this->xmlSecurity = $xmlSecurity;
     }

Member Function Documentation

◆ _doShipmentRequest()

_doShipmentRequest ( \Magento\Framework\DataObject $request )

abstractprotected

Do shipment request to carrier web service, obtain Print Shipping Labels and process errors in response

Parameters

\Magento\Framework\DataObject $request

Returns: \Magento\Framework\DataObject

◆ _getCachedQuotes()

_getCachedQuotes ( $requestParams )

protected

Checks whether some request to rates have already been done, so we have cache for it Used to reduce number of same requests done to carrier service during one session

Returns cached response or null

Parameters

string | array $requestParams

Returns: null|string

Definition at line 410 of file AbstractCarrierOnline.php.

     {
         $key = $this->_getQuotesCacheKey($requestParams);
 
         return isset(self::$_quotesCache[$key]) ? self::$_quotesCache[$key] : null;
     }

◆ _getQuotesCacheKey()

_getQuotesCacheKey ( $requestParams )

protected

Returns cache key for some request to carrier quotes service

Parameters

string | array $requestParams

Returns: string

Definition at line 389 of file AbstractCarrierOnline.php.

     {
         if (is_array($requestParams)) {
             $requestParams = implode(
                 ',',
                 array_merge([$this->getCarrierCode()], array_keys($requestParams), $requestParams)
             );
         }
 
         return crc32($requestParams);
     }

◆ _isUSCountry()

_isUSCountry ( $countyId )

protected

Check is Country U.S. Possessions and Trust Territories

Parameters

string $countyId

Returns: boolean

Definition at line 591 of file AbstractCarrierOnline.php.

     {
         switch ($countyId) {
             case 'AS':
                 // Samoa American
             case 'GU':
                 // Guam
             case 'MP':
                 // Northern Mariana Islands
             case 'PW':
                 // Palau
             case 'PR':
                 // Puerto Rico
             case 'VI':
                 // Virgin Islands US
             case 'US':
                 // United States
                 return true;
         }
 
         return false;
     }

◆ _prepareServiceName()

_prepareServiceName ( $name )

protected

Prepare service name. Strip tags and entities from name

Parameters

string | object $name service name or object with implemented __toString() method

Returns: string prepared service name

Definition at line 438 of file AbstractCarrierOnline.php.

     {
         $name = html_entity_decode((string)$name);
         $name = strip_tags(preg_replace('#&\w+;#', '', $name));
 
         return trim($name);
     }

◆ _prepareShipmentRequest()

_prepareShipmentRequest ( \Magento\Framework\DataObject $request )

protected

Prepare shipment request. Validate and correct request information

Parameters

\Magento\Framework\DataObject $request

Returns: void

Definition at line 453 of file AbstractCarrierOnline.php.

     {
         $phonePattern = '/[\s\_\-\(\)]+/';
         $phoneNumber = $request->getShipperContactPhoneNumber();
         $phoneNumber = preg_replace($phonePattern, '', $phoneNumber);
         $request->setShipperContactPhoneNumber($phoneNumber);
         $phoneNumber = $request->getRecipientContactPhoneNumber();
         $phoneNumber = preg_replace($phonePattern, '', $phoneNumber);
         $request->setRecipientContactPhoneNumber($phoneNumber);
     }

◆ _setCachedQuotes()

_setCachedQuotes	(	$requestParams,
		$response
	)

protected

Sets received carrier quotes to cache

Parameters

string \| array	$requestParams
string	$response

Returns: $this

Definition at line 424 of file AbstractCarrierOnline.php.

     {
         $key = $this->_getQuotesCacheKey($requestParams);
         self::$_quotesCache[$key] = $response;
 
         return $this;
     }

◆ canCollectRates()

canCollectRates ( )

Checks if shipping method can collect rates

Returns: bool

Definition at line 686 of file AbstractCarrierOnline.php.

     {
         return (bool)$this->getConfigFlag($this->_activeFlag);
     }

◆ debugErrors()

debugErrors ( $errors )

protected

Debug errors if showmethod is unset

Parameters

Error $errors

Returns: void

Definition at line 697 of file AbstractCarrierOnline.php.

     {
         if ($this->getConfigData('showmethod')) {
             /* @var $error Error */
             $this->_debug($errors);
         }
     }

◆ getAllItems()

getAllItems ( RateRequest $request )

Return items for further shipment rate evaluation. We need to pass children of a bundle instead passing the bundle itself, otherwise we may not get a rate at all (e.g. when total weight of a bundle exceeds max weight despite each item by itself is not)

Parameters

RateRequest $request

Returns: array @SuppressWarnings(PHPMD.CyclomaticComplexity) @api

Definition at line 273 of file AbstractCarrierOnline.php.

     {
         $items = [];
         if ($request->getAllItems()) {
             foreach ($request->getAllItems() as $item) {
                 /* @var $item \Magento\Quote\Model\Quote\Item */
                 if ($item->getProduct()->isVirtual() || $item->getParentItem()) {
                     // Don't process children here - we will process (or already have processed) them below
                     continue;
                 }
 
                 if ($item->getHasChildren() && $item->isShipSeparately()) {
                     foreach ($item->getChildren() as $child) {
                         if (!$child->getFreeShipping() && !$child->getProduct()->isVirtual()) {
                             $items[] = $child;
                         }
                     }
                 } else {
                     // Ship together - count compound item as one solid
                     $items[] = $item;
                 }
             }
         }
 
         return $items;
     }

◆ getCarrierCode()

getCarrierCode ( )

Return code of carrier

Returns: string

Implements AbstractCarrierInterface.

Definition at line 189 of file AbstractCarrierOnline.php.

     {
         return isset($this->_code) ? $this->_code : null;
     }

◆ getErrorMessage()

getErrorMessage ( )

protected

Get error messages

Returns: bool|Error

Definition at line 710 of file AbstractCarrierOnline.php.

     {
         if ($this->getConfigData('showmethod')) {
             /* @var $error Error */
             $error = $this->_rateErrorFactory->create();
             $error->setCarrier($this->getCarrierCode());
             $error->setCarrierTitle($this->getConfigData('title'));
             $error->setErrorMessage($this->getConfigData('specificerrmsg'));
             return $error;
         } else {
             return false;
         }
     }

◆ getMethodPrice()

getMethodPrice	(	$cost,
		$method = `''`
	)

Calculate price considering free shipping and handling fee

Parameters

string	$cost
string	$method

Returns: float|string @api

Definition at line 648 of file AbstractCarrierOnline.php.

     {
         return $method == $this->getConfigData(
             $this->_freeMethod
         ) && $this->getConfigFlag(
             'free_shipping_enable'
         ) && $this->getConfigData(
             'free_shipping_subtotal'
         ) <= $this->_rawRequest->getBaseSubtotalInclTax() ? '0.00' : $this->getFinalPriceWithHandlingFee(
             $cost
         );
     }

◆ getTrackingInfo()

getTrackingInfo ( $tracking )

Get tracking information

Parameters

string $tracking

Returns: string|false @api

Definition at line 201 of file AbstractCarrierOnline.php.

     {
         $result = $this->getTracking($tracking);
 
         if ($result instanceof \Magento\Shipping\Model\Tracking\Result) {
             $trackings = $result->getAllTrackings();
             if ($trackings) {
                 return $trackings[0];
             }
         } elseif (is_string($result) && !empty($result)) {
             return $result;
         }
 
         return false;
     }

◆ isCityRequired()

isCityRequired ( )

Check if city option required

Returns: boolean

Implements AbstractCarrierInterface.

Definition at line 233 of file AbstractCarrierOnline.php.

     {
         return true;
     }

◆ isGirthAllowed()

isGirthAllowed	(	$countyDest = `null`,
		$carrierMethodCode = `null`
	)

Check whether girth is allowed for the carrier

Parameters

null \| string	$countyDest
null \| string	$carrierMethodCode

Returns: bool @SuppressWarnings(PHPMD.UnusedFormalParameter) @api

Definition at line 623 of file AbstractCarrierOnline.php.

     {
         return false;
     }

◆ isShippingLabelsAvailable()

isShippingLabelsAvailable ( )

Check if carrier has shipping label option available

Returns: boolean

Implements AbstractCarrierInterface.

Definition at line 258 of file AbstractCarrierOnline.php.

     {
         return true;
     }

◆ isTrackingAvailable()

isTrackingAvailable ( )

Check if carrier has shipping tracking option available All \Magento\Usa carriers have shipping tracking option available

Returns: boolean

Implements AbstractCarrierInterface.

Definition at line 223 of file AbstractCarrierOnline.php.

     {
         return true;
     }

◆ isZipCodeRequired()

isZipCodeRequired ( $countryId = null )

Determine whether zip-code is required for the country of destination

Parameters

string | null $countryId

Returns: bool

Implements AbstractCarrierInterface.

Definition at line 244 of file AbstractCarrierOnline.php.

     {
         if ($countryId != null) {
             return !$this->_directoryData->isZipCodeOptional($countryId);
         }
 
         return true;
     }

◆ parseXml()

parseXml	(	$xmlContent,
		$customSimplexml = `'SimpleXMLElement'`
	)

Parse XML string and return XML document object or false

Parameters

string	$xmlContent
string	$customSimplexml

Returns: \SimpleXMLElement|bool

Exceptions

LocalizedException @api

Definition at line 671 of file AbstractCarrierOnline.php.

     {
         if (!$this->xmlSecurity->scan($xmlContent)) {
             throw new LocalizedException(__('The security validation of the XML document has failed.'));
         }
 
         $xmlElement = simplexml_load_string($xmlContent, $customSimplexml);
 
         return $xmlElement;
     }

◆ proccessAdditionalValidation()

proccessAdditionalValidation ( \Magento\Framework\DataObject $request )

Processing additional validation to check if carrier applicable.

Parameters

\Magento\Framework\DataObject $request

Returns: $this|bool|\Magento\Framework\DataObject

Deprecated:: 100.2.6 @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

Implements AbstractCarrierInterface.

Definition at line 309 of file AbstractCarrierOnline.php.

     {
         return $this->processAdditionalValidation($request);
     }

◆ requestToShipment()

requestToShipment ( $request )

Do request to shipment

Parameters

Request $request

Returns: \Magento\Framework\DataObject

Exceptions

Implements AbstractCarrierInterface.

Definition at line 471 of file AbstractCarrierOnline.php.

     {
         $packages = $request->getPackages();
         if (!is_array($packages) || !$packages) {
             throw new LocalizedException(__('No packages for request'));
         }
         if ($request->getStoreId() != null) {
             $this->setStore($request->getStoreId());
         }
         $data = [];
         foreach ($packages as $packageId => $package) {
             $request->setPackageId($packageId);
             $request->setPackagingType($package['params']['container']);
             $request->setPackageWeight($package['params']['weight']);
             $request->setPackageParams(new \Magento\Framework\DataObject($package['params']));
             $request->setPackageItems($package['items']);
             $result = $this->_doShipmentRequest($request);
 
             if ($result->hasErrors()) {
                 $this->rollBack($data);
                 break;
             } else {
                 $data[] = [
                     'tracking_number' => $result->getTrackingNumber(),
                     'label_content' => $result->getShippingLabelContent(),
                 ];
             }
             if (!isset($isFirstRequest)) {
                 $request->setMasterTrackingId($result->getTrackingNumber());
                 $isFirstRequest = false;
             }
         }
 
         $response = new \Magento\Framework\DataObject(['info' => $data]);
         if ($result->getErrors()) {
             $response->setErrors($result->getErrors());
         }
 
         return $response;
     }

◆ returnOfShipment()

returnOfShipment ( $request )

Do request to RMA shipment

Parameters

Request $request

Returns: \Magento\Framework\DataObject

Exceptions

Implements AbstractCarrierInterface.

Definition at line 519 of file AbstractCarrierOnline.php.

     {
         $request->setIsReturn(true);
         $packages = $request->getPackages();
         if (!is_array($packages) || !$packages) {
             throw new LocalizedException(__('No packages for request'));
         }
         if ($request->getStoreId() != null) {
             $this->setStore($request->getStoreId());
         }
         $data = [];
         foreach ($packages as $packageId => $package) {
             $request->setPackageId($packageId);
             $request->setPackagingType($package['params']['container']);
             $request->setPackageWeight($package['params']['weight']);
             $request->setPackageParams(new \Magento\Framework\DataObject($package['params']));
             $request->setPackageItems($package['items']);
             $result = $this->_doShipmentRequest($request);
 
             if ($result->hasErrors()) {
                 $this->rollBack($data);
                 break;
             } else {
                 $data[] = [
                     'tracking_number' => $result->getTrackingNumber(),
                     'label_content' => $result->getShippingLabelContent(),
                 ];
             }
             if (!isset($isFirstRequest)) {
                 $request->setMasterTrackingId($result->getTrackingNumber());
                 $isFirstRequest = false;
             }
         }
 
         $response = new \Magento\Framework\DataObject(['info' => $data]);
         if ($result->getErrors()) {
             $response->setErrors($result->getErrors());
         }
 
         return $response;
     }

◆ rollBack()

rollBack ( $data )

For multi package shipments. Delete requested shipments if the current shipment request is failed

Parameters

array $data

Returns: bool

Todo:: implement rollback logic @SuppressWarnings(PHPMD.UnusedFormalParameter) @api

Definition at line 572 of file AbstractCarrierOnline.php.

     {
         return true;
     }

◆ setActiveFlag()

setActiveFlag ( $code = 'active' )

Set flag for check carriers for activity

Parameters

string $code

Returns: $this @api

Definition at line 177 of file AbstractCarrierOnline.php.

     {
         $this->_activeFlag = $code;
 
         return $this;
     }

◆ setRawRequest()

setRawRequest ( $request )

Parameters

\Magento\Framework\DataObject | null $request

Returns: $this @api

Definition at line 633 of file AbstractCarrierOnline.php.

     {
         $this->_rawRequest = $request;
 
         return $this;
     }

Field Documentation

◆ $_activeFlag

$_activeFlag = 'active'

protected

Definition at line 44 of file AbstractCarrierOnline.php.

◆ $_countryFactory

$_countryFactory

protected

Definition at line 91 of file AbstractCarrierOnline.php.

◆ $_currencyFactory

$_currencyFactory

protected

Definition at line 96 of file AbstractCarrierOnline.php.

◆ $_directoryData

$_directoryData = null

protected

Definition at line 51 of file AbstractCarrierOnline.php.

◆ $_quotesCache

$_quotesCache = []

staticprotected

Definition at line 37 of file AbstractCarrierOnline.php.

◆ $_rateFactory

$_rateFactory

protected

Definition at line 61 of file AbstractCarrierOnline.php.

◆ $_rateMethodFactory

$_rateMethodFactory

protected

Definition at line 66 of file AbstractCarrierOnline.php.

◆ $_rawRequest

$_rawRequest = null

protected

Definition at line 108 of file AbstractCarrierOnline.php.

◆ $_regionFactory

$_regionFactory

protected

Definition at line 86 of file AbstractCarrierOnline.php.

◆ $_trackErrorFactory

$_trackErrorFactory

protected

Definition at line 76 of file AbstractCarrierOnline.php.

◆ $_trackFactory

$_trackFactory

protected

Definition at line 71 of file AbstractCarrierOnline.php.

◆ $_trackStatusFactory

$_trackStatusFactory

protected

Definition at line 81 of file AbstractCarrierOnline.php.

◆ $_xmlElFactory

$_xmlElFactory

protected

Definition at line 56 of file AbstractCarrierOnline.php.

◆ $stockRegistry

$stockRegistry

protected

Definition at line 101 of file AbstractCarrierOnline.php.

◆ $xmlSecurity

$xmlSecurity

protected

Definition at line 115 of file AbstractCarrierOnline.php.

◆ GUAM_COUNTRY_ID

const GUAM_COUNTRY_ID = 'GU'

Definition at line 28 of file AbstractCarrierOnline.php.

◆ GUAM_REGION_CODE

const GUAM_REGION_CODE = 'GU'

Definition at line 30 of file AbstractCarrierOnline.php.

◆ PUERTORICO_COUNTRY_ID

const PUERTORICO_COUNTRY_ID = 'PR'

Definition at line 26 of file AbstractCarrierOnline.php.

◆ USA_COUNTRY_ID

const USA_COUNTRY_ID = 'US'

Definition at line 24 of file AbstractCarrierOnline.php.

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

vendor/magento/module-shipping/Model/Carrier/AbstractCarrierOnline.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _doShipmentRequest()

◆ _getCachedQuotes()

◆ _getQuotesCacheKey()

◆ _isUSCountry()

◆ _prepareServiceName()

◆ _prepareShipmentRequest()

◆ _setCachedQuotes()

◆ canCollectRates()

◆ debugErrors()

◆ getAllItems()

◆ getCarrierCode()

◆ getErrorMessage()

◆ getMethodPrice()

◆ getTrackingInfo()

◆ isCityRequired()

◆ isGirthAllowed()

◆ isShippingLabelsAvailable()

◆ isTrackingAvailable()

◆ isZipCodeRequired()

◆ parseXml()

◆ proccessAdditionalValidation()

◆ requestToShipment()

◆ returnOfShipment()

◆ rollBack()

◆ setActiveFlag()

◆ setRawRequest()

Field Documentation

◆ $_activeFlag

◆ $_countryFactory

◆ $_currencyFactory

◆ $_directoryData

◆ $_quotesCache

◆ $_rateFactory

◆ $_rateMethodFactory

◆ $_rawRequest

◆ $_regionFactory

◆ $_trackErrorFactory

◆ $_trackFactory

◆ $_trackStatusFactory

◆ $_xmlElFactory

◆ $stockRegistry

◆ $xmlSecurity

◆ GUAM_COUNTRY_ID

◆ GUAM_REGION_CODE

◆ PUERTORICO_COUNTRY_ID

◆ USA_COUNTRY_ID