external payment statuses from Convertim are now included in isPaid and hasPaymentInProcess methods

Author: TomasLudvik

src/Form/Admin/Order/OrderFormType.php

@@ -20,7 +20,7 @@
 use Shopsys\FrameworkBundle\Model\Order\Order;
 use Shopsys\FrameworkBundle\Model\Order\OrderData;
 use Shopsys\FrameworkBundle\Model\Order\Status\OrderStatusFacade;
-use Shopsys\FrameworkBundle\Model\Payment\Transaction\ExternalPaymentStatus;
+use Shopsys\FrameworkBundle\Model\Payment\Transaction\ExternalPaymentStatusHelper;
 use Shopsys\FrameworkBundle\Twig\DateTimeFormatterExtension;
 use Symfony\Component\Form\AbstractType;
 use Symfony\Component\Form\Extension\Core\Type\CheckboxType;
@@ -45,12 +45,14 @@ class OrderFormType extends AbstractType
      * @param \Shopsys\FrameworkBundle\Model\Order\Status\OrderStatusFacade $orderStatusFacade
      * @param \Shopsys\FrameworkBundle\Twig\DateTimeFormatterExtension $dateTimeFormatterExtension
      * @param \Shopsys\FrameworkBundle\Component\Domain\Domain $domain
+     * @param \Shopsys\FrameworkBundle\Model\Payment\Transaction\ExternalPaymentStatusHelper $externalPaymentStatusHelper
      */
     public function __construct(
         private readonly CountryFacade $countryFacade,
         private readonly OrderStatusFacade $orderStatusFacade,
         private readonly DateTimeFormatterExtension $dateTimeFormatterExtension,
         private readonly Domain $domain,
+        private readonly ExternalPaymentStatusHelper $externalPaymentStatusHelper,
     ) {
     }
 
