How is the «Go to Review Your Order» button implemented on the «multishipping/checkout/billing» page?

dmitrii_fediuk · August 27, 2017, 4:06pm

Context: How is the multishipping multishipping/checkout/billing («Billing Information», payment methods) page implemented?

1. Magento_Multishipping::checkout/billing.phtml

github.com

magento/magento2/blob/2.2.0-rc2.2/app/code/Magento/Multishipping/view/frontend/templates/checkout/billing.phtml#L66-L66


<button id="payment-continue" type="submit" class="action primary continue"><span><?= /* @escapeNotVerified */ __('Go to Review Your Order') ?></span></button>

2. Magento_Multishipping/js/payment::options()

github.com

magento/magento2/blob/2.2.0-rc2.2/app/code/Magento/Multishipping/view/frontend/web/js/payment.js#L17-L17


continueSelector: '#payment-continue',

3. Magento_Multishipping/js/payment::_create()

github.com

magento/magento2/blob/2.2.0-rc2.2/app/code/Magento/Multishipping/view/frontend/web/js/payment.js#L26-L26


.on('click', this.options.continueSelector, $.proxy(this._submitHandler, this))

4. Magento_Multishipping/js/payment::_submitHandler()

github.com

magento/magento2/blob/2.2.0-rc2.2/app/code/Magento/Multishipping/view/frontend/web/js/payment.js#L125-L136


/**
 * Validate  before form submit
 * @private
 * @param {EventObject} e
 */
_submitHandler: function (e) {
    e.preventDefault();


    if (this._validatePaymentMethod()) {
        this.element.submit();
    }
}

5. Magento_Multishipping/js/payment::_validatePaymentMethod()

github.com

magento/magento2/blob/2.2.0-rc2.2/app/code/Magento/Multishipping/view/frontend/web/js/payment.js#L71-L95


/**
 * make sure one payment method is selected
 * @private
 * @return {Boolean}
 */
_validatePaymentMethod: function () {
    var methods = this.element.find('[name^="payment["]'),
        isValid = false;


    if (methods.length === 0) {
        alert({
            content: $.mage.__('We can\'t complete your order because you don\'t have a payment method set up.')
        });
    } else if (this.options.checkoutPrice <= this.options.minBalance) {
        isValid = true;
    } else if (methods.filter('input:radio:checked').length) {
        isValid = true;
    } else {
        alert({
            content: $.mage.__('Please choose a payment method.')
        });
    }


    return isValid;
},

6. Magento_Multishipping::checkout/billing.phtml - the form’s action

github.com

magento/magento2/blob/2.2.0-rc2.2/app/code/Magento/Multishipping/view/frontend/templates/checkout/billing.phtml#L17-L17


<form action="<?= /* @escapeNotVerified */ $block->getPostActionUrl() ?>" method="post" id="multishipping-billing-form" class="form multicheckout billing">

7. Magento\Multishipping\Block\Checkout\Billing::getPostActionUrl()

github.com

magento/magento2/blob/2.2.0-rc2.2/app/code/Magento/Multishipping/Block/Checkout/Billing.php#L147-L155


/**
 * Retrieve data post destination url
 *
 * @return string
 */
public function getPostActionUrl()
{
    return $this->getUrl('*/*/overview');
}

8. Magento\Multishipping\Controller\Checkout\Overview::execute()

github.com

magento/magento2/blob/2.2.0-rc2.2/app/code/Magento/Multishipping/Controller/Checkout/Overview.php#L13-L48


/**
 * Multishipping checkout place order page
 *
 * @return void
 */
public function execute()
{
    if (!$this->_validateMinimumAmount()) {
        return;
    }


    $this->_getState()->setActiveStep(State::STEP_OVERVIEW);


    try {
        $payment = $this->getRequest()->getPost('payment', []);
        $payment['checks'] = [
            \Magento\Payment\Model\Method\AbstractMethod::CHECK_USE_FOR_COUNTRY,
            \Magento\Payment\Model\Method\AbstractMethod::CHECK_USE_FOR_CURRENCY,
            \Magento\Payment\Model\Method\AbstractMethod::CHECK_ORDER_TOTAL_MIN_MAX,
            \Magento\Payment\Model\Method\AbstractMethod::CHECK_ZERO_TOTAL,
        ];
        $this->_getCheckout()->setPaymentMethod($payment);


        $this->_getState()->setCompleteStep(State::STEP_BILLING);


        $this->_view->loadLayout();
        $this->_view->renderLayout();
    } catch (\Magento\Framework\Exception\LocalizedException $e) {
        $this->messageManager->addError($e->getMessage());
        $this->_redirect('*/*/billing');
    } catch (\Exception $e) {
        $this->_objectManager->get(\Psr\Log\LoggerInterface::class)->critical($e);
        $this->messageManager->addException($e, __('We cannot open the overview page.'));
        $this->_redirect('*/*/billing');
    }
}

