Inheritance diagram for Shipping:

Public Member Functions
	__construct (\Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, \Magento\Shipping\Model\Config $shippingConfig, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Shipping\Model\CarrierFactory $carrierFactory, \Magento\Shipping\Model\Rate\ResultFactory $rateResultFactory, \Magento\Shipping\Model\Shipment\RequestFactory $shipmentRequestFactory, \Magento\Directory\Model\RegionFactory $regionFactory, \Magento\Framework\Math\Division $mathDivision, \Magento\CatalogInventory\Api\StockRegistryInterface $stockRegistry, RateRequestFactory $rateRequestFactory=null)

	getResult ()

	setOrigData ($data)

	resetResult ()

	getConfig ()

	collectRates (\Magento\Quote\Model\Quote\Address\RateRequest $request)

	collectCarrierRates ($carrierCode, $request)

	setCarrierAvailabilityConfigField ($code='active')

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

Protected Member Functions
	_makePieces ($items, $maxWeight)

Protected Attributes
	$_orig = null

	$_result = null

	$_availabilityConfigField = 'active'

	$_scopeConfig

	$_storeManager

	$_shippingConfig

	$_carrierFactory

	$_rateResultFactory

	$_shipmentRequestFactory

	$_regionFactory

	$mathDivision

	$stockRegistry

Detailed Description

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 16 of file Shipping.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig,
		\Magento\Shipping\Model\Config	$shippingConfig,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Shipping\Model\CarrierFactory	$carrierFactory,
		\Magento\Shipping\Model\Rate\ResultFactory	$rateResultFactory,
		\Magento\Shipping\Model\Shipment\RequestFactory	$shipmentRequestFactory,
		\Magento\Directory\Model\RegionFactory	$regionFactory,
		\Magento\Framework\Math\Division	$mathDivision,
		\Magento\CatalogInventory\Api\StockRegistryInterface	$stockRegistry,
		RateRequestFactory	$rateRequestFactory = `null`
	)

Parameters

\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig
\Magento\Shipping\Model\Config	$shippingConfig
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Shipping\Model\CarrierFactory	$carrierFactory
\Magento\Shipping\Model\Rate\ResultFactory	$rateResultFactory
\Magento\Shipping\Model\Shipment\RequestFactory	$shipmentRequestFactory
\Magento\Directory\Model\RegionFactory	$regionFactory
\Magento\Framework\Math\Division	$mathDivision
\Magento\CatalogInventory\Api\StockRegistryInterface	$stockRegistry
RateRequestFactory	$rateRequestFactory	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 105 of file Shipping.php.

       {
         $this->_scopeConfig = $scopeConfig;
         $this->_shippingConfig = $shippingConfig;
         $this->_storeManager = $storeManager;
         $this->_carrierFactory = $carrierFactory;
         $this->_rateResultFactory = $rateResultFactory;
         $this->_shipmentRequestFactory = $shipmentRequestFactory;
         $this->_regionFactory = $regionFactory;
         $this->mathDivision = $mathDivision;
         $this->stockRegistry = $stockRegistry;
         $this->rateRequestFactory = $rateRequestFactory ?: ObjectManager::getInstance()->get(RateRequestFactory::class);
     }

Member Function Documentation

◆ _makePieces()

_makePieces	(	$items,
		$maxWeight
	)

protected

Make pieces Compose packages list based on given items, so that each package is as heavy as possible

Parameters

array	$items
float	$maxWeight

Returns: array

Definition at line 429 of file Shipping.php.

     {
         $pieces = [];
         if (!empty($items)) {
             $sumWeight = 0;
 
             $reverseOrderItems = $items;
             arsort($reverseOrderItems);
 
             foreach ($reverseOrderItems as $key => $weight) {
                 if (!isset($items[$key])) {
                     continue;
                 }
                 unset($items[$key]);
                 $sumWeight = $weight;
                 foreach ($items as $key => $weight) {
                     if ($sumWeight + $weight < $maxWeight) {
                         unset($items[$key]);
                         $sumWeight += $weight;
                     } elseif ($sumWeight + $weight > $maxWeight) {
                         $pieces[] = (string)(double)$sumWeight;
                         break;
                     } else {
                         unset($items[$key]);
                         $pieces[] = (string)(double)($sumWeight + $weight);
                         $sumWeight = 0;
                         break;
                     }
                 }
             }
             if ($sumWeight > 0) {
                 $pieces[] = (string)(double)$sumWeight;
             }
             $pieces = array_count_values($pieces);
         }
 
         return $pieces;
     }

