How to programmatically check whether an order is canceled?

dmitry_fedyuk · April 26, 2016, 7:49pm

Use the \Magento\Sales\Model\Order::isCanceled() method.

Interface and implementation

magento/magento2/blob/958164/app/code/Magento/Sales/Model/Order.php#L1912-L1920


/**
 * Check whether order is canceled
 *
 * @return bool
 */
public function isCanceled()
{
    return $this->getState() === self::STATE_CANCELED;
}

Usage examples

1. \Magento\Downloadable\Observer\SetLinkStatusObserver::execute()

2. \Magento\Payment\Observer\SalesOrderBeforeSaveObserver::execute()

github.com

magento/magento2/blob/958164/app/code/Magento/Payment/Observer/SalesOrderBeforeSaveObserver.php#L32-L32


if ($order->isCanceled() || $order->getState() == \Magento\Sales\Model\Order::STATE_CLOSED) {

3. \Magento\Sales\Block\Adminhtml\Order\View::_construct()

github.com

magento/magento2/blob/958164/app/code/Magento/Sales/Block/Adminhtml/Order/View.php#L122-L122


if ($this->_isAllowedAction('Magento_Sales::emails') && !$order->isCanceled()) {

4. \Magento\Sales\Model\Order::canCancel()

github.com

magento/magento2/blob/958164/app/code/Magento/Sales/Model/Order.php#L538-L538


if ($this->isCanceled() || $state === self::STATE_COMPLETE || $state === self::STATE_CLOSED) {

5. \Magento\Sales\Model\Order::_canVoidOrder()

github.com

magento/magento2/blob/958164/app/code/Magento/Sales/Model/Order.php#L565-L565


return !($this->isCanceled() || $this->canUnhold() || $this->isPaymentReview());

6. \Magento\Sales\Model\Order::canInvoice()

github.com

magento/magento2/blob/958164/app/code/Magento/Sales/Model/Order.php#L580-L580


if ($this->isCanceled() || $state === self::STATE_COMPLETE || $state === self::STATE_CLOSED) {

7. \Magento\Sales\Model\Order::canCreditmemo()

github.com

magento/magento2/blob/958164/app/code/Magento/Sales/Model/Order.php#L611-L611


if ($this->isCanceled() || $this->getState() === self::STATE_CLOSED) {

8. \Magento\Sales\Model\Order::canShip()

9. \Magento\Sales\Model\Order::canEdit()

10. \Magento\Sales\Model\ResourceModel\Order\Handler\State::check()

github.com

magento/magento2/blob/958164/app/code/Magento/Sales/Model/ResourceModel/Order/Handler/State.php#L29-L29


if (!$order->isCanceled() && !$order->canUnhold() && !$order->canInvoice() && !$order->canShip()) {

dmitry_fedyuk · April 26, 2016, 7:50pm