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

dmitry_fedyuk · May 6, 2016, 7:48pm

Context:

How is an acceptance of a reviewed payment implemented?

Implementation

magento/magento2/blob/135f967/app/code/Magento/Sales/Model/Order.php#L834-L842


/**
 * Check whether payment can be accepted or denied
 *
 * @return bool
 */
public function canReviewPayment()
{
    return $this->isPaymentReview() && $this->getPayment()->canReviewPayment();
}

Details:

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

Usages

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

github.com

magento/magento2/blob/135f967/app/code/Magento/Sales/Block/Adminhtml/Order/View.php#L190-L207


if ($order->canReviewPayment()) {
    $message = __('Are you sure you want to accept this payment?');
    $this->buttonList->add(
        'accept_payment',
        [
            'label' => __('Accept Payment'),
            'onclick' => "confirmSetLocation('{$message}', '{$this->getReviewPaymentUrl('accept')}')"
        ]
    );
    $message = __('Are you sure you want to deny this payment?');
    $this->buttonList->add(
        'deny_payment',
        [
            'label' => __('Deny Payment'),
            'onclick' => "confirmSetLocation('{$message}', '{$this->getReviewPaymentUrl('deny')}')"
        ]
    );
}

2. \Magento\Sales\Block\Adminhtml\Order\Invoice\View::_isPaymentReview()

github.com

magento/magento2/blob/135f967/app/code/Magento/Sales/Block/Adminhtml/Order/Invoice/View.php#L163-L172


/**
 * Check whether order is under payment review
 *
 * @return bool
 */
protected function _isPaymentReview()
{
    $order = $this->getInvoice()->getOrder();
    return $order->canReviewPayment() || $order->canFetchPaymentReviewUpdate();
}

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

github.com

magento/magento2/blob/135f967/app/code/Magento/Sales/Model/Order.php#L522-L524


if (!$this->canReviewPayment() && $this->canFetchPaymentReviewUpdate()) {
    return false;
}