Inheritance diagram for Multishipping:

Public Member Functions
	__construct (\Magento\Checkout\Model\Session $checkoutSession, \Magento\Customer\Model\Session $customerSession, \Magento\Sales\Model\OrderFactory $orderFactory, AddressRepositoryInterface $addressRepository, \Magento\Framework\Event\ManagerInterface $eventManager, \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, \Magento\Framework\Session\Generic $session, \Magento\Quote\Model\Quote\AddressFactory $addressFactory, \Magento\Quote\Model\Quote\Address\ToOrder $quoteAddressToOrder, \Magento\Quote\Model\Quote\Address\ToOrderAddress $quoteAddressToOrderAddress, \Magento\Quote\Model\Quote\Payment\ToOrderPayment $quotePaymentToOrderPayment, \Magento\Quote\Model\Quote\Item\ToOrderItem $quoteItemToOrderItem, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Payment\Model\Method\SpecificationInterface $paymentSpecification, \Magento\Multishipping\Helper\Data $helper, OrderSender $orderSender, PriceCurrencyInterface $priceCurrency, \Magento\Quote\Api\CartRepositoryInterface $quoteRepository, \Magento\Framework\Api\SearchCriteriaBuilder $searchCriteriaBuilder, \Magento\Framework\Api\FilterBuilder $filterBuilder, \Magento\Quote\Model\Quote\TotalsCollector $totalsCollector, array $data=[], \Magento\Quote\Api\Data\CartExtensionFactory $cartExtensionFactory=null, AllowedCountries $allowedCountryReader=null, Multishipping\PlaceOrderFactory $placeOrderFactory=null, LoggerInterface $logger=null, \Magento\Framework\Api\DataObjectHelper $dataObjectHelper=null)

	getQuoteShippingAddressesItems ()

	removeAddressItem ($addressId, $itemId)

	setShippingItemsInformation ($info)

	updateQuoteCustomerShippingAddress ($addressId)

	setQuoteCustomerBillingAddress ($addressId)

	setPaymentMethod ($payment)

	save ()

	reset ()

	validateMinimumAmount ()

	getMinimumAmountDescription ()

	getMinimumAmountError ()

	getOrderIds ($asAssoc=false)

	getCustomerDefaultBillingAddress ()

	getCustomerDefaultShippingAddress ()

	getCheckoutSession ()

	getQuote ()

	getQuoteItems ()

	getCustomerSession ()

	getCustomer ()

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)

Protected Member Functions
	_init ()

	_addShippingItem ($quoteItemId, $data)

	_prepareOrder (\Magento\Quote\Model\Quote\Address $address)

Protected Member Functions inherited from DataObject
	_getData ($key)

	_underscore ($name)

Protected Attributes
	$_quoteShippingAddressesItems

	$_eventManager = null

	$_scopeConfig

	$_session

	$_storeManager

	$_addressFactory

	$paymentSpecification

	$helper

	$_checkoutSession

	$_customerSession

	$_orderFactory

	$addressRepository

	$orderSender

	$priceCurrency

	$quoteRepository

	$searchCriteriaBuilder

	$filterBuilder

	$quoteAddressToOrder

	$quoteItemToOrderItem

	$quotePaymentToOrderPayment

	$quoteAddressToOrderAddress

	$totalsCollector

Protected Attributes inherited from DataObject
	$_data = []

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

Detailed Description

Multishipping checkout model

@api @SuppressWarnings(PHPMD.TooManyFields) @SuppressWarnings(PHPMD.ExcessiveClassComplexity) @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since: 100.0.2