@@ -207,7 +209,7 @@ private function createBasicInformationGroup(FormBuilderInterface $builder, Orde
 
             if ($paymentTransaction !== false) {
                 if ($paymentTransaction->getExternalPaymentStatus() !== null) {
-                    $translatedPaymentStatus = ExternalPaymentStatus::getTranslatedStatus($paymentTransaction->getExternalPaymentStatus());
+                    $translatedPaymentStatus = $this->externalPaymentStatusHelper->getTranslatedStatus($paymentTransaction->getExternalPaymentStatus());
                 } else {
                     $translatedPaymentStatus = t('Order has not been sent to payment gateway');
                 }

src/Model/Payment/Transaction/ExternalPaymentStatus.php

@@ -0,0 +1,90 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopsys\FrameworkBundle\Model\Payment\Transaction;
+
+use GoPay\Definition\Response\PaymentStatus;
+use Shopsys\ConvertimBundle\Model\Payment\PaymentStatus as ConvertimPaymentStatus;
+
+class ExternalPaymentStatusHelper
+{
+    protected ?ConvertimPaymentStatus $convertimPaymentStatus = null;
+
+    public function __construct()
+    {
+        if ($this->isConvertimInstalled()) {
+            $this->convertimPaymentStatus = new ConvertimPaymentStatus();
+        }
+    }
+
+    /**
+     * @return bool
+     */
+    public function isConvertimInstalled(): bool
+    {
+        return class_exists(ConvertimPaymentStatus::class);
+    }
+
+    /**
+     * @param string $externalStatus
+     * @return string
+     */
+    public function getTranslatedStatus(string $externalStatus): string
+    {
+        $statusesToTranslate = $this->getStatusesToTranslate();
+        $externalStatusUppercase = mb_strtoupper($externalStatus);
+
+        if (array_key_exists($externalStatusUppercase, $statusesToTranslate)) {
+            return $statusesToTranslate[$externalStatusUppercase];
+        }
+
+        return $externalStatus;
+    }
+
+    /**
+     * @param string $paymentStatus
+     * @return bool
+     */
+    public function isPaid(string $paymentStatus): bool
+    {
+        return $paymentStatus === PaymentStatus::PAID ||
+            ($this->convertimPaymentStatus !== null && $this->convertimPaymentStatus->isPaid($paymentStatus));
+    }
+
+    /**
+     * @param string $paymentStatus
+     * @return bool
+     */
+    public function hasPaymentInProcess(string $paymentStatus): bool
+    {
+        return $paymentStatus === PaymentStatus::PAYMENT_METHOD_CHOSEN ||
+            ($this->convertimPaymentStatus !== null && $this->convertimPaymentStatus->hasPaymentInProcess($paymentStatus));
+    }
+
+    /**
+     * @return array<string, string>
+     */
+    protected function getStatusesToTranslate(): array
+    {
+        $statusesToTranslate = [];
+
+        if ($this->convertimPaymentStatus !== null) {
+            $statusesToTranslate = $this->convertimPaymentStatus->getStatusesToTranslate();
+        }
+
+        return array_merge(
+            [
+                PaymentStatus::CREATED => t('Payment created'),
+                PaymentStatus::PAYMENT_METHOD_CHOSEN => t('Payment method chosen'),
+                PaymentStatus::PAID => t('Payment paid'),
+                PaymentStatus::AUTHORIZED => t('Payment authorized'),
+                PaymentStatus::CANCELED => t('Payment canceled'),
+                PaymentStatus::TIMEOUTED => t('Payment has expired'),
+                PaymentStatus::REFUNDED => t('Payment refunded'),
+                PaymentStatus::PARTIALLY_REFUNDED => t('Payment partially refunded'),
+            ],
+            $statusesToTranslate,
+        );
+    }
+}

src/Model/Payment/Transaction/ExternalPaymentStatusHelper.php

@@ -68,12 +68,15 @@ class PaymentTransaction
      */
     protected $refundedAmount;
 
+    protected ExternalPaymentStatusHelper $externalPaymentStatusHelper;
+
     /**
      * @param \Shopsys\FrameworkBundle\Model\Payment\Transaction\PaymentTransactionData $paymentTransactionData
      */
     public function __construct(PaymentTransactionData $paymentTransactionData)
     {
         $this->setData($paymentTransactionData);
+        $this->externalPaymentStatusHelper = new ExternalPaymentStatusHelper();
     }
 
     /**
@@ -179,15 +182,15 @@ public function getRefundableAmount(): Money
      */
     public function isRefundable(): bool
     {
-        return in_array($this->externalPaymentStatus, [PaymentStatus::PARTIALLY_REFUNDED, PaymentStatus::PAID], true);
+        return $this->payment->isGoPay() && in_array($this->externalPaymentStatus, [PaymentStatus::PARTIALLY_REFUNDED, PaymentStatus::PAID], true);
     }
 
     /**
      * @return bool
      */
     public function isPartiallyRefunded(): bool
     {
-        return $this->externalPaymentStatus === PaymentStatus::PARTIALLY_REFUNDED;
+        return $this->payment->isGoPay() && $this->externalPaymentStatus === PaymentStatus::PARTIALLY_REFUNDED;
     }
 
     /**
@@ -199,7 +202,7 @@ public function isPaid(): bool
             return false;
         }
 
-        return $this->externalPaymentStatus === PaymentStatus::PAID;
+        return $this->externalPaymentStatusHelper->isPaid($this->externalPaymentStatus);
     }
 
     /**
@@ -211,6 +214,6 @@ public function hasPaymentInProcess(): bool
             return false;
         }
 
-        return $this->externalPaymentStatus === PaymentStatus::PAYMENT_METHOD_CHOSEN;
+        return $this->externalPaymentStatusHelper->hasPaymentInProcess($this->externalPaymentStatus);
     }
 }

src/Model/Payment/Transaction/PaymentTransaction.php

@@ -17,7 +17,7 @@ services:
 
     Shopsys\FrameworkBundle\:
         exclude: '../../{Command,Controller,DependencyInjection,Form,Migrations,Resources,Twig}'
-        resource: '../../**/*{Calculation,Dispatcher,Enum,Facade,Factory,Formatter,Generator,Handler,InlineEdit,Listener,Loader,Mapper,Middleware,Parser,Provider,Recalculator,Registry,Repository,Resolver,Sender,Service,Scheduler,Subscriber,Transformer,DataFetcher}.php'
+        resource: '../../**/*{Calculation,Dispatcher,Enum,Facade,Factory,Formatter,Generator,Handler,Helper,InlineEdit,Listener,Loader,Mapper,Middleware,Parser,Provider,Recalculator,Registry,Repository,Resolver,Sender,Service,Scheduler,Subscriber,Transformer,DataFetcher}.php'
 
     Shopsys\FrameworkBundle\Controller\:
         resource: '../../Controller/'