How is the multishipping order placement scenario implemented?

dmitrii_fediuk · August 24, 2017, 8:54pm

1. The `multishipping/checkout/overview` page:

The «Place Order» button sends request to multishipping/checkout/overviewPost:

2. Magento\Multishipping\Controller\Checkout\OverviewPost::execute()

magento/magento2/blob/2.2.0-rc2.2/app/code/Magento/Multishipping/Controller/Checkout/OverviewPost.php#L64-L146


/**
 * Overview action
 *
 * @return void
 * @SuppressWarnings(PHPMD.CyclomaticComplexity)
 */
public function execute()
{
    if (!$this->formKeyValidator->validate($this->getRequest())) {
        $this->_forward('backToAddresses');
        return;
    }
    if (!$this->_validateMinimumAmount()) {
        return;
    }


    try {
        if (!$this->agreementsValidator->isValid(array_keys($this->getRequest()->getPost('agreement', [])))) {
            $this->messageManager->addError(
                __('Please agree to all Terms and Conditions before placing the order.')
            );
            $this->_redirect('*/*/billing');
            return;
        }


        $payment = $this->getRequest()->getPost('payment');
        $paymentInstance = $this->_getCheckout()->getQuote()->getPayment();
        if (isset($payment['cc_number'])) {
            $paymentInstance->setCcNumber($payment['cc_number']);
        }
        if (isset($payment['cc_cid'])) {
            $paymentInstance->setCcCid($payment['cc_cid']);
        }
        $this->_getCheckout()->createOrders();
        $this->_getState()->setActiveStep(State::STEP_SUCCESS);
        $this->_getState()->setCompleteStep(State::STEP_OVERVIEW);
        $this->_getCheckout()->getCheckoutSession()->clearQuote();
        $this->_getCheckout()->getCheckoutSession()->setDisplaySuccess(true);
        $this->_redirect('*/*/success');
    } catch (PaymentException $e) {
        $message = $e->getMessage();
        if (!empty($message)) {
            $this->messageManager->addError($message);
        }
        $this->_redirect('*/*/billing');
    } catch (\Magento\Checkout\Exception $e) {
        $this->_objectManager->get(
            \Magento\Checkout\Helper\Data::class
        )->sendPaymentFailedEmail(
            $this->_getCheckout()->getQuote(),
            $e->getMessage(),
            'multi-shipping'
        );
        $this->_getCheckout()->getCheckoutSession()->clearQuote();
        $this->messageManager->addError($e->getMessage());
        $this->_redirect('*/cart');
    } catch (\Magento\Framework\Exception\LocalizedException $e) {
        $this->_objectManager->get(
            \Magento\Checkout\Helper\Data::class
        )->sendPaymentFailedEmail(
            $this->_getCheckout()->getQuote(),
            $e->getMessage(),
            'multi-shipping'
        );
        $this->messageManager->addError($e->getMessage());
        $this->_redirect('*/*/billing');
    } catch (\Exception $e) {
        $this->logger->critical($e);
        try {
            $this->_objectManager->get(
                \Magento\Checkout\Helper\Data::class
            )->sendPaymentFailedEmail(
                $this->_getCheckout()->getQuote(),
                $e->getMessage(),
                'multi-shipping'
            );
        } catch (\Exception $e) {
            $this->logger->error($e->getMessage());
        }
        $this->messageManager->addError(__('Order place error'));
        $this->_redirect('*/*/billing');
    }
}

Note that Magento 2 creates separate orders for each shipping address:

github.com

magento/magento2/blob/2.2.0-rc2.2/app/code/Magento/Multishipping/Controller/Checkout/OverviewPost.php#L97-L97


$this->_getCheckout()->createOrders();

3. Magento\Multishipping\Model\Checkout\Type\Multishipping::createOrders()

github.com

magento/magento2/blob/2.2.0-rc2.2/app/code/Magento/Multishipping/Model/Checkout/Type/Multishipping.php#L735-L788


/**
 * Create orders per each quote address
 *
 * @return \Magento\Multishipping\Model\Checkout\Type\Multishipping
 * @throws \Exception
 */