Definition at line 28 of file Multishipping.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Checkout\Model\Session	$checkoutSession,
		\Magento\Customer\Model\Session	$customerSession,
		\Magento\Sales\Model\OrderFactory	$orderFactory,
		AddressRepositoryInterface	$addressRepository,
		\Magento\Framework\Event\ManagerInterface	$eventManager,
		\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig,
		\Magento\Framework\Session\Generic	$session,
		\Magento\Quote\Model\Quote\AddressFactory	$addressFactory,
		\Magento\Quote\Model\Quote\Address\ToOrder	$quoteAddressToOrder,
		\Magento\Quote\Model\Quote\Address\ToOrderAddress	$quoteAddressToOrderAddress,
		\Magento\Quote\Model\Quote\Payment\ToOrderPayment	$quotePaymentToOrderPayment,
		\Magento\Quote\Model\Quote\Item\ToOrderItem	$quoteItemToOrderItem,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Payment\Model\Method\SpecificationInterface	$paymentSpecification,
		\Magento\Multishipping\Helper\Data	$helper,
		OrderSender	$orderSender,
		PriceCurrencyInterface	$priceCurrency,
		\Magento\Quote\Api\CartRepositoryInterface	$quoteRepository,
		\Magento\Framework\Api\SearchCriteriaBuilder	$searchCriteriaBuilder,
		\Magento\Framework\Api\FilterBuilder	$filterBuilder,
		\Magento\Quote\Model\Quote\TotalsCollector	$totalsCollector,
		array	$data = `[]`,
		\Magento\Quote\Api\Data\CartExtensionFactory	$cartExtensionFactory = `null`,
		AllowedCountries	$allowedCountryReader = `null`,
		Multishipping\PlaceOrderFactory	$placeOrderFactory = `null`,
		LoggerInterface	$logger = `null`,
		\Magento\Framework\Api\DataObjectHelper	$dataObjectHelper = `null`
	)

Parameters

\Magento\Checkout\Model\Session	$checkoutSession
\Magento\Customer\Model\Session	$customerSession
\Magento\Sales\Model\OrderFactory	$orderFactory
AddressRepositoryInterface	$addressRepository
\Magento\Framework\Event\ManagerInterface	$eventManager
\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig
\Magento\Framework\Session\Generic	$session
\Magento\Quote\Model\Quote\AddressFactory	$addressFactory
\Magento\Quote\Model\Quote\Address\ToOrder	$quoteAddressToOrder
\Magento\Quote\Model\Quote\Address\ToOrderAddress	$quoteAddressToOrderAddress
\Magento\Quote\Model\Quote\Payment\ToOrderPayment	$quotePaymentToOrderPayment
\Magento\Quote\Model\Quote\Item\ToOrderItem	$quoteItemToOrderItem
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Payment\Model\Method\SpecificationInterface	$paymentSpecification
\Magento\Multishipping\Helper\Data	$helper
OrderSender	$orderSender
PriceCurrencyInterface	$priceCurrency
\Magento\Quote\Api\CartRepositoryInterface	$quoteRepository
\Magento\Framework\Api\SearchCriteriaBuilder	$searchCriteriaBuilder
\Magento\Framework\Api\FilterBuilder	$filterBuilder
\Magento\Quote\Model\Quote\TotalsCollector	$totalsCollector
array	$data
\Magento\Quote\Api\Data\CartExtensionFactory \| null	$cartExtensionFactory
AllowedCountries \| null	$allowedCountryReader
Multishipping\PlaceOrderFactory \| null	$placeOrderFactory
LoggerInterface \| null	$logger
\Magento\Framework\Api\DataObjectHelper \| null	$dataObjectHelper	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 208 of file Multishipping.php.

       {
         $this->_eventManager = $eventManager;
         $this->_scopeConfig = $scopeConfig;
         $this->_session = $session;
         $this->_addressFactory = $addressFactory;
         $this->_storeManager = $storeManager;
         $this->paymentSpecification = $paymentSpecification;
         $this->helper = $helper;
         $this->_checkoutSession = $checkoutSession;
         $this->_customerSession = $customerSession;
         $this->_orderFactory = $orderFactory;
         $this->addressRepository = $addressRepository;
         $this->orderSender = $orderSender;
         $this->priceCurrency = $priceCurrency;
         $this->quoteRepository = $quoteRepository;
         $this->searchCriteriaBuilder = $searchCriteriaBuilder;
         $this->filterBuilder = $filterBuilder;
         $this->quoteAddressToOrder = $quoteAddressToOrder;
         $this->quoteItemToOrderItem = $quoteItemToOrderItem;
         $this->quotePaymentToOrderPayment = $quotePaymentToOrderPayment;
         $this->quoteAddressToOrderAddress = $quoteAddressToOrderAddress;
         $this->totalsCollector = $totalsCollector;
         $this->cartExtensionFactory = $cartExtensionFactory ?: ObjectManager::getInstance()
             ->get(\Magento\Quote\Api\Data\CartExtensionFactory::class);
         $this->allowedCountryReader = $allowedCountryReader ?: ObjectManager::getInstance()
             ->get(AllowedCountries::class);
         $this->placeOrderFactory = $placeOrderFactory ?: ObjectManager::getInstance()
             ->get(Multishipping\PlaceOrderFactory::class);
         $this->logger = $logger ?: ObjectManager::getInstance()
             ->get(LoggerInterface::class);
         $this->dataObjectHelper = $dataObjectHelper ?: ObjectManager::getInstance()
             ->get(\Magento\Framework\Api\DataObjectHelper::class);
         parent::__construct($data);
         $this->_init();
     }

