How is \Magento\Sales\Model\Order::cancel() implemented and used?

dmitry_fedyuk · May 5, 2016, 10:44pm

Context: How to cancel an order programmatically?

Implementation

magento/magento2/blob/6ce74b2/app/code/Magento/Sales/Model/Order.php#L1100-L1115


/**
 * Cancel order
 *
 * @return $this
 */
public function cancel()
{
    if ($this->canCancel()) {
        $this->getPayment()->cancel();
        $this->registerCancellation();


        $this->_eventManager->dispatch('order_cancel_after', ['order' => $this]);
    }


    return $this;
}

Details:

Usages

1. \Magento\Authorizenet\Controller\Adminhtml\Authorizenet\Directpost\Payment\Redirect::execute()

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Authorizenet/Controller/Adminhtml/Authorizenet/Directpost/Payment/Redirect.php#L104-L116


//cancel old order
$oldOrder = $this->_getOrderCreateModel()->getSession()->getOrder();
if ($oldOrder->getId()) {
    /* @var $order \Magento\Sales\Model\Order */
    $order = $this->_objectManager->create('Magento\Sales\Model\Order')
        ->loadByIncrementId($redirectParams['x_invoice_num']);


    if ($order->getId()) {
        $oldOrder->cancel()->save();
        $order->save();
        $this->_getOrderCreateModel()->getSession()->unsOrderId();
    }
}

2. \Magento\Paypal\Controller\Express\AbstractExpress\Cancel::execute()

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Paypal/Controller/Express/AbstractExpress/Cancel.php#L23-L41


// if there is an order - cancel it
$orderId = $this->_getCheckoutSession()->getLastOrderId();
/** @var \Magento\Sales\Model\Order $order */
$order = $orderId ? $this->_orderFactory->create()->load($orderId) : false;
if ($order && $order->getId() && $order->getQuoteId() == $this->_getCheckoutSession()->getQuoteId()) {
    $order->cancel()->save();
    $this->_getCheckoutSession()
        ->unsLastQuoteId()
        ->unsLastSuccessQuoteId()
        ->unsLastOrderId()
        ->unsLastRealOrderId();
    $this->messageManager->addSuccessMessage(
        __('Express Checkout and Order have been canceled.')
    );
} else {
    $this->messageManager->addSuccessMessage(
        __('Express Checkout has been canceled.')
    );
}

3. \Magento\Sales\Controller\Adminhtml\Order\Cancel::execute()

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Sales/Controller/Adminhtml/Order/Cancel.php#L26-L27


$this->orderManagement->cancel($order->getEntityId());
$this->messageManager->addSuccess(__('You canceled the order.'));

4. \Magento\Sales\Controller\Adminhtml\Order\MassCancel::massAction()

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Sales/Controller/Adminhtml/Order/MassCancel.php#L32-L42


protected function massAction(AbstractCollection $collection)
{
    $countCancelOrder = 0;
    foreach ($collection->getItems() as $order) {
        if (!$order->canCancel()) {
            continue;
        }
        $order->cancel();
        $order->save();
        $countCancelOrder++;
    }

5. \Magento\Sales\Model\AdminOrder\Create::createOrder()

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Sales/Model/AdminOrder/Create.php#L1873-L1879


if ($this->getSession()->getOrder()->getId()) {
    $oldOrder = $this->getSession()->getOrder();
    $oldOrder->setRelationChildId($order->getId());
    $oldOrder->setRelationChildRealId($order->getIncrementId());
    $this->orderManagement->cancel($oldOrder->getEntityId());
    $order->save();
}

6. \Magento\Sales\Model\Service\OrderService::cancel()

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Sales/Model/Service/OrderService.php#L81-L96


/**
 * Order cancel
 *
 * @param int $id
 * @return bool
 */
public function cancel($id)
{
    $order = $this->orderRepository->get($id);
    if ((bool)$order->cancel()) {
        $this->orderRepository->save($order);
        return true;
    }


    return false;
}

Details: How to cancel an order by the /V1/orders/:id/cancel Web API?