Merge pull request #872 from mollie/fix/refund-request-parameter-deprecation

Fix PHP 8+ deprecation warning in CreatePaymentRefundRequest

Author: Naoray

phpstan-baseline.neon

@@ -12,12 +12,6 @@ parameters:
 			count: 7
 			path: src/Http/Data/DataCollection.php
 
-		-
-			message: '#^Deprecated in PHP 8\.0\: Required parameter \$amount follows optional parameter \$description\.$#'
-			identifier: parameter.requiredAfterOptional
-			count: 1
-			path: src/Http/Requests/CreatePaymentRefundRequest.php
-
 		-
 			message: '#^Unsafe usage of new static\(\)\.$#'
 			identifier: new.static

src/Http/Requests/CreatePaymentRefundRequest.php

@@ -39,27 +39,18 @@ class CreatePaymentRefundRequest extends ResourceHydratableRequest implements Ha
 
     private ?DataCollection $routingReversals;
 
-    /**
-     * @deprecated When using positional arguments, this triggers a PHP 8+ deprecation warning
-     *             because optional parameter $description comes before required parameter $amount.
-     *             Use named parameters instead: new CreatePaymentRefundRequest(paymentId: $id, amount: $amount, description: $desc)
-     *             Or use the factory method: CreatePaymentRefundRequest::for($id, $amount, $desc)
-     *
-     * @param string $paymentId The payment ID to refund
-     * @param string $description Optional description for the refund
-     * @param Money $amount The amount to refund (required)
-     * @param array|null $metadata Optional metadata
-     * @param bool|null $reverseRouting Optional reverse routing flag
-     * @param DataCollection|null $routingReversals Optional routing reversals
-     */
     public function __construct(
         string $paymentId,
         string $description = '',
-        Money $amount,
+        ?Money $amount = null,
         ?array $metadata = null,
         ?bool $reverseRouting = null,
         ?DataCollection $routingReversals = null
     ) {
+        if ($amount === null) {
+            throw new \InvalidArgumentException('The amount parameter is required.');
+        }
+
         $this->paymentId = $paymentId;
         $this->description = $description;
         $this->amount = $amount;

tests/Http/Requests/CreatePaymentRefundRequestTest.php

@@ -48,6 +48,15 @@ public function it_resolves_correct_resource_path()
         );
     }
 
+    /** @test */
+    public function it_throws_when_amount_is_null()
+    {
+        $this->expectException(\InvalidArgumentException::class);
+        $this->expectExceptionMessage('The amount parameter is required.');
+
+        new CreatePaymentRefundRequest('tr_WDqYK6vllg', 'Order cancellation');
+    }
+
     /** @test */
     public function it_can_create_refund_request_using_factory_method()
     {