Update parameter names in PaymentHandlerInterface implementations

Author: damms005

src/Contracts/PaymentHandlerInterface.php

@@ -28,11 +28,11 @@ public function proceedToPaymentGateway(Payment $payment, $redirect_or_callback_
      * process it should confirm that the payment_processor_name for the transaction is the
      * same as its own getUniquePaymentHandlerName() value, then handle the response and return the Payment object
      *
-     * @param Request $request
+     * @param Request $paymentGatewayServerResponse
      *
      * @return Payment
      */
-    public function confirmResponseCanBeHandledAndUpdateDatabaseWithTransactionOutcome(Request $request): ?Payment;
+    public function confirmResponseCanBeHandledAndUpdateDatabaseWithTransactionOutcome(Request $paymentGatewayServerResponse): ?Payment;
 
     public function getHumanReadableTransactionResponse(Payment $payment): string;
 

src/Services/PaymentHandlers/Flutterwave.php

@@ -85,13 +85,13 @@ protected function sendUserToPaymentGateway(string $redirect_or_callback_url, Pa
         exit;
     }
 
-    public function confirmResponseCanBeHandledAndUpdateDatabaseWithTransactionOutcome(Request $request): ?Payment
+    public function confirmResponseCanBeHandledAndUpdateDatabaseWithTransactionOutcome(Request $paymentGatewayServerResponse): ?Payment
     {
-        if (!$request->has('tx_ref')) {
+        if (!$paymentGatewayServerResponse->has('tx_ref')) {
             return null;
         }
 
-        $payment = $this->handleExternalWebhookRequest($request);
+        $payment = $this->handleExternalWebhookRequest($paymentGatewayServerResponse);
 
         return $payment;
     }

src/Services/PaymentHandlers/Interswitch.php

@@ -49,7 +49,7 @@ public function proceedToPaymentGateway(Payment $payment, $redirect_or_callback_
         ]);
     }
 
-    public function confirmResponseCanBeHandledAndUpdateDatabaseWithTransactionOutcome(Request $request): ?Payment
+    public function confirmResponseCanBeHandledAndUpdateDatabaseWithTransactionOutcome(Request $paymentGatewayServerResponse): ?Payment
     {
         return null;
     }

src/Services/PaymentHandlers/Paystack.php

@@ -44,34 +44,34 @@ public function proceedToPaymentGateway(Payment $payment, $redirect_or_callback_
     /**
      * This is a get request. (https://developers.paystack.co/docs/paystack-standard#section-4-verify-transaction)
      *
-     * @param Request $request
+     * @param Request $paymentGatewayServerResponse
      *
      * @return Payment
      */
-    public function confirmResponseCanBeHandledAndUpdateDatabaseWithTransactionOutcome(Request $request): ?Payment
+    public function confirmResponseCanBeHandledAndUpdateDatabaseWithTransactionOutcome(Request $paymentGatewayServerResponse): ?Payment
     {
-        if (!$request->has('reference')) {
+        if (!$paymentGatewayServerResponse->has('reference')) {
             return null;
         }
 
-        return $this->processValueForTransaction($request->reference);
+        return $this->processValueForTransaction($paymentGatewayServerResponse->reference);
     }
 
     /**
      * For Paystack, this is a get request. (https://developers.paystack.co/docs/paystack-standard#section-4-verify-transaction)
      */
-    public function processValueForTransaction(string $transactionReferenceIdNumber): ?Payment
+    public function processValueForTransaction(string $paystackReference): ?Payment
     {
-        throw_if(empty($transactionReferenceIdNumber));
+        throw_if(empty($paystackReference));
 
-        $verificationResponse = $this->verifyPaystackTransaction($transactionReferenceIdNumber);
+        $verificationResponse = $this->verifyPaystackTransaction($paystackReference);
 
         // status should be true if there was a successful call
         if (!$verificationResponse->status) {
             throw new \Exception($verificationResponse->message);
         }
 
-        $payment = $this->resolveLocalPayment($transactionReferenceIdNumber, $verificationResponse);
+        $payment = $this->resolveLocalPayment($paystackReference, $verificationResponse);
 
         if ('success' === $verificationResponse->data['status']) {
             if ($payment->payment_processor_name != $this->getUniquePaymentHandlerName()) {
@@ -104,7 +104,7 @@ public function reQuery(Payment $existingPayment): ?ReQuery
             throw new \Exception($verificationResponse->message);
         }
 
-        $payment = $this->resolveLocalPayment($existingPayment->transaction_reference, $verificationResponse);
+        $payment = $this->resolveLocalPayment($existingPayment->processor_transaction_reference, $verificationResponse);
 
         if ('success' === $verificationResponse->data['status']) {
             if ($payment->payment_processor_name != $this->getUniquePaymentHandlerName()) {
@@ -266,13 +266,13 @@ public function createPaymentPlan(string $name, string $amount, string $interval
         return '';
     }
 
-    protected function resolveLocalPayment(string $transactionReferenceIdNumber, PaystackVerificationResponse $verificationResponse): Payment
+    protected function resolveLocalPayment(string $paystackReferenceNumber, PaystackVerificationResponse $verificationResponse): Payment
     {
         return Payment::query()
             /**
              * normal transactions
              */
-            ->where('processor_transaction_reference', $transactionReferenceIdNumber)
+            ->where('processor_transaction_reference', $paystackReferenceNumber)
 
             /**
              * terminal POS transactions

src/Services/PaymentHandlers/Remita.php

@@ -91,13 +91,13 @@ protected function getRrrToInitiatePayment(Payment $payment): string
         return $responseJson['RRR'];
     }
 
-    public function confirmResponseCanBeHandledAndUpdateDatabaseWithTransactionOutcome(Request $request): ?Payment
+    public function confirmResponseCanBeHandledAndUpdateDatabaseWithTransactionOutcome(Request $paymentGatewayServerResponse): ?Payment
     {
-        if (!$request->has('RRR')) {
+        if (!$paymentGatewayServerResponse->has('RRR')) {
             return null;
         }
 
-        $rrr = $request->RRR;
+        $rrr = $paymentGatewayServerResponse->RRR;
 
         $payment = Payment::where('processor_transaction_reference', $rrr)
             ->first();

src/Services/PaymentHandlers/UnifiedPayments.php

@@ -44,17 +44,17 @@ public function proceedToPaymentGateway(Payment $payment, $redirect_or_callback_
 
     /**
      *
-     * @param Request $request
+     * @param Request $paymentGatewayServerResponse
      *
      * @return Payment
      */
-    public function confirmResponseCanBeHandledAndUpdateDatabaseWithTransactionOutcome(Request $request): ?Payment
+    public function confirmResponseCanBeHandledAndUpdateDatabaseWithTransactionOutcome(Request $paymentGatewayServerResponse): ?Payment
     {
-        if (!$request->has('trxId')) {
+        if (!$paymentGatewayServerResponse->has('trxId')) {
             return null;
         }
 
-        $payment = Payment::where('processor_transaction_reference', $request->trxId)->first();
+        $payment = Payment::where('processor_transaction_reference', $paymentGatewayServerResponse->trxId)->first();
 
         if (is_null($payment)) {
             return null;