public function createOrders()
{
    $orderIds = [];
    $this->_validate();
    $shippingAddresses = $this->getQuote()->getAllShippingAddresses();
    $orders = [];


    if ($this->getQuote()->hasVirtualItems()) {
        $shippingAddresses[] = $this->getQuote()->getBillingAddress();
    }


    try {
        foreach ($shippingAddresses as $address) {
            $order = $this->_prepareOrder($address);


            $orders[] = $order;
            $this->_eventManager->dispatch(
                'checkout_type_multishipping_create_orders_single',
                ['order' => $order, 'address' => $address, 'quote' => $this->getQuote()]
            );
        }


        foreach ($orders as $order) {
            $order->place();
            $order->save();
            if ($order->getCanSendNewEmailFlag()) {
                $this->orderSender->send($order);
            }
            $orderIds[$order->getId()] = $order->getIncrementId();
        }


        $this->_session->setOrderIds($orderIds);
        $this->_checkoutSession->setLastQuoteId($this->getQuote()->getId());


        $this->getQuote()->setIsActive(false);
        $this->quoteRepository->save($this->getQuote());


        $this->_eventManager->dispatch(
            'checkout_submit_all_after',
            ['orders' => $orders, 'quote' => $this->getQuote()]
        );


        return $this;
    } catch (\Exception $e) {
        $this->_eventManager->dispatch('checkout_multishipping_refund_all', ['orders' => $orders]);
        throw $e;
    }
}

4. Magento\Multishipping\Model\Checkout\Type\Multishipping::_prepareOrder()

github.com

magento/magento2/blob/2.2.0-rc2.2/app/code/Magento/Multishipping/Model/Checkout/Type/Multishipping.php#L631-L680


/**
 * Prepare order based on quote address
 *
 * @param   \Magento\Quote\Model\Quote\Address $address
 * @return  \Magento\Sales\Model\Order
 * @throws  \Magento\Checkout\Exception
 */
protected function _prepareOrder(\Magento\Quote\Model\Quote\Address $address)
{
    $quote = $this->getQuote();
    $quote->unsReservedOrderId();
    $quote->reserveOrderId();
    $quote->collectTotals();


    $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->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(
                __('Item not found or 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;
}

5. Magento\Quote\Model\Quote\Address\ToOrder::convert()

github.com

magento/magento2/blob/2.2.0-rc2.2/app/code/Magento/Quote/Model/Quote/Address/ToOrder.php#L58-L93


/**
 * @param Address $object
 * @param array $data
 * @return OrderInterface
 */
public function convert(Address $object, $data = [])
{
    $orderData = $this->objectCopyService->getDataFromFieldset(
        'sales_convert_quote_address',
        'to_order',
        $object
    );
    /**
     * @var $order \Magento\Sales\Model\Order
     */
    $order = $this->orderFactory->create();
    $this->dataObjectHelper->populateWithArray(
        $order,
        array_merge($orderData, $data),
        \Magento\Sales\Api\Data\OrderInterface::class
    );
    $order->setStoreId($object->getQuote()->getStoreId())
        ->setQuoteId($object->getQuote()->getId())
        ->setIncrementId($object->getQuote()->getReservedOrderId());
    $this->objectCopyService->copyFieldsetToTarget(
        'sales_convert_quote',
        'to_order',
        $object->getQuote(),
        $order
    );
    $this->eventManager->dispatch(
        'sales_convert_quote_to_order',
        ['order' => $order, 'quote' => $object->getQuote()]
    );
    return $order;
}

6. Magento\Quote\Model\Quote\Payment\ToOrderPayment::convert()

github.com

magento/magento2/blob/2.2.0-rc2.2/app/code/Magento/Quote/Model/Quote/Payment/ToOrderPayment.php#L50-L80


/**
 * @param Payment $object
 * @param array $data
 * @return OrderPaymentInterface
 */
public function convert(Payment $object, $data = [])
{
    $paymentData = $this->objectCopyService->getDataFromFieldset(
        'quote_convert_payment',
        'to_order_payment',
        $object
    );


    $orderPayment = $this->orderPaymentRepository->create();
    $this->dataObjectHelper->populateWithArray(
        $orderPayment,
        array_merge($paymentData, $data),
        \Magento\Sales\Api\Data\OrderPaymentInterface::class
    );
    $orderPayment->setAdditionalInformation(
        array_merge(
            $object->getAdditionalInformation(),
            [Substitution::INFO_KEY_TITLE => $object->getMethodInstance()->getTitle()]
        )
    );
    // set directly on the model
    $orderPayment->setCcNumber($object->getCcNumber());
    $orderPayment->setCcCid($object->getCcCid());


    return $orderPayment;
}

dmitrii_fediuk · August 27, 2017, 4:10pm

How is the multishipping order placement scenario implemented?

1. The multishipping/checkout/overview page:

2. Magento\Multishipping\Controller\Checkout\OverviewPost::execute()

3. Magento\Multishipping\Model\Checkout\Type\Multishipping::createOrders()

4. Magento\Multishipping\Model\Checkout\Type\Multishipping::_prepareOrder()

5. Magento\Quote\Model\Quote\Address\ToOrder::convert()

6. Magento\Quote\Model\Quote\Payment\ToOrderPayment::convert()

1. The `multishipping/checkout/overview` page: