ACP2E-1155: Refunding Issue Rest API

Author: Anna Bukatar

app/code/Magento/Sales/Model/Order/Invoice/Validation/CanRefund.php

@@ -5,21 +5,18 @@
  */
 namespace Magento\Sales\Model\Order\Invoice\Validation;
 
-use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Payment\Model\InfoInterface;
 use Magento\Payment\Model\MethodInterface;
 use Magento\Sales\Api\Data\InvoiceInterface;
 use Magento\Sales\Api\OrderPaymentRepositoryInterface;
 use Magento\Sales\Api\OrderRepositoryInterface;
 use Magento\Sales\Model\Order\Invoice;
 use Magento\Sales\Model\ValidatorInterface;
-use Magento\Framework\App\ObjectManager;
 
-/**
- * Class CanRefund
- */
 class CanRefund implements ValidatorInterface
 {
+    use \Magento\Sales\Model\Order\Validation\CanRefundTrait;
+
     /**
      * @var OrderPaymentRepositoryInterface
      */
@@ -30,26 +27,18 @@ class CanRefund implements ValidatorInterface
      */
     private $orderRepository;
 
-    /**
-     * @var ScopeConfigInterface;
-     */
-    private $scopeConfig;
-
     /**
      * CanRefund constructor.
      *
      * @param OrderPaymentRepositoryInterface $paymentRepository
      * @param OrderRepositoryInterface $orderRepository
-     * @param ScopeConfigInterface|null $scopeConfig
      */
     public function __construct(
         OrderPaymentRepositoryInterface $paymentRepository,
-        OrderRepositoryInterface $orderRepository,
-        ?ScopeConfigInterface $scopeConfig = null
+        OrderRepositoryInterface $orderRepository
     ) {
         $this->paymentRepository = $paymentRepository;
         $this->orderRepository = $orderRepository;
-        $this->scopeConfig = $scopeConfig ?? ObjectManager::getInstance()->get(ScopeConfigInterface::class);
     }
 
     /**
@@ -68,6 +57,8 @@ public function validate($entity)
     }
 
     /**
+     * Validate if a refund is possible for the payment method
+     *
      * @param InvoiceInterface $invoice
      * @return bool
      */
@@ -86,6 +77,8 @@ private function isPaymentAllowRefund(InvoiceInterface $invoice)
     }
 
     /**
+     * Validate if available grand total is enough to be refunded
+     *
      * @param InvoiceInterface $entity
      * @return bool
      */
@@ -96,20 +89,8 @@ private function isGrandTotalEnoughToRefund(InvoiceInterface $entity)
     }
 
     /**
-     * Return Zero GrandTotal availability.
+     * Validate if partial refund is possible
      *
-     * @return bool
-     */
-    private function isAllowZeroGrandTotal()
-    {
-        $isAllowed = $this->scopeConfig->getValue(
-            'sales/zerograndtotal_creditmemo/allow_zero_grandtotal',
-            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
-        );
-        return $isAllowed;
-    }
-
-    /**
      * @param MethodInterface $method
      * @param InfoInterface $payment
      * @return bool
@@ -122,6 +103,8 @@ private function canPartialRefund(MethodInterface $method, InfoInterface $paymen
     }
 
     /**
+     * validate if full refund is possible
+     *
      * @param InvoiceInterface $invoice
      * @param MethodInterface $method
      * @return bool

app/code/Magento/Sales/Model/Order/Validation/CanRefund.php

@@ -5,40 +5,29 @@
  */
 namespace Magento\Sales\Model\Order\Validation;
 
-use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Framework\Pricing\PriceCurrencyInterface;
 use Magento\Sales\Api\Data\OrderInterface;
 use Magento\Sales\Model\Order;
 use Magento\Sales\Model\ValidatorInterface;
-use Magento\Framework\App\ObjectManager;
 
-/**
- * Class CanRefund
- */
 class CanRefund implements ValidatorInterface
 {
+    use \Magento\Sales\Model\Order\Validation\CanRefundTrait;
+
     /**
      * @var PriceCurrencyInterface
      */
     private $priceCurrency;
 
-    /**
-     * @var ScopeConfigInterface;
-     */
-    private $scopeConfig;
-
     /**
      * CanRefund constructor.
      *
      * @param PriceCurrencyInterface $priceCurrency
-     * @param ScopeConfigInterface|null $scopeConfig
      */
     public function __construct(
-        PriceCurrencyInterface $priceCurrency,
-        ?ScopeConfigInterface $scopeConfig = null
+        PriceCurrencyInterface $priceCurrency
     ) {
         $this->priceCurrency = $priceCurrency;
-        $this->scopeConfig = $scopeConfig ?? ObjectManager::getInstance()->get(ScopeConfigInterface::class);
     }
 
     /**
@@ -77,18 +66,4 @@ private function isTotalPaidEnoughForRefund(OrderInterface $order)
             $order->getTotalPaid() == 0 &&
             $this->isAllowZeroGrandTotal();
     }
-
-    /**
-     * Return Zero GrandTotal availability.
-     *
-     * @return bool
-     */
-    private function isAllowZeroGrandTotal()
-    {
-        $isAllowed = $this->scopeConfig->getValue(
-            'sales/zerograndtotal_creditmemo/allow_zero_grandtotal',
-            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
-        );
-        return $isAllowed;
-    }
 }

app/code/Magento/Sales/Model/Order/Validation/CanRefundTrait.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Magento\Sales\Model\Order\Validation;
+
+use Magento\Framework\App\ObjectManager;
+use Magento\Framework\App\Config\ScopeConfigInterface;
+
+trait CanRefundTrait
+{
+    /**
+     * Return Zero GrandTotal availability.
+     *
+     * @return bool
+     */
+    private function isAllowZeroGrandTotal()
+    {
+        $scopeConfig = ObjectManager::getInstance()->get(ScopeConfigInterface::class);
+        $isAllowed = $scopeConfig->getValue(
+            'sales/zerograndtotal_creditmemo/allow_zero_grandtotal',
+            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
+        );
+        return $isAllowed;
+    }
+}