Member Function Documentation

◆ _addShippingItem()

_addShippingItem	(	$quoteItemId,
		$data
	)

protected

Add quote item to specific shipping address based on customer address id

Parameters

int	$quoteItemId
array	$data	array('qty'=>$qty, 'address'=>$customerAddressId)

Exceptions

Skip item processing if qty 0

Require shipping rate recollect

Definition at line 507 of file Multishipping.php.

     {
         $qty = isset($data['qty']) ? (int)$data['qty'] : 1;
         //$qty       = $qty > 0 ? $qty : 1;
         $addressId = isset($data['address']) ? $data['address'] : false;
         $quoteItem = $this->getQuote()->getItemById($quoteItemId);
 
         if ($addressId && $quoteItem) {
             if (!$this->isAddressIdApplicable($addressId)) {
                 throw new LocalizedException(__('Verify the shipping address information and continue.'));
             }
 
             if ($qty === 0) {
                 return $this;
             }
             $quoteItem->setMultishippingQty((int)$quoteItem->getMultishippingQty() + $qty);
             $quoteItem->setQty($quoteItem->getMultishippingQty());
             try {
                 $address = $this->addressRepository->getById($addressId);
             } catch (\Exception $e) {
             }
             if (isset($address)) {
                 if (!($quoteAddress = $this->getQuote()->getShippingAddressByCustomerAddressId($address->getId()))) {
                     $quoteAddress = $this->_addressFactory->create()->importCustomerAddressData($address);
                     $this->getQuote()->addShippingAddress($quoteAddress);
                 }
 
                 $quoteAddress = $this->getQuote()->getShippingAddressByCustomerAddressId($address->getId());
                 $quoteAddress->setCustomerAddressId($addressId);
                 $quoteAddressItem = $quoteAddress->getItemByQuoteItemId($quoteItemId);
                 if ($quoteAddressItem) {
                     $quoteAddressItem->setQty((int)($quoteAddressItem->getQty() + $qty));
                 } else {
                     $quoteAddress->addItem($quoteItem, $qty);
                 }
                 $quoteAddress->setCollectShippingRates((bool)$this->getCollectRatesFlag());
             }
         }
         return $this;
     }

◆ _init()

_init ( )

protected

Initialize multishipping checkout.

Split virtual/not virtual items between default billing/shipping addresses

Returns: \Magento\Multishipping\Model\Checkout\Type\Multishipping @SuppressWarnings(PHPMD.CyclomaticComplexity)

reset quote shipping addresses and items

Remove all addresses

Items with parent id we add in importQuoteItem method. Skip virtual items

