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

dmitrii_fediuk · February 10, 2016, 2:31am

Definition

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


/**
 * Check invoice refund action availability
 *
 * @return bool
 */
public function canRefund()
{
    if ($this->getState() != self::STATE_PAID) {
        return false;
    }
    if (abs($this->getBaseGrandTotal() - $this->getBaseTotalRefunded()) < .0001) {
        return false;
    }
    return true;
}

Usages

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Sales/Block/Adminhtml/Order/Invoice/View.php#L110-L123


if ($orderPayment->canRefundPartialPerInvoice() &&
    $this->getInvoice()->canRefund() &&
    $orderPayment->getAmountPaid() > $orderPayment->getAmountRefunded() ||
    $orderPayment->canRefund() && !$this->getInvoice()->getIsUsedForRefund()
) {
    $this->buttonList->add(
        'capture',
        [ // capture?
            'label' => __('Credit Memo'),
            'class' => 'credit-memo',
            'onclick' => 'setLocation(\'' . $this->getCreditMemoUrl() . '\')'
        ]
    );
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Paypal/Model/Pro.php#L299-L306


$canRefundMore = $payment->getCreditmemo()->getInvoice()->canRefund();
$isFullRefund = !$canRefundMore &&
    0 == (double)$order->getBaseTotalOnlineRefunded() + (double)$order->getBaseTotalOfflineRefunded();
$api->setRefundType(
    $isFullRefund ? \Magento\Paypal\Model\Config::REFUND_TYPE_FULL : \Magento\Paypal\Model\Config::REFUND_TYPE_PARTIAL
);
$api->callRefundTransaction();
$this->_importRefundResultToPayment($api, $payment, $canRefundMore);

dmitrii_fediuk · February 10, 2016, 2:40am