How is a payment method's canVoid() used?

dmitry_fedyuk · February 10, 2016, 3:50am

Declaration

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/MethodInterface.php#L111-L116


/**
 * Check void availability
 * @return bool
 * 
 */
public function canVoid();

Definition

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/Method/AbstractMethod.php#L363-L372


/**
 * Check void availability
 * @return bool
 * @internal param \Magento\Framework\DataObject $payment
 * @api
 */
public function canVoid()
{
    return $this->_canVoid;
}

Usages

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/Method/AbstractMethod.php#L680-L686


public function void(\Magento\Payment\Model\InfoInterface $payment)
{
    if (!$this->canVoid()) {
        throw new \Magento\Framework\Exception\LocalizedException(__('The void action is not available.'));
    }
    return $this;
}

github.com

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;
}

dmitry_fedyuk · February 10, 2016, 4:05am