Definition at line 280 of file Multishipping.php.

     {
         $quote = $this->getQuote();
         if (!$this->getCustomer()->getId()) {
             return $this;
         }
 
         if ($this->getCheckoutSession()->getCheckoutState() === \Magento\Checkout\Model\Session::CHECKOUT_STATE_BEGIN
         ) {
             $this->getCheckoutSession()->setCheckoutState(true);
             $addresses = $quote->getAllAddresses();
             foreach ($addresses as $address) {
                 $quote->removeAddress($address->getId());
             }
 
             $defaultShippingId = $this->getCustomerDefaultShippingAddress();
             if ($defaultShippingId) {
                 $quote->getShippingAddress()->importCustomerAddressData(
                     $this->addressRepository->getById($defaultShippingId)
                 );
 
                 foreach ($this->getQuoteItems() as $item) {
                     if ($item->getParentItemId() || $item->getProduct()->getIsVirtual()) {
                         continue;
                     }
                     $quote->getShippingAddress()->addItem($item);
                 }
             }
 
             $defaultBillingAddressId = $this->getCustomerDefaultBillingAddress();
             if ($defaultBillingAddressId) {
                 $quote->getBillingAddress()->importCustomerAddressData(
                     $this->addressRepository->getById($defaultBillingAddressId)
                 );
                 foreach ($this->getQuoteItems() as $item) {
                     if ($item->getParentItemId()) {
                         continue;
                     }
                     if ($item->getProduct()->getIsVirtual()) {
                         $quote->getBillingAddress()->addItem($item);
                     }
                 }
             }
             $this->save();
         }
         return $this;
     }

◆ _prepareOrder()

_prepareOrder ( \Magento\Quote\Model\Quote\Address $address )

protected

Prepare order based on quote address

Parameters

\Magento\Quote\Model\Quote\Address $address

Returns: \Magento\Sales\Model\Order

Exceptions

Definition at line 675 of file Multishipping.php.

     {
         $quote = $this->getQuote();
         $quote->unsReservedOrderId();
         $quote->reserveOrderId();
         $quote->collectTotals();
 
         $order = $this->_orderFactory->create();
 
         $this->dataObjectHelper->mergeDataObjects(
             \Magento\Sales\Api\Data\OrderInterface::class,
             $order,
             $this->quoteAddressToOrder->convert($address)
         );
 
         $order->setQuote($quote);
         $order->setBillingAddress($this->quoteAddressToOrderAddress->convert($quote->getBillingAddress()));
 
         if ($address->getAddressType() == 'billing') {
             $order->setIsVirtual(1);
         } else {
             $order->setShippingAddress($this->quoteAddressToOrderAddress->convert($address));
             $order->setShippingMethod($address->getShippingMethod());
         }
 
         $order->setPayment($this->quotePaymentToOrderPayment->convert($quote->getPayment()));
         if ($this->priceCurrency->round($address->getGrandTotal()) == 0) {
             $order->getPayment()->setMethod('free');
         }
 
         foreach ($address->getAllItems() as $item) {
             $_quoteItem = $item->getQuoteItem();
             if (!$_quoteItem) {
                 throw new \Magento\Checkout\Exception(
                     __("The item isn't found, or it's already ordered.")
                 );
             }
             $item->setProductType(
                 $_quoteItem->getProductType()
             )->setProductOptions(
                 $_quoteItem->getProduct()->getTypeInstance()->getOrderOptions($_quoteItem->getProduct())
             );
             $orderItem = $this->quoteItemToOrderItem->convert($item);
             if ($item->getParentItem()) {
                 $orderItem->setParentItem($order->getItemByQuoteItemId($item->getParentItem()->getId()));
             }
             $order->addItem($orderItem);
         }
 
         return $order;
     }

◆ getCheckoutSession()

getCheckoutSession ( )

Retrieve checkout session model

Returns: \Magento\Checkout\Model\Session

Definition at line 1025 of file Multishipping.php.

     {
         $checkout = $this->getData('checkout_session');
         if ($checkout === null) {
             $checkout = $this->_checkoutSession;
             $this->setData('checkout_session', $checkout);
         }
         return $checkout;
     }

◆ getCustomer()

getCustomer ( )

Retrieve customer object

Returns: \Magento\Customer\Api\Data\CustomerInterface