◆ collectCarrierRates()

collectCarrierRates	(	$carrierCode,
		$request
	)

Collect rates of given carrier

Parameters

string	$carrierCode
\Magento\Quote\Model\Quote\Address\RateRequest	$request

Returns: $this @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

Definition at line 252 of file Shipping.php.

     {
         /* @var $carrier \Magento\Shipping\Model\Carrier\AbstractCarrier */
         $carrier = $this->_carrierFactory->createIfActive($carrierCode, $request->getStoreId());
         if (!$carrier) {
             return $this;
         }
         $carrier->setActiveFlag($this->_availabilityConfigField);
         $result = $carrier->checkAvailableShipCountries($request);
         if (false !== $result && !$result instanceof \Magento\Quote\Model\Quote\Address\RateResult\Error) {
             $result = $carrier->processAdditionalValidation($request);
         }
         /*
          * Result will be false if the admin set not to show the shipping module
          * if the delivery country is not within specific countries
          */
         if (false !== $result) {
             if (!$result instanceof \Magento\Quote\Model\Quote\Address\RateResult\Error) {
                 if ($carrier->getConfigData('shipment_requesttype')) {
                     $packages = $this->composePackagesForCarrier($carrier, $request);
                     if (!empty($packages)) {
                         $sumResults = [];
                         foreach ($packages as $weight => $packageCount) {
                             $request->setPackageWeight($weight);
                             $result = $carrier->collectRates($request);
                             if (!$result) {
                                 return $this;
                             } else {
                                 $result->updateRatePrice($packageCount);
                             }
                             $sumResults[] = $result;
                         }
                         if (!empty($sumResults) && count($sumResults) > 1) {
                             $result = [];
                             foreach ($sumResults as $res) {
                                 if (empty($result)) {
                                     $result = $res;
                                     continue;
                                 }
                                 foreach ($res->getAllRates() as $method) {
                                     foreach ($result->getAllRates() as $resultMethod) {
                                         if ($method->getMethod() == $resultMethod->getMethod()) {
                                             $resultMethod->setPrice($method->getPrice() + $resultMethod->getPrice());
                                             continue;
                                         }
                                     }
                                 }
                             }
                         }
                     } else {
                         $result = $carrier->collectRates($request);
                     }
                 } else {
                     $result = $carrier->collectRates($request);
                 }
                 if (!$result) {
                     return $this;
                 }
             }
             if ($carrier->getConfigData('showmethod') == 0 && $result->getError()) {
                 return $this;
             }
             // sort rates by price
             if (method_exists($result, 'sortRatesByPrice') && is_callable([$result, 'sortRatesByPrice'])) {
                 $result->sortRatesByPrice();
             }
             $this->getResult()->append($result);
         }
         return $this;
     }

◆ collectRates()

collectRates ( \Magento\Quote\Model\Quote\Address\RateRequest $request )

Retrieve all methods for supplied shipping data

Parameters

\Magento\Quote\Model\Quote\Address\RateRequest $request

Returns: $this

Todo:: make it ordered

