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

dmitrii_fediuk · May 5, 2016, 10:56pm

Implementation

981d1f/app/code/Magento/Sales/Model/Order/Payment.php#L808-L827

/**
 * Order cancellation hook for payment method instance
 * Adds void transaction if needed
 *
 * @return $this
 */
public function cancel()
{
	$isOnline = true;
	if (!$this->canVoid()) {
		$isOnline = false;
	}

	if (!$this->hasMessage()) {
		$this->setMessage($isOnline ? __('Canceled order online') : __('Canceled order offline'));
	}

	if ($isOnline) {
		$this->_void($isOnline, null, 'cancel');
	}

	$this->_eventManager->dispatch('sales_order_payment_cancel', ['payment' => $this]);

	return $this;
}

Details:

The single usage

\Magento\Sales\Model\Order::cancel()

github.com

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: How is \Magento\Sales\Model\Order::cancel() implemented and used?