Definition at line 1070 of file Multishipping.php.

     {
         return $this->_customerSession->getCustomerDataObject();
     }

◆ getCustomerDefaultBillingAddress()

getCustomerDefaultBillingAddress ( )

Retrieve customer default billing address

Returns: int|null

Definition at line 971 of file Multishipping.php.

     {
         $defaultAddressId = $this->getCustomer()->getDefaultBilling();
         return $this->getDefaultAddressByDataKey('customer_default_billing_address', $defaultAddressId);
     }

◆ getCustomerDefaultShippingAddress()

getCustomerDefaultShippingAddress ( )

Retrieve customer default shipping address

Returns: int|null

Definition at line 982 of file Multishipping.php.

     {
         $defaultAddressId = $this->getCustomer()->getDefaultShipping();
         return $this->getDefaultAddressByDataKey('customer_default_shipping_address', $defaultAddressId);
     }

◆ getCustomerSession()

getCustomerSession ( )

Retrieve customer session model

Returns: \Magento\Customer\Model\Session

Definition at line 1060 of file Multishipping.php.

     {
         return $this->_customerSession;
     }

◆ getMinimumAmountDescription()

getMinimumAmountDescription ( )

Get notification message for case when multishipping checkout is not allowed

Returns: string

Definition at line 916 of file Multishipping.php.

     {
         $descr = $this->_scopeConfig->getValue(
             'sales/minimum_order/multi_address_description',
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE
         );
         if (empty($descr)) {
             $descr = $this->_scopeConfig->getValue(
                 'sales/minimum_order/description',
                 \Magento\Store\Model\ScopeInterface::SCOPE_STORE
             );
         }
         return $descr;
     }

◆ getMinimumAmountError()

getMinimumAmountError ( )

Get minimum amount error.

Returns: string

Definition at line 936 of file Multishipping.php.

     {
         $error = $this->_scopeConfig->getValue(
             'sales/minimum_order/multi_address_error_message',
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE
         );
         if (empty($error)) {
             $error = $this->_scopeConfig->getValue(
                 'sales/minimum_order/error_message',
                 \Magento\Store\Model\ScopeInterface::SCOPE_STORE
             );
         }
         return $error;
     }

◆ getOrderIds()

getOrderIds ( $asAssoc = false )

Get order IDs created during checkout

Parameters

bool $asAssoc

Returns: array

Definition at line 957 of file Multishipping.php.

     {
         $idsAssoc = $this->_session->getOrderIds();
         if ($idsAssoc !== null) {
             return $asAssoc ? $idsAssoc : array_keys($idsAssoc);
         }
         return [];
     }

◆ getQuote()

getQuote ( )

Retrieve quote model

Returns: \Magento\Quote\Model\Quote

Definition at line 1040 of file Multishipping.php.

     {
         return $this->getCheckoutSession()->getQuote();
     }

◆ getQuoteItems()

getQuoteItems ( )

Retrieve quote items

Returns: \Magento\Quote\Model\Quote\Item[]

Definition at line 1050 of file Multishipping.php.

     {
         return $this->getQuote()->getAllItems();
     }

◆ getQuoteShippingAddressesItems()

getQuoteShippingAddressesItems ( )

Get quote items assigned to different quote addresses populated per item qty.

Based on result array we can display each item separately

Returns: array

Definition at line 345 of file Multishipping.php.

     {
         if ($this->_quoteShippingAddressesItems !== null) {
             return $this->_quoteShippingAddressesItems;
         }
         $this->_quoteShippingAddressesItems = $this->getQuote()->getShippingAddressesItems();
         return $this->_quoteShippingAddressesItems;
     }

◆ removeAddressItem()

removeAddressItem	(	$addressId,
		$itemId
	)

Remove item from address

Parameters

int	$addressId
int	$itemId

Returns: \Magento\Multishipping\Model\Checkout\Type\Multishipping

Require shipping rate recollect

