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

dmitry_fedyuk · February 10, 2016, 4:01am

Definition

magento/magento2/blob/6ce74b2/app/code/Magento/Sales/Model/Order/Payment.php#L540-L555


/**
 * Check order payment void availability
 *
 * @return bool
 */
public function canVoid()
{
    if (null === $this->_canVoidLookup) {
        $this->_canVoidLookup = (bool)$this->getMethodInstance()->canVoid();
        if ($this->_canVoidLookup) {
            $authTransaction = $this->getAuthorizationTransaction();
            $this->_canVoidLookup = (bool)$authTransaction && !(int)$authTransaction->getIsClosed();
        }
    }
    return $this->_canVoidLookup;
}

Usages

github.com

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


/**
 * Getter whether the payment can be voided
 * @return bool
 */
public function canVoidPayment()
{
    return $this->_canVoidOrder() ? $this->getPayment()->canVoid() : false;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Sales/Model/Order/Creditmemo.php#L413-L433


public function canVoid()
{
    return false;
    $canVoid = false;
    if ($this->getState() == self::STATE_REFUNDED) {
        $canVoid = $this->getCanVoidFlag();
        /**
         * If we not retrieve negative answer from payment yet
         */
        if (is_null($canVoid)) {
            $canVoid = $this->getOrder()->getPayment()->canVoid();
            if ($canVoid === false) {
                $this->setCanVoidFlag(false);
                $this->_saveBeforeDestruct = true;
            }
        } else {
            $canVoid = (bool)$canVoid;
        }
    }
    return $canVoid;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Sales/Model/Order/Invoice.php#L293-L306


/**
 * Check invoice void action availability
 *
 * @return bool
 */
public function canVoid()
{
    if ($this->getState() == self::STATE_PAID) {
        if ($this->getCanVoidFlag() === null) {
            return (bool)$this->getOrder()->getPayment()->canVoid();
        }
    }
    return (bool)$this->getCanVoidFlag();
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Sales/Model/Order/Payment.php#L808-L819


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

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

dmitry_fedyuk · February 10, 2016, 4:08am