Magento – Reload Onepage Checkout to specific step

onepage-checkoutpaymentpayment-methodsredirect

I have a payment module for Magento that redirects to an external site to collect the payment info, then upon success it redirects back to the Magento one page checkout page.

Right now when it redirects back to the page it is using some javascript to insert the html input for the payment method and calling payment.save() to get to the review step.

What I want to know is there a better way to reload the one page checkout page and have it go directly to a specific step, in this case the review step?

The way it is now seems like its hacked together and there must be a better way.

Thanks!

Best Answer

The first way that comes to mind is:

To create a new first step in the checkout process that would be called each time. When you are returned from the 3rd party page this would have a URL param set so we know to do something. This requires:

Updating: public/app/code/core/Mage/Checkout/Block/Onepage/Abstract.php

protected function _getStepCodes()
{
    return array('login', 'billing', 'shipping', 'shipping_method', 'payment', 'review');
}

This block gets the available checkout steps. We would include a new one at the beginning for API or whatever make sense to what you are doing.

Then in OnePageController.php ( All should be changed in your own module ) we would need a new step:

public function saveAPIAction()
{
  $this->_expireAjax();
  if ($this->getRequest()->getParam('returned')) {
     $result['goto_section'] = 'review';          
  } else {
     $result['goto_section'] = 'login';
  }
}

Next up would be to change the JS OpCheckout.js this file will need:

this.steps = ['login', 'billing', 'shipping', 'shipping_method', 'payment', 'review'];

Updating to reflect the new step. As well as a full new class adding for API

var Billing = Class.create();
Billing.prototype = {
initialize: function(form, addressUrl, saveUrl){
    this.form = form;
    if ($(this.form)) {
        $(this.form).observe('submit', function(event){this.save();Event.stop(event);}.bind(this));
    }
    this.saveUrl = saveUrl;
    this.onSave = this.nextStep.bindAsEventListener(this);
    this.onComplete = this.resetLoadWaiting.bindAsEventListener(this);
    // would need to add forcing payment save or success redirect 
}
}

Complexity when it comes to all of the above is ensuring that all the options throughout your checkout journey are set. If when the current implementation returns to the current checkout it just calls payment.save then it should be ok as adding to what I have provided will get you going with a new checkout step that does implement almost the same as the current but in a more modular means. You could add more functionality if required.

Related Solutions

Magento – AJAX Auto Update on One Step Checkout

Yes this is the file.

This file contains JavaScript class definitions for the following:

Checkout
Billing
Shipping
ShippingMethod
Payment
Review

For each step you have a save method that does several things, including the AJAX call to the controller.

For example, for the ShippingMethod, this method looks like this:

save: function(){

    if (checkout.loadWaiting!=false) return;
    if (this.validate()) {
        checkout.setLoadWaiting('shipping-method');
        var request = new Ajax.Request(
            this.saveUrl,
            {
                method:'post',
                onComplete: this.onComplete,
                onSuccess: this.onSave,
                onFailure: checkout.ajaxFailure.bind(checkout),
                parameters: Form.serialize(this.form)
            }
        );
    }
},

When the AJAX call is successfull, the code call the onSave binded event listener:

this.onSave = this.nextStep.bindAsEventListener(this);

The nextStep is the method that handle the AJAX response:

nextStep: function(transport){
    if (transport && transport.responseText){
        try{
            response = eval('(' + transport.responseText + ')');
        }
        catch (e) {
            response = {};
        }
    }

    if (response.error) {
        alert(response.message);
        return false;
    }

    if (response.update_section) {
        $('checkout-'+response.update_section.name+'-load').update(response.update_section.html);
    }

    payment.initWhatIsCvvListeners();

    if (response.goto_section) {
        checkout.gotoSection(response.goto_section, true);
        checkout.reloadProgressBlock();
        return;
    }

    if (response.payment_methods_html) {
        $('checkout-payment-method-load').update(response.payment_methods_html);
    }

    checkout.setShippingMethod();
}

Magento – Magento 2 – redirect to final checkout page (checkout success/failed)

You can follow this to achieve your target.

In your cancel controller, I'm naming this Cancel.php

<?php


namespace Magento\SamplePaymentGateway\Controller\Payment;
class Cancel extends \Magento\Framework\App\Action\Action {

    protected $checkoutSession;
    protected $orderRepository;

    /**
     * Constructor
     * 
     * @param \Magento\Framework\App\Action\Context  $context
     * @param \Magento\Framework\View\Result\PageFactory $resultPageFactory
     */
    public function __construct(
        \Magento\Framework\App\Action\Context $context,
        \Magento\Sales\Api\OrderRepositoryInterface $orderRepository,
        \Magento\Checkout\Model\Session $checkoutSession
    )
    {
        $this->checkoutSession = $checkoutSession;
        $this->orderRepository = $orderRepository;

        parent::__construct($context);
    }

    /**
     * Execute view action
     * 
     * @return \Magento\Framework\Controller\ResultInterface
     */
    public function execute()
    {
        $this->messageManager->addError(__('Payment has been cancelled.'));
        /** @var \Magento\Framework\Controller\Result\Redirect $resultRedirect */
        //change order status to cancel
        $order = $this->orderRepository->get($this->checkoutSession->getLastOrderId());
        if ($order) {
            $order->cancel();
            $order->addStatusToHistory(\Magento\Sales\Model\Order::STATE_CANCELED, __('Canceled by customer.'));
            $order->save();
        }

        $resultRedirect = $this->resultRedirectFactory->create();
        $resultRedirect->setPath('checkout/cart');
        return $resultRedirect;
        //return $this->resultPageFactory->create();
    }
}

And your success controller will be more simpler. I'm just showing you the execute() method. Success.php

    public function execute()
    {
        $this->messageManager->addError(__('Payment has been successful.'));            
        $resultRedirect = $this->resultRedirectFactory->create();
        $resultRedirect->setPath('checkout/onepage/success');
        return $resultRedirect;
        //return $this->resultPageFactory->create();
    }

Best Answer

Related Solutions

Magento – AJAX Auto Update on One Step Checkout

Magento – Magento 2 – redirect to final checkout page (checkout success/failed)

Related Topic