Definition at line 361 of file Multishipping.php.

     {
         $address = $this->getQuote()->getAddressById($addressId);
         /* @var $address \Magento\Quote\Model\Quote\Address */
         if ($address) {
             $item = $address->getValidItemById($itemId);
             if ($item) {
                 if ($item->getQty() > 1 && !$item->getProduct()->getIsVirtual()) {
                     $item->setQty($item->getQty() - 1);
                 } else {
                     $address->removeItem($item->getId());
                 }
 
                 $address->setCollectShippingRates((bool)$this->getCollectRatesFlag());
 
                 if (count($address->getAllItems()) == 0) {
                     $address->isDeleted(true);
                 }
 
                 $quoteItem = $this->getQuote()->getItemById($item->getQuoteItemId());
                 if ($quoteItem) {
                     $newItemQty = $quoteItem->getQty() - 1;
                     if ($newItemQty > 0 && !$item->getProduct()->getIsVirtual()) {
                         $quoteItem->setQty($quoteItem->getQty() - 1);
                     } else {
                         $this->getQuote()->removeItem($quoteItem->getId());
                     }
                 }
                 $this->save();
             }
         }
         return $this;
     }

◆ reset()

reset ( )

Specify BEGIN state in checkout session whot allow reinit multishipping checkout

Returns: \Magento\Multishipping\Model\Checkout\Type\Multishipping

Definition at line 889 of file Multishipping.php.

     {
         $this->getCheckoutSession()->setCheckoutState(\Magento\Checkout\Model\Session::CHECKOUT_STATE_BEGIN);
         return $this;
     }

◆ save()

save ( )

Collect quote totals and save quote object

Returns: \Magento\Multishipping\Model\Checkout\Type\Multishipping

Definition at line 877 of file Multishipping.php.

     {
         $this->getQuote()->collectTotals();
         $this->quoteRepository->save($this->getQuote());
         return $this;
     }

◆ setPaymentMethod()

setPaymentMethod ( $payment )

Set payment method info to quote payment

Parameters

array $payment

Returns: \Magento\Multishipping\Model\Checkout\Type\Multishipping

Exceptions

Definition at line 642 of file Multishipping.php.

     {
         if (!isset($payment['method'])) {
             throw new \Magento\Framework\Exception\LocalizedException(
                 __("A payment method isn't defined. Verify and try again.")
             );
         }
         if (!$this->paymentSpecification->isSatisfiedBy($payment['method'])) {
             throw new \Magento\Framework\Exception\LocalizedException(
                 __(
                     "This payment method can't be used for shipping to multiple addresses. "
                     . "Change the payment method and try again."
                 )
             );
         }
         $quote = $this->getQuote();
         $quote->getPayment()->importData($payment);
         // shipping totals may be affected by payment method
         if (!$quote->isVirtual() && $quote->getShippingAddress()) {
             $quote->getShippingAddress()->setCollectShippingRates(true);
             $quote->setTotalsCollectedFlag(false)->collectTotals();
         }
         $this->quoteRepository->save($quote);
         return $this;
     }

◆ setQuoteCustomerBillingAddress()

setQuoteCustomerBillingAddress ( $addressId )

Reimport customer billing address to quote

Parameters

int $addressId customer address id

Exceptions

Definition at line 588 of file Multishipping.php.

     {
         if (!$this->isAddressIdApplicable($addressId)) {
             throw new LocalizedException(__('Verify the billing address information and continue.'));
         }
         try {
             $address = $this->addressRepository->getById($addressId);
         } catch (\Exception $e) {
             //
         }
         if (isset($address)) {
             $quoteAddress = $this->getQuote()->getBillingAddress($addressId)->importCustomerAddressData($address);
             $this->totalsCollector->collectAddressTotals($this->getQuote(), $quoteAddress);
             $this->getQuote()->collectTotals();
             $this->quoteRepository->save($this->getQuote());
         }
 
         return $this;
     }

◆ setShippingItemsInformation()

setShippingItemsInformation ( $info )

Assign quote items to addresses and specify items qty

Array structure: array( $quoteItemId => array( 'qty' => $qty, 'address' => $customerAddressId ) )

Parameters

array $info

