How is a payment method's canReviewPayment() implemented and used?

dmitry_fedyuk · February 15, 2016, 7:43am

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

Declaration

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


      
          /**
           * Whether this method can accept or deny payment
           * @return bool
           * 
           */
          public function canReviewPayment();

Definition

github.com

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


      
          /**
           * Payment Method feature
           *
           * @var bool
           */
          protected $_canReviewPayment = false;

github.com

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


      
          /**
           * Whether this method can accept or deny payment
           * @return bool
           * @api
           */
          public function canReviewPayment()
          {
              return $this->_canReviewPayment;
          }

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Paypal/Model/Direct.php#L103-L108


      
          /**
           * Availability option
           *
           * @var bool
           */
          protected $_canReviewPayment = true;

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Paypal/Model/Direct.php#L363-L370


      
          /**
           * Whether payment can be reviewed
           * @return bool
           */
          public function canReviewPayment()
          {
              return parent::canReviewPayment() && $this->_pro->canReviewPayment($this->getInfoInstance());
          }

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Paypal/Model/Express.php#L117-L122


      
          /**
           * Availability option
           *
           * @var bool
           */
          protected $_canReviewPayment = true;

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Paypal/Model/Express.php#L592-L602


      
              return $this;
          }
          
          /**
           * Whether payment can be reviewed
           * @return bool
           */
          public function canReviewPayment()
          {
              return parent::canReviewPayment() && $this->_pro->canReviewPayment($this->getInfoInstance());
          }

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Paypal/Model/Payflowpro.php#L219-L224


      
          /**
           * Payment Method feature
           *
           * @var bool
           */
          protected $_canReviewPayment = true;

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Paypal/Model/Method/Agreement.php#L344-L352


      
          /**
           * Whether payment can be reviewed
           * @return bool
           * @internal param InfoInterface|Payment $payment
           */
          public function canReviewPayment()
          {
              return parent::canReviewPayment() && $this->_pro->canReviewPayment($this->getInfoInstance());
          }

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Vault/Model/Method/Vault.php#L319-L322


      
          public function isOffline()
          {
              return $this->getVaultProvider()->isOffline();
          }

Usage

Magento’s Order View block will check $order->canReviewPayment() which will look at the _canReviewPayment variable on the payment method, and if true, display two buttons on the Order View : “Accept Payment” and “Deny Payment”. When clicked, the two new Payment Method functions we just added above will be called as appropriate.

github.com

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


      
          /**
           * Attempt to accept a payment that us under review
           *
           * @param InfoInterface $payment
           * @return false
           * @throws \Magento\Framework\Exception\LocalizedException
           * @api
           * @SuppressWarnings(PHPMD.UnusedFormalParameter)
           */
          public function acceptPayment(InfoInterface $payment)
          {
              if (!$this->canReviewPayment()) {
                  throw new \Magento\Framework\Exception\LocalizedException(__('The payment review action is unavailable.'));
              }
              return false;
          }

github.com

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


      
          /**
           * Attempt to deny a payment that us under review
           *
           * @param InfoInterface $payment
           * @return false
           * @throws \Magento\Framework\Exception\LocalizedException
           * @api
           * @SuppressWarnings(PHPMD.UnusedFormalParameter)
           */
          public function denyPayment(InfoInterface $payment)
          {
              if (!$this->canReviewPayment()) {
                  throw new \Magento\Framework\Exception\LocalizedException(__('The payment review action is unavailable.'));
              }
              return false;
          }

github.com

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


      
          /**
           * Check order payment review availability
           *
           * @return bool
           */
          public function canReviewPayment()
          {
              return (bool)$this->getMethodInstance()->canReviewPayment();
          }

github.com

magento/magento2/blob/6ce74b2/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();
          }

Branch 1

github.com

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


      
          /**
           * Retrieve order cancel availability
           *
           * @return bool
           * @SuppressWarnings(PHPMD.CyclomaticComplexity)
           * @SuppressWarnings(PHPMD.NPathComplexity)
           */
          public function canCancel()
          {
              if (!$this->_canVoidOrder()) {
                  return false;
              }
              if ($this->canUnhold()) {
                  return false;
              }
              if (!$this->canReviewPayment() && $this->canFetchPaymentReviewUpdate()) {
                  return false;
              }

Branch 2

github.com

magento/magento2/blob/6ce74b2/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')}')"
                  ]
              );
          }

Branch 3

github.com

magento/magento2/blob/6ce74b2/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();
          }

Branch 3.1

github.com

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


      
          if ($this->_isAllowedAction(
              'Magento_Sales::cancel'
          ) && $this->getInvoice()->canCancel() && !$this->_isPaymentReview()
          ) {
              $this->buttonList->add(
                  'cancel',
                  [
                      'label' => __('Cancel'),
                      'class' => 'delete',
                      'onclick' => 'setLocation(\'' . $this->getCancelUrl() . '\')'
                  ]
              );
          }

Branch 3.2

github.com

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


      
          if ($this->_isAllowedAction(
              'Magento_Sales::capture'
          ) && $this->getInvoice()->canCapture() && !$this->_isPaymentReview()
          ) {
              $this->buttonList->add(
                  'capture',
                  [
                      'label' => __('Capture'),
                      'class' => 'capture',
                      'onclick' => 'setLocation(\'' . $this->getCaptureUrl() . '\')'
                  ]
              );
          }

dmitry_fedyuk · February 15, 2016, 8:01am