[Payment] Incorporate payment query into payment modification controllers

NoResponseMate · NoResponseMate · commit 5939c32a7e6d · 2025-10-13T16:41:52.000+02:00
diff --git a/src/Controller/CancelPayPalCheckoutPaymentAction.php b/src/Controller/CancelPayPalCheckoutPaymentAction.php
@@ -15,34 +15,31 @@
 
 use Sylius\PayPalPlugin\Manager\PaymentStateManagerInterface;
 use Sylius\PayPalPlugin\Provider\PaymentProviderInterface;
+use Sylius\PayPalPlugin\Repository\Query\PaypalPaymentQueryInterface;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpFoundation\Session\Flash\FlashBagInterface;
 
 final class CancelPayPalCheckoutPaymentAction
 {
-    private PaymentProviderInterface $paymentProvider;
-
-    private PaymentStateManagerInterface $paymentStateManager;
-
     public function __construct(
-        PaymentProviderInterface $paymentProvider,
-        PaymentStateManagerInterface $paymentStateManager,
+        private PaymentProviderInterface $paymentProvider,
+        private PaymentStateManagerInterface $paymentStateManager,
+        private ?PaypalPaymentQueryInterface $paypalPaymentQuery = null,
     ) {
-        $this->paymentProvider = $paymentProvider;
-        $this->paymentStateManager = $paymentStateManager;
     }
 
     public function __invoke(Request $request): Response
     {
-        /**
-         * @var string $content
-         */
+        /** @var string $content */
         $content = $request->getContent();
-
         $content = (array) json_decode($content, true);
 
-        $payment = $this->paymentProvider->getByPayPalOrderId((string) $content['payPalOrderId']);
+        if (null !== $this->paypalPaymentQuery) {
+            $payment = $this->paypalPaymentQuery->getForCancellationByOrderId((string) $content['payPalOrderId']);
+        } else {
+            $payment = $this->paymentProvider->getByPayPalOrderId((string) $content['payPalOrderId']);
+        }
 
         /** @var FlashBagInterface $flashBag */
         $flashBag = $request->getSession()->getBag('flashes');
diff --git a/src/Controller/CancelPayPalPaymentAction.php b/src/Controller/CancelPayPalPaymentAction.php
@@ -22,6 +22,7 @@
 use Sylius\Component\Payment\PaymentTransitions;
 use Sylius\PayPalPlugin\Provider\FlashBagProvider;
 use Sylius\PayPalPlugin\Provider\PaymentProviderInterface;
+use Sylius\PayPalPlugin\Repository\Query\PaypalPaymentQueryInterface;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\RequestStack;
 use Symfony\Component\HttpFoundation\Response;
@@ -35,6 +36,7 @@ public function __construct(
         private readonly FlashBag|RequestStack $flashBagOrRequestStack,
         private readonly FactoryInterface|StateMachineInterface $stateMachineFactory,
         private readonly OrderProcessorInterface $orderPaymentProcessor,
+        private readonly ?PaypalPaymentQueryInterface $paypalPaymentQuery = null,
     ) {
         if ($flashBagOrRequestStack instanceof FlashBag) {
             trigger_deprecation('sylius/paypal-plugin', '1.5', sprintf('Passing an instance of %s as constructor argument for %s is deprecated as of PayPalPlugin 1.5 and will be removed in 2.0. Pass an instance of %s instead.', FlashBag::class, self::class, RequestStack::class));
@@ -55,13 +57,15 @@ public function __construct(
 
     public function __invoke(Request $request): Response
     {
-        /**
-         * @var string $content
-         */
+        /** @var string $content */
         $content = $request->getContent();
         $content = (array) json_decode($content, true);
 
-        $payment = $this->paymentProvider->getByPayPalOrderId((string) $content['payPalOrderId']);
+        if (null !== $this->paypalPaymentQuery) {
+            $payment = $this->paypalPaymentQuery->getForCancellationByOrderId((string) $content['payPalOrderId']);
+        } else {
+            $payment = $this->paymentProvider->getByPayPalOrderId((string) $content['payPalOrderId']);
+        }
 
         /** @var OrderInterface $order */
         $order = $payment->getOrder();
diff --git a/src/Controller/UpdatePayPalOrderAction.php b/src/Controller/UpdatePayPalOrderAction.php
@@ -23,6 +23,7 @@
 use Sylius\PayPalPlugin\Api\OrderDetailsApiInterface;
 use Sylius\PayPalPlugin\Api\UpdateOrderApiInterface;
 use Sylius\PayPalPlugin\Provider\PaymentProviderInterface;
+use Sylius\PayPalPlugin\Repository\Query\PaypalPaymentQueryInterface;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
@@ -36,6 +37,7 @@ public function __construct(
         private readonly UpdateOrderApiInterface $updateOrderApi,
         private readonly AddressFactoryInterface $addressFactory,
         private readonly OrderProcessorInterface $orderProcessor,
+        private readonly ?PaypalPaymentQueryInterface $paypalPaymentQuery = null,
     ) {
         if (null !== $this->orderDetailsApi) {
             trigger_deprecation(
@@ -51,7 +53,11 @@ public function __construct(
 
     public function __invoke(Request $request): Response
     {
-        $payment = $this->paymentProvider->getByPayPalOrderId((string) $request->request->get('orderID'));
+        if (null !== $this->paypalPaymentQuery) {
+            $payment = $this->paypalPaymentQuery->getForUpdateByOrderId((string) $request->request->get('orderID'));
+        } else {
+            $payment = $this->paymentProvider->getByPayPalOrderId((string) $request->request->get('orderID'));
+        }
         /** @var OrderInterface $order */
         $order = $payment->getOrder();
 
diff --git a/src/Controller/Webhook/RefundOrderAction.php b/src/Controller/Webhook/RefundOrderAction.php
@@ -22,6 +22,7 @@
 use Sylius\PayPalPlugin\Exception\PayPalWrongDataException;
 use Sylius\PayPalPlugin\Provider\PaymentProviderInterface;
 use Sylius\PayPalPlugin\Provider\PayPalRefundDataProviderInterface;
+use Sylius\PayPalPlugin\Repository\Query\PaypalPaymentQueryInterface;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
@@ -34,6 +35,7 @@ public function __construct(
         private readonly PaymentProviderInterface $paymentProvider,
         private readonly ObjectManager $paymentManager,
         private readonly PayPalRefundDataProviderInterface $payPalRefundDataProvider,
+        private readonly ?PaypalPaymentQueryInterface $paypalPaymentQuery = null,
     ) {
         if ($this->stateMachineFactory instanceof FactoryInterface) {
             trigger_deprecation(
@@ -53,7 +55,11 @@ public function __invoke(Request $request): Response
         $refundData = $this->payPalRefundDataProvider->provide($this->getPayPalPaymentUrl($request));
 
         try {
-            $payment = $this->paymentProvider->getByPayPalOrderId((string) $refundData['id']);
+            if (null !== $this->paypalPaymentQuery) {
+                $payment = $this->paypalPaymentQuery->getForRefundingByOrderId((string) $refundData['id']);
+            } else {
+                $payment = $this->paymentProvider->getByPayPalOrderId((string) $refundData['id']);
+            }
         } catch (PaymentNotFoundException $exception) {
             return new JsonResponse(['error' => $exception->getMessage()], Response::HTTP_NOT_FOUND);
         }
diff --git a/src/Repository/Query/PaypalPaymentQuery.php b/src/Repository/Query/PaypalPaymentQuery.php
@@ -18,15 +18,16 @@
 use Sylius\Component\Core\Model\PaymentInterface;
 use Sylius\Component\Core\Repository\PaymentRepositoryInterface;
 use Sylius\PayPalPlugin\DependencyInjection\SyliusPayPalExtension;
+use Sylius\PayPalPlugin\Exception\PaymentNotFoundException;
 
 final class PaypalPaymentQuery implements PaypalPaymentQueryInterface
 {
     public function __construct(
-        private EntityManagerInterface $entityManager,
-        private PaymentRepositoryInterface $paymentRepository,
-        private array $updatableStates = ['cart', 'new', 'processing'],
-        private array $cancellableStates = ['cart', 'new', 'processing', 'completed'],
-        private array $refundableStates = ['completed'],
+        private readonly EntityManagerInterface $entityManager,
+        private readonly PaymentRepositoryInterface $paymentRepository,
+        private readonly array $updatableStates = ['cart', 'new', 'processing'],
+        private readonly array $cancellableStates = ['cart', 'new', 'processing', 'completed'],
+        private readonly array $refundableStates = ['completed'],
     ) {
     }
 
@@ -66,13 +67,18 @@ public function getForRefundingByOrderId(string $paypalOrderId): ?PaymentInterfa
     private function doGetPayment(QueryBuilder $queryBuilder, string $paypalOrderId): ?PaymentInterface
     {
         if ($this->isCastAvailable()) {
-            return $queryBuilder
+            $payment = $queryBuilder
                 ->andWhere('CAST(o.details AS text) LIKE :orderId')
                 ->setParameter('orderId', '%"paypal_order_id":"' . $paypalOrderId . '"%')
                 ->setMaxResults(1)
                 ->getQuery()
                 ->getOneOrNullResult()
             ;
+            if (null !== $payment) {
+                return $payment;
+            }
+
+            throw new PaymentNotFoundException();
         }
 
         $payments = $queryBuilder
@@ -87,7 +93,7 @@ private function doGetPayment(QueryBuilder $queryBuilder, string $paypalOrderId)
             }
         }
 
-        return null;
+        throw new PaymentNotFoundException();
     }
 
     private function getPaypalPaymentQueryBuilder(string $alias): QueryBuilder
diff --git a/src/Repository/Query/PaypalPaymentQueryInterface.php b/src/Repository/Query/PaypalPaymentQueryInterface.php
@@ -14,12 +14,16 @@
 namespace Sylius\PayPalPlugin\Repository\Query;
 
 use Sylius\Component\Core\Model\PaymentInterface;
+use Sylius\PayPalPlugin\Exception\PaymentNotFoundException;
 
 interface PaypalPaymentQueryInterface
 {
+    /** @throws PaymentNotFoundException */
     public function getForUpdateByOrderId(string $paypalOrderId): ?PaymentInterface;
 
+    /** @throws PaymentNotFoundException */
     public function getForCancellationByOrderId(string $paypalOrderId): ?PaymentInterface;
 
+    /** @throws PaymentNotFoundException */
     public function getForRefundingByOrderId(string $paypalOrderId): ?PaymentInterface;
 }
diff --git a/src/Resources/config/services/controller.xml b/src/Resources/config/services/controller.xml
@@ -24,6 +24,7 @@
             <argument type="service" id="sylius_paypal.provider.payment" />
             <argument type="service" id="sylius.manager.payment" />
             <argument type="service" id="sylius_paypal.provider.paypal_refund_data" />
+            <argument type="service" id="sylius_paypal.repository.query.paypal_payment" />
         </service>
         <service id="sylius_paypal.controller.webhook.refund_order" alias="Sylius\PayPalPlugin\Controller\Webhook\RefundOrderAction" />
 
@@ -40,6 +41,7 @@
             <argument type="service" id="request_stack" />
             <argument type="service" id="sylius_abstraction.state_machine" />
             <argument type="service" id="sylius.order_processing.order_payment_processor.checkout" />
+            <argument type="service" id="sylius_paypal.repository.query.paypal_payment" />
         </service>
         <service id="sylius_paypal.controller.cancel_paypal_payment" alias="Sylius\PayPalPlugin\Controller\CancelPayPalPaymentAction" />
 
@@ -54,6 +56,7 @@
         <service id="Sylius\PayPalPlugin\Controller\CancelPayPalCheckoutPaymentAction">
             <argument type="service" id="sylius_paypal.provider.payment" />
             <argument type="service" id="sylius_paypal.manager.payment_state" />
+            <argument type="service" id="sylius_paypal.repository.query.paypal_payment" />
         </service>
         <service id="sylius_paypal.controller.cancel_paypal_checkout_payment" alias="Sylius\PayPalPlugin\Controller\CancelPayPalCheckoutPaymentAction" />
 
@@ -153,6 +156,7 @@
             <argument type="service" id="sylius_paypal.api.update_order" />
             <argument type="service" id="sylius.factory.address" />
             <argument type="service" id="sylius.order_processing.order_processor" />
+            <argument type="service" id="sylius_paypal.repository.query.paypal_payment" />
         </service>
         <service id="sylius_paypal.controller.update_paypal_order" alias="Sylius\PayPalPlugin\Controller\UpdatePayPalOrderAction" />
 

Original file line number	Diff line number	Diff line change
`@@ -18,15 +18,16 @@`
`18`	`18`	`use Sylius\Component\Core\Model\PaymentInterface;`
`19`	`19`	`use Sylius\Component\Core\Repository\PaymentRepositoryInterface;`
`20`	`20`	`use Sylius\PayPalPlugin\DependencyInjection\SyliusPayPalExtension;`
	`21`	`+use Sylius\PayPalPlugin\Exception\PaymentNotFoundException;`
`21`	`22`
`22`	`23`	`final class PaypalPaymentQuery implements PaypalPaymentQueryInterface`
`23`	`24`	`{`
`24`	`25`	`public function __construct(`
`25`		`- private EntityManagerInterface $entityManager,`
`26`		`- private PaymentRepositoryInterface $paymentRepository,`
`27`		`- private array $updatableStates = ['cart', 'new', 'processing'],`
`28`		`- private array $cancellableStates = ['cart', 'new', 'processing', 'completed'],`
`29`		`- private array $refundableStates = ['completed'],`
	`26`	`+ private readonly EntityManagerInterface $entityManager,`
	`27`	`+ private readonly PaymentRepositoryInterface $paymentRepository,`
	`28`	`+ private readonly array $updatableStates = ['cart', 'new', 'processing'],`
	`29`	`+ private readonly array $cancellableStates = ['cart', 'new', 'processing', 'completed'],`
	`30`	`+ private readonly array $refundableStates = ['completed'],`
`30`	`31`	`) {`
`31`	`32`	`}`
`32`	`33`
`@@ -66,13 +67,18 @@ public function getForRefundingByOrderId(string $paypalOrderId): ?PaymentInterfa`
`66`	`67`	`private function doGetPayment(QueryBuilder $queryBuilder, string $paypalOrderId): ?PaymentInterface`
`67`	`68`	`{`
`68`	`69`	`if ($this->isCastAvailable()) {`
`69`		`- return $queryBuilder`
	`70`	`+ $payment = $queryBuilder`
`70`	`71`	`->andWhere('CAST(o.details AS text) LIKE :orderId')`
`71`	`72`	`->setParameter('orderId', '%"paypal_order_id":"' . $paypalOrderId . '"%')`
`72`	`73`	`->setMaxResults(1)`
`73`	`74`	`->getQuery()`
`74`	`75`	`->getOneOrNullResult()`
`75`	`76`	`;`
	`77`	`+ if (null !== $payment) {`
	`78`	`+ return $payment;`
	`79`	`+ }`
	`80`	`+`
	`81`	`+ throw new PaymentNotFoundException();`
`76`	`82`	`}`
`77`	`83`
`78`	`84`	`$payments = $queryBuilder`
`@@ -87,7 +93,7 @@ private function doGetPayment(QueryBuilder $queryBuilder, string $paypalOrderId)`
`87`	`93`	`}`
`88`	`94`	`}`
`89`	`95`
`90`		`- return null;`
	`96`	`+ throw new PaymentNotFoundException();`
`91`	`97`	`}`
`92`	`98`
`93`	`99`	`private function getPaypalPaymentQueryBuilder(string $alias): QueryBuilder`
Original file line number	Diff line number	Diff line change
`@@ -14,12 +14,16 @@`
`14`	`14`	`namespace Sylius\PayPalPlugin\Repository\Query;`
`15`	`15`
`16`	`16`	`use Sylius\Component\Core\Model\PaymentInterface;`
	`17`	`+use Sylius\PayPalPlugin\Exception\PaymentNotFoundException;`
`17`	`18`
`18`	`19`	`interface PaypalPaymentQueryInterface`
`19`	`20`	`{`
	`21`	`+ /** @throws PaymentNotFoundException */`
`20`	`22`	`public function getForUpdateByOrderId(string $paypalOrderId): ?PaymentInterface;`
`21`	`23`
	`24`	`+ /** @throws PaymentNotFoundException */`
`22`	`25`	`public function getForCancellationByOrderId(string $paypalOrderId): ?PaymentInterface;`
`23`	`26`
	`27`	`+ /** @throws PaymentNotFoundException */`
`24`	`28`	`public function getForRefundingByOrderId(string $paypalOrderId): ?PaymentInterface;`
`25`	`29`	`}`