Returns: \Magento\Multishipping\Model\Checkout\Type\Multishipping

Exceptions

Delete all not virtual quote items which are not added to shipping address MultishippingQty should be defined for each quote item when it processed with _addShippingItem

Definition at line 415 of file Multishipping.php.

     {
         if (is_array($info)) {
             $allQty = 0;
             $itemsInfo = [];
             foreach ($info as $itemData) {
                 foreach ($itemData as $quoteItemId => $data) {
                     $allQty += $data['qty'];
                     $itemsInfo[$quoteItemId] = $data;
                 }
             }
 
             $maxQty = $this->helper->getMaximumQty();
             if ($allQty > $maxQty) {
                 throw new \Magento\Framework\Exception\LocalizedException(
                     __(
                         "The maximum quantity can't be more than %1 when shipping to multiple addresses. "
                         . "Change the quantity and try again.",
                         $maxQty
                     )
                 );
             }
             $quote = $this->getQuote();
             $addresses = $quote->getAllShippingAddresses();
             foreach ($addresses as $address) {
                 $quote->removeAddress($address->getId());
             }
 
             foreach ($info as $itemData) {
                 foreach ($itemData as $quoteItemId => $data) {
                     $this->_addShippingItem($quoteItemId, $data);
                 }
             }
 
             $this->prepareShippingAssignment($quote);
 
             foreach ($quote->getAllItems() as $_item) {
                 if (!$_item->getProduct()->getIsVirtual() && !$_item->getParentItem() && !$_item->getMultishippingQty()
                 ) {
                     $quote->removeItem($_item->getId());
                 }
             }
 
             $billingAddress = $quote->getBillingAddress();
             if ($billingAddress) {
                 $quote->removeAddress($billingAddress->getId());
             }
 
             $customerDefaultBillingId = $this->getCustomerDefaultBillingAddress();
             if ($customerDefaultBillingId) {
                 $quote->getBillingAddress()->importCustomerAddressData(
                     $this->addressRepository->getById($customerDefaultBillingId)
                 );
             }
 
             foreach ($quote->getAllItems() as $_item) {
                 if (!$_item->getProduct()->getIsVirtual()) {
                     continue;
                 }
 
                 if (isset($itemsInfo[$_item->getId()]['qty'])) {
                     $qty = (int)$itemsInfo[$_item->getId()]['qty'];
                     if ($qty) {
                         $_item->setQty($qty);
                         $quote->getBillingAddress()->addItem($_item);
                     } else {
                         $_item->setQty(0);
                         $quote->removeItem($_item->getId());
                     }
                 }
             }
 
             $this->save();
             $this->_eventManager->dispatch('checkout_type_multishipping_set_shipping_items', ['quote' => $quote]);
         }
         return $this;
     }

◆ updateQuoteCustomerShippingAddress()

updateQuoteCustomerShippingAddress ( $addressId )

Reimport customer address info to quote shipping address

Parameters

int $addressId customer address id

Exceptions

Definition at line 561 of file Multishipping.php.

     {
         if (!$this->isAddressIdApplicable($addressId)) {
             throw new LocalizedException(__('Verify the shipping address information and continue.'));
         }
         try {
             $address = $this->addressRepository->getById($addressId);
         } catch (\Exception $e) {
             //
         }
         if (isset($address)) {
             $quoteAddress = $this->getQuote()->getShippingAddressByCustomerAddressId($addressId);
             $quoteAddress->setCollectShippingRates(true)->importCustomerAddressData($address);
             $this->totalsCollector->collectAddressTotals($this->getQuote(), $quoteAddress);
             $this->quoteRepository->save($this->getQuote());
         }
 
         return $this;
     }

◆ validateMinimumAmount()

validateMinimumAmount ( )

Check if quote amount is allowed for multishipping checkout

Returns: bool

Definition at line 900 of file Multishipping.php.

     {
         return !($this->_scopeConfig->isSetFlag(
             'sales/minimum_order/active',
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE
         ) && $this->_scopeConfig->isSetFlag(
             'sales/minimum_order/multi_address',
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE
         ) && !$this->getQuote()->validateMinimumAmount());
     }

