How is \Magento\Paypal\Helper\Checkout::cancelCurrentOrder() implemented and used?

dmitry_fedyuk · May 5, 2016, 7:06am

Implementation

magento/magento2/blob/981d1f/app/code/Magento/Paypal/Helper/Checkout.php#L29-L43


/**
 * Cancel last placed order with specified comment message
 *
 * @param string $comment Comment appended to order history
 * @return bool True if order cancelled, false otherwise
 */
public function cancelCurrentOrder($comment)
{
    $order = $this->session->getLastRealOrder();
    if ($order->getId() && $order->getState() != Order::STATE_CANCELED) {
        $order->registerCancellation($comment)->save();
        return true;
    }
    return false;
}

Details:

Usages

1. \Magento\Paypal\Controller\Payflow::_cancelPayment()

github.com

magento/magento2/blob/981d1f/app/code/Magento/Paypal/Controller/Payflow.php#L68-L86


/**
 * Cancel order, return quote to customer
 *
 * @param string $errorMsg
 * @return false|string
 */
protected function _cancelPayment($errorMsg = '')
{
    $errorMsg = trim(strip_tags($errorMsg));


    $gotoSection = false;
    $this->_checkoutHelper->cancelCurrentOrder($errorMsg);
    if ($this->_checkoutSession->restoreQuote()) {
        //Redirect to payment step
        $gotoSection = 'paymentMethod';
    }


    return $gotoSection;
}

2. \Magento\Paypal\Controller\Hostedpro\Cancel::execute()

github.com

magento/magento2/blob/981d1f/app/code/Magento/Paypal/Controller/Hostedpro/Cancel.php#L31-L42


/**
 * Customer canceled payment on gateway side.
 *
 * @return void
 */
public function execute()
{
    $this->checkoutHelper->cancelCurrentOrder('');
    $this->checkoutHelper->restoreQuote();


    $this->_redirect('checkout', ['_fragment' => 'payment']);
}