9. Magento\Multishipping\Model\Checkout\Type\Multishipping::setPaymentMethod()

github.com

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


/**
 * Set payment method info to quote payment
 *
 * @param array $payment
 * @return \Magento\Multishipping\Model\Checkout\Type\Multishipping
 * @throws \Magento\Framework\Exception\LocalizedException
 */
public function setPaymentMethod($payment)
{
    if (!isset($payment['method'])) {
        throw new \Magento\Framework\Exception\LocalizedException(
            __('A payment method is not defined.')
        );
    }
    if (!$this->paymentSpecification->isSatisfiedBy($payment['method'])) {
        throw new \Magento\Framework\Exception\LocalizedException(
            __('The requested payment method is not available for multishipping.')
        );
    }
    $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;
}

10. Magento\Quote\Model\Quote\Payment::importData()

github.com

magento/magento2/blob/2.2.0-rc2.2/app/code/Magento/Quote/Model/Quote/Payment.php#L161-L204


/**
 * Import data array to payment method object,
 * Method calls quote totals collect because payment method availability
 * can be related to quote totals
 *
 * @param array $data
 * @return $this
 * @throws \Magento\Framework\Exception\LocalizedException
 */
public function importData(array $data)
{
    $data = $this->convertPaymentData($data);
    $data = new \Magento\Framework\DataObject($data);
    $this->_eventManager->dispatch(
        $this->_eventPrefix . '_import_data_before',
        [$this->_eventObject => $this, 'input' => $data]
    );


    $this->setMethod($data->getMethod());
    $method = $this->getMethodInstance();
    $quote = $this->getQuote();


    /**
     * Payment availability related with quote totals.
     * We have to recollect quote totals before checking
     */
    $quote->collectTotals();


    $checks = array_merge($data->getChecks(), $this->additionalChecks);
    $methodSpecification = $this->methodSpecificationFactory->create($checks);
    if (!$method->isAvailable($quote) || !$methodSpecification->isApplicable($method, $quote)) {
        throw new \Magento\Framework\Exception\LocalizedException(
            __('The requested Payment Method is not available.')
        );
    }


    $method->assignData($data);


    /*
     * validating the payment data
     */
    $method->validate();
    return $this;
}

11. Magento\Quote\Model\Quote\Payment::convertPaymentData()

github.com

magento/magento2/blob/2.2.0-rc2.2/app/code/Magento/Quote/Model/Quote/Payment.php#L206-L235


/**
 * Converts request to payment data
 *
 * @param array $rawData
 * @return array
 */
private function convertPaymentData(array $rawData)
{
    $paymentData = [
        PaymentInterface::KEY_METHOD => null,
        PaymentInterface::KEY_PO_NUMBER => null,
        PaymentInterface::KEY_ADDITIONAL_DATA => [],
        'checks' => []
    ];


    foreach (array_keys($rawData) as $requestKey) {
        if (!array_key_exists($requestKey, $paymentData)) {
            $paymentData[PaymentInterface::KEY_ADDITIONAL_DATA][$requestKey] = $rawData[$requestKey];
        } elseif ($requestKey === PaymentInterface::KEY_ADDITIONAL_DATA) {
            $paymentData[PaymentInterface::KEY_ADDITIONAL_DATA] = array_merge(
                $paymentData[PaymentInterface::KEY_ADDITIONAL_DATA],
                (array) $rawData[$requestKey]
            );
        } else {
            $paymentData[$requestKey] = $rawData[$requestKey];
        }
    }


    return $paymentData;
}

dmitrii_fediuk · August 27, 2017, 9:53pm