Field Documentation

◆ $_addressFactory

$_addressFactory

protected

Definition at line 64 of file Multishipping.php.

◆ $_checkoutSession

$_checkoutSession

protected

Definition at line 81 of file Multishipping.php.

◆ $_customerSession

$_customerSession

protected

Definition at line 86 of file Multishipping.php.

◆ $_eventManager

$_eventManager = null

protected

Definition at line 42 of file Multishipping.php.

◆ $_orderFactory

$_orderFactory

protected

Definition at line 91 of file Multishipping.php.

◆ $_quoteShippingAddressesItems

$_quoteShippingAddressesItems

protected

Definition at line 35 of file Multishipping.php.

◆ $_scopeConfig

$_scopeConfig

protected

Definition at line 49 of file Multishipping.php.

◆ $_session

$_session

protected

Definition at line 54 of file Multishipping.php.

◆ $_storeManager

$_storeManager

protected

Definition at line 59 of file Multishipping.php.

◆ $addressRepository

$addressRepository

protected

Definition at line 96 of file Multishipping.php.

◆ $filterBuilder

$filterBuilder

protected

Definition at line 121 of file Multishipping.php.

◆ $helper

$helper

protected

Definition at line 76 of file Multishipping.php.

◆ $orderSender

$orderSender

protected

Definition at line 101 of file Multishipping.php.

◆ $paymentSpecification

$paymentSpecification

protected

Definition at line 69 of file Multishipping.php.

◆ $priceCurrency

$priceCurrency

protected

Definition at line 106 of file Multishipping.php.

◆ $quoteAddressToOrder

$quoteAddressToOrder

protected

Definition at line 126 of file Multishipping.php.

◆ $quoteAddressToOrderAddress

$quoteAddressToOrderAddress

protected

Definition at line 141 of file Multishipping.php.

◆ $quoteItemToOrderItem

$quoteItemToOrderItem

protected

Definition at line 131 of file Multishipping.php.

◆ $quotePaymentToOrderPayment

$quotePaymentToOrderPayment

protected

Definition at line 136 of file Multishipping.php.

◆ $quoteRepository

$quoteRepository

protected

Definition at line 111 of file Multishipping.php.

◆ $searchCriteriaBuilder

$searchCriteriaBuilder

protected

Definition at line 116 of file Multishipping.php.

◆ $totalsCollector

$totalsCollector

protected

Definition at line 146 of file Multishipping.php.

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

vendor/magento/module-multishipping/Model/Checkout/Type/Multishipping.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _addShippingItem()

◆ _init()

◆ _prepareOrder()

◆ getCheckoutSession()

◆ getCustomer()

◆ getCustomerDefaultBillingAddress()

◆ getCustomerDefaultShippingAddress()

◆ getCustomerSession()

◆ getMinimumAmountDescription()

◆ getMinimumAmountError()

◆ getOrderIds()

◆ getQuote()

◆ getQuoteItems()

◆ getQuoteShippingAddressesItems()

◆ removeAddressItem()

◆ reset()

◆ save()

◆ setPaymentMethod()

◆ setQuoteCustomerBillingAddress()

◆ setShippingItemsInformation()

◆ updateQuoteCustomerShippingAddress()

◆ validateMinimumAmount()

Field Documentation

◆ $_addressFactory

◆ $_checkoutSession

◆ $_customerSession

◆ $_eventManager

◆ $_orderFactory

◆ $_quoteShippingAddressesItems

◆ $_scopeConfig

◆ $_session

◆ $_storeManager

◆ $addressRepository

◆ $filterBuilder

◆ $helper

◆ $orderSender

◆ $paymentSpecification

◆ $priceCurrency

◆ $quoteAddressToOrder

◆ $quoteAddressToOrderAddress

◆ $quoteItemToOrderItem

◆ $quotePaymentToOrderPayment

◆ $quoteRepository

◆ $searchCriteriaBuilder

◆ $totalsCollector