[Maintenance] Deprecate PaymentProvider in favour of PaypalPaymentQuery

Author: NoResponseMate

src/Controller/CancelPayPalCheckoutPaymentAction.php

@@ -23,10 +23,30 @@
 final class CancelPayPalCheckoutPaymentAction
 {
     public function __construct(
-        private PaymentProviderInterface $paymentProvider,
+        private ?PaymentProviderInterface $paymentProvider,
         private PaymentStateManagerInterface $paymentStateManager,
         private ?PaypalPaymentQueryInterface $paypalPaymentQuery = null,
     ) {
+        if (null !== $this->paymentProvider) {
+            trigger_deprecation(
+                'sylius/paypal-plugin',
+                '1.7',
+                sprintf(
+                    'Passing an instance of "%s" as the first argument is deprecated and will be prohibited in 3.0',
+                    PaymentProviderInterface::class,
+                ),
+            );
+        }
+        if (null === $this->paypalPaymentQuery) {
+            trigger_deprecation(
+                'sylius/paypal-plugin',
+                '1.7',
+                sprintf(
+                    'Not passing an instance of "%s" is deprecated and will be prohibited in 3.0',
+                    PaypalPaymentQueryInterface::class,
+                ),
+            );
+        }
     }
 
     public function __invoke(Request $request): Response

src/Controller/CancelPayPalPaymentAction.php

@@ -31,7 +31,7 @@
 final class CancelPayPalPaymentAction
 {
     public function __construct(
-        private readonly PaymentProviderInterface $paymentProvider,
+        private readonly ?PaymentProviderInterface $paymentProvider,
         private readonly ObjectManager $objectManager,
         private readonly FlashBag|RequestStack $flashBagOrRequestStack,
         private readonly FactoryInterface|StateMachineInterface $stateMachineFactory,
@@ -53,6 +53,26 @@ public function __construct(
                 ),
             );
         }
+        if (null !== $this->paymentProvider) {
+            trigger_deprecation(
+                'sylius/paypal-plugin',
+                '1.7',
+                sprintf(
+                    'Passing an instance of "%s" as the first argument is deprecated and will be prohibited in 3.0',
+                    PaymentProviderInterface::class,
+                ),
+            );
+        }
+        if (null === $this->paypalPaymentQuery) {
+            trigger_deprecation(
+                'sylius/paypal-plugin',
+                '1.7',
+                sprintf(
+                    'Not passing an instance of "%s" is deprecated and will be prohibited in 3.0',
+                    PaypalPaymentQueryInterface::class,
+                ),
+            );
+        }
     }
 
     public function __invoke(Request $request): Response

src/Controller/UpdatePayPalOrderAction.php

@@ -31,7 +31,7 @@
 final class UpdatePayPalOrderAction
 {
     public function __construct(
-        private readonly PaymentProviderInterface $paymentProvider,
+        private readonly ?PaymentProviderInterface $paymentProvider,
         private readonly CacheAuthorizeClientApiInterface $authorizeClientApi,
         private readonly ?OrderDetailsApiInterface $orderDetailsApi,
         private readonly UpdateOrderApiInterface $updateOrderApi,
@@ -49,6 +49,26 @@ public function __construct(
                 ),
             );
         }
+        if (null !== $this->paymentProvider) {
+            trigger_deprecation(
+                'sylius/paypal-plugin',
+                '1.7',
+                sprintf(
+                    'Passing an instance of "%s" as the first argument is deprecated and will be prohibited in 3.0',
+                    PaymentProviderInterface::class,
+                ),
+            );
+        }
+        if (null === $this->paypalPaymentQuery) {
+            trigger_deprecation(
+                'sylius/paypal-plugin',
+                '1.7',
+                sprintf(
+                    'Not passing an instance of "%s" is deprecated and will be prohibited in 3.0',
+                    PaypalPaymentQueryInterface::class,
+                ),
+            );
+        }
     }
 
     public function __invoke(Request $request): Response

src/Controller/Webhook/RefundOrderAction.php

@@ -32,7 +32,7 @@ final class RefundOrderAction
 {
     public function __construct(
         private readonly FactoryInterface|StateMachineInterface $stateMachineFactory,
-        private readonly PaymentProviderInterface $paymentProvider,
+        private readonly ?PaymentProviderInterface $paymentProvider,
         private readonly ObjectManager $paymentManager,
         private readonly PayPalRefundDataProviderInterface $payPalRefundDataProvider,
         private readonly ?PaypalPaymentQueryInterface $paypalPaymentQuery = null,
@@ -48,6 +48,26 @@ public function __construct(
                 ),
             );
         }
+        if (null !== $this->paymentProvider) {
+            trigger_deprecation(
+                'sylius/paypal-plugin',
+                '1.7',
+                sprintf(
+                    'Passing an instance of "%s" as the second argument is deprecated and will be prohibited in 3.0',
+                    PaymentProviderInterface::class,
+                ),
+            );
+        }
+        if (null === $this->paypalPaymentQuery) {
+            trigger_deprecation(
+                'sylius/paypal-plugin',
+                '1.7',
+                sprintf(
+                    'Not passing an instance of "%s" is deprecated and will be prohibited in 3.0',
+                    PaypalPaymentQueryInterface::class,
+                ),
+            );
+        }
     }
 
     public function __invoke(Request $request): Response

src/Provider/PaymentProvider.php

@@ -16,7 +16,16 @@
 use Sylius\Component\Core\Model\PaymentInterface;
 use Sylius\Component\Core\Repository\PaymentRepositoryInterface;
 use Sylius\PayPalPlugin\Exception\PaymentNotFoundException;
-
+use Sylius\PayPalPlugin\Repository\Query\PaypalPaymentQuery;
+
+trigger_deprecation(
+    'sylius/paypal-plugin',
+    '1.7',
+    'The "%s" class is deprecated and will be removed in Sylius/PayPalPlugin 3.0. Use "%s" instead.',
+    PaymentProvider::class,
+    PaypalPaymentQuery::class,
+);
+/** @deprecated since Sylius/PayPalPlugin 1.7 and will be removed in Sylius/PayPalPlugin 3.0. */
 final class PaymentProvider implements PaymentProviderInterface
 {
     private PaymentRepositoryInterface $paymentRepository;

src/Provider/PaymentProviderInterface.php

@@ -15,7 +15,16 @@
 
 use Sylius\Component\Core\Model\PaymentInterface;
 use Sylius\PayPalPlugin\Exception\PaymentNotFoundException;
+use Sylius\PayPalPlugin\Repository\Query\PaypalPaymentQueryInterface;
 
+trigger_deprecation(
+    'sylius/paypal-plugin',
+    '1.7',
+    'The "%s" interface is deprecated and will be removed in Sylius/PayPalPlugin 3.0. Use "%s" instead.',
+    PaymentProviderInterface::class,
+    PaypalPaymentQueryInterface::class,
+);
+/** @deprecated since Sylius/PayPalPlugin 1.7 and will be removed in Sylius/PayPalPlugin 3.0. */
 interface PaymentProviderInterface
 {
     /** @throws PaymentNotFoundException */

src/Resources/config/services.xml

@@ -100,6 +100,7 @@
         >
             <argument type="service" id="sylius.repository.payment" />
             <argument type="service" id="sylius.repository.order" />
+            <deprecated package="sylius/paypal-plugin" version="1.7">The "%service_id%" service is deprecated since 1.7 and will be removed in 3.0.</deprecated>
         </service>
         <service id="sylius_paypal.provider.payment" alias="Sylius\PayPalPlugin\Provider\PaymentProviderInterface" />