Definition at line 181 of file Shipping.php.

     {
         $storeId = $request->getStoreId();
         if (!$request->getOrig()) {
             $request->setCountryId(
                 $this->_scopeConfig->getValue(
                     Shipment::XML_PATH_STORE_COUNTRY_ID,
                     \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
                     $request->getStore()
                 )
             )->setRegionId(
                 $this->_scopeConfig->getValue(
                     Shipment::XML_PATH_STORE_REGION_ID,
                     \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
                     $request->getStore()
                 )
             )->setCity(
                 $this->_scopeConfig->getValue(
                     Shipment::XML_PATH_STORE_CITY,
                     \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
                     $request->getStore()
                 )
             )->setPostcode(
                 $this->_scopeConfig->getValue(
                     Shipment::XML_PATH_STORE_ZIP,
                     \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
                     $request->getStore()
                 )
             );
         }
 
         $limitCarrier = $request->getLimitCarrier();
         if (!$limitCarrier) {
             $carriers = $this->_scopeConfig->getValue(
                 'carriers',
                 \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
                 $storeId
             );
 
             foreach ($carriers as $carrierCode => $carrierConfig) {
                 $this->collectCarrierRates($carrierCode, $request);
             }
         } else {
             if (!is_array($limitCarrier)) {
                 $limitCarrier = [$limitCarrier];
             }
             foreach ($limitCarrier as $carrierCode) {
                 $carrierConfig = $this->_scopeConfig->getValue(
                     'carriers/' . $carrierCode,
                     \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
                     $storeId
                 );
                 if (!$carrierConfig) {
                     continue;
                 }
                 $this->collectCarrierRates($carrierCode, $request);
             }
         }
 
         return $this;
     }

◆ getConfig()

getConfig ( )

Retrieve configuration model

Returns: \Magento\Shipping\Model\Config

Definition at line 169 of file Shipping.php.

     {
         return $this->_shippingConfig;
     }

◆ getResult()

getResult ( )

Get shipping rate result model

Returns: \Magento\Shipping\Model\Rate\Result

Definition at line 134 of file Shipping.php.

     {
         if (empty($this->_result)) {
             $this->_result = $this->_rateResultFactory->create();
         }
         return $this->_result;
     }

◆ resetResult()

resetResult ( )

Reset cached result

Returns: $this

Definition at line 158 of file Shipping.php.

     {
         $this->getResult()->reset();
         return $this;
     }

◆ setCarrierAvailabilityConfigField()

setCarrierAvailabilityConfigField ( $code = 'active' )

Set part of carrier xml config path

Parameters

string $code

Returns: $this

Definition at line 508 of file Shipping.php.

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

◆ setOrigData()

setOrigData ( $data )

Set shipping orig data

Parameters

array $data

Returns: void

Definition at line 148 of file Shipping.php.

     {
         $this->_orig = $data;
     }

Field Documentation

◆ $_availabilityConfigField

$_availabilityConfigField = 'active'

protected

Definition at line 37 of file Shipping.php.

◆ $_carrierFactory

$_carrierFactory

protected

Definition at line 59 of file Shipping.php.

◆ $_orig

$_orig = null

protected

Definition at line 23 of file Shipping.php.

◆ $_rateResultFactory

$_rateResultFactory

protected

Definition at line 64 of file Shipping.php.

◆ $_regionFactory

$_regionFactory

protected

Definition at line 74 of file Shipping.php.

◆ $_result

$_result = null

protected

Definition at line 30 of file Shipping.php.

◆ $_scopeConfig

$_scopeConfig

protected

Definition at line 44 of file Shipping.php.

◆ $_shipmentRequestFactory

$_shipmentRequestFactory

protected

Definition at line 69 of file Shipping.php.

◆ $_shippingConfig

$_shippingConfig

protected

Definition at line 54 of file Shipping.php.

◆ $_storeManager

$_storeManager

protected

Definition at line 49 of file Shipping.php.

◆ $mathDivision

$mathDivision

protected

Definition at line 79 of file Shipping.php.

◆ $stockRegistry

$stockRegistry

protected

Definition at line 84 of file Shipping.php.

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

vendor/magento/module-shipping/Model/Shipping.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _makePieces()

◆ collectCarrierRates()

◆ collectRates()

◆ getConfig()

◆ getResult()

◆ resetResult()

◆ setCarrierAvailabilityConfigField()

◆ setOrigData()

Field Documentation

◆ $_availabilityConfigField

◆ $_carrierFactory

◆ $_orig

◆ $_rateResultFactory

◆ $_regionFactory

◆ $_result

◆ $_scopeConfig

◆ $_shipmentRequestFactory

◆ $_shippingConfig

◆ $_storeManager

◆ $mathDivision

◆ $stockRegistry