Skip to content

Commit

Permalink
Fix styling
Browse files Browse the repository at this point in the history
  • Loading branch information
MusahMusah authored and github-actions[bot] committed Feb 8, 2024
1 parent 35c4ca4 commit 6f59a19
Show file tree
Hide file tree
Showing 11 changed files with 59 additions and 59 deletions.
6 changes: 3 additions & 3 deletions src/Exceptions/InvalidPaymentWebhookConfig.php
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ public static function signingSecretMissing(string $configNotFoundName): self
/**
* An exception thrown an invalid webhook job class is provided
*
* @param string $processWebhookJob the invalid class name
* @param string $processWebhookJob the invalid class name
*/
public static function invalidWebhookJob(string $processWebhookJob): self
{
Expand All @@ -40,7 +40,7 @@ public static function invalidWebhookJob(string $processWebhookJob): self
/**
* An exception thrown when an invalid webhook event class is provided
*
* @param string $processWebhookEvent the invalid class name
* @param string $processWebhookEvent the invalid class name
*/
public static function invalidWebhookEvent(string $processWebhookEvent): self
{
Expand All @@ -52,7 +52,7 @@ public static function invalidWebhookEvent(string $processWebhookEvent): self
/**
* An exception thrown when an invalid signature validator event class is provided
*
* @param string $processSignatureValidator the invalid class name
* @param string $processSignatureValidator the invalid class name
*/
public static function invalidSignatureValidator(string $processSignatureValidator): self
{
Expand Down
2 changes: 1 addition & 1 deletion src/Services/PaymentWebhookConfigRepository.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ public function storeConfig(PaymentWebhookConfig $webhookConfig): void
/**
* Retrieve the webhook configuration for a specific payment gateway
*
* @param string $name The name of the payment gateway
* @param string $name The name of the payment gateway
*/
public function getConfig(string $name): ?PaymentWebhookConfig
{
Expand Down
4 changes: 2 additions & 2 deletions src/Services/PaymentWebhookHandler.php
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ protected function handleDuplicateWebhook(): JsonResponse
/**
* Handle the webhook response by returning a JSON response
*
* @param string $webhookResponse The message to be returned in the response
* @param string $webhookResponse The message to be returned in the response
*/
protected function handleWebhookResponse(string $webhookResponse = self::WEBHOOK_RESPONSE_MESSAGE): JsonResponse
{
Expand Down Expand Up @@ -179,7 +179,7 @@ protected function handlePaymentWebhook(string $paymentWebhookHandler): void
/**
* Create the webhook job
*
* @throws InvalidPaymentWebhookConfig
* @throws InvalidPaymentWebhookConfig
*/
protected function createWebhookJob()
{
Expand Down
2 changes: 1 addition & 1 deletion src/Traits/Flutterwave/BankTrait.php
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ public function getBanks(string $countryCode): array
/**
* Get all branches of a bank
*
* @param int $bankId The ID of the bank for which to retrieve branches
* @param int $bankId The ID of the bank for which to retrieve branches
*/
public function getBankBranches(int $bankId): array
{
Expand Down
58 changes: 29 additions & 29 deletions src/Traits/Flutterwave/ChargeTrait.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ trait ChargeTrait
/**
* Initiate a debit or credit card payment.
*
* @param array $formParams An associative array of payment data.
* @param array $formParams An associative array of payment data.
*
* @throws InvalidConfigurationException
*/
Expand All @@ -30,7 +30,7 @@ public function initiateCardCharge(array $formParams): array
/**
* Initiate a bank transfer payment.
*
* @param array $formParams An associative array of transfer data.
* @param array $formParams An associative array of transfer data.
*/
public function initiateBankTransfer(array $formParams): array
{
Expand All @@ -43,7 +43,7 @@ public function initiateBankTransfer(array $formParams): array
* This method charges a Nigerian bank account using Flutterwave. It requires the bank numeric code, account number,
* amount, email address and transaction reference to be provided in the request body.
*
* @param array $formParams An associative array of transfer data.
* @param array $formParams An associative array of transfer data.
*/
public function chargeNigerianBankAccount(array $formParams): array
{
Expand All @@ -56,7 +56,7 @@ public function chargeNigerianBankAccount(array $formParams): array
* This payment method helps you charge UK Bank accounts using Flutterwave.
* We recommend you read the method overview before you proceed.
*
* @param array $formParams An associative array of charge data.
* @param array $formParams An associative array of charge data.
*/
public function chargeUkBankAccount(array $formParams): array
{
Expand All @@ -68,7 +68,7 @@ public function chargeUkBankAccount(array $formParams): array
*
* This payment method allows you to collect USD and ZAR payments via ACH.
*
* @param array $formParams An associative array of charge data.
* @param array $formParams An associative array of charge data.
*/
public function chargeAchPayment(array $formParams): array
{
Expand All @@ -81,7 +81,7 @@ public function chargeAchPayment(array $formParams): array
* This payment method allows you to accept payments from your customers via Apple Pay.
* We recommend you read the method overview before you proceed.
*
* @param array $formParams An associative array of charge data.
* @param array $formParams An associative array of charge data.
*/
public function chargeApplePay(array $formParams): array
{
Expand All @@ -94,7 +94,7 @@ public function chargeApplePay(array $formParams): array
* This payment method allows you to accept payments from your customers via Google Pay.
* We recommend you read the method overview before you proceed.
*
* @param array $formParams An associative array of charge data.
* @param array $formParams An associative array of charge data.
*/
public function chargeGooglePay(array $formParams): array
{
Expand All @@ -106,7 +106,7 @@ public function chargeGooglePay(array $formParams): array
*
* This payment method allows you to accept payments from your customers via Fawry Pay.
*
* @param array $formParams An associative array of charge data.
* @param array $formParams An associative array of charge data.
*/
public function chargeFawryPay(array $formParams): array
{
Expand All @@ -118,7 +118,7 @@ public function chargeFawryPay(array $formParams): array
*
* This payment method allows you to accept payments from your customers via PayPal.
*
* @param array $formParams An associative array of charge data.
* @param array $formParams An associative array of charge data.
*/
public function chargePaypal(array $formParams): array
{
Expand All @@ -130,7 +130,7 @@ public function chargePaypal(array $formParams): array
*
* This payment method allows you to accept payments from your customers via M-Pesa.
*
* @param array $formParams An associative array of charge data.
* @param array $formParams An associative array of charge data.
*/
public function chargeMpesa(array $formParams): array
{
Expand All @@ -142,7 +142,7 @@ public function chargeMpesa(array $formParams): array
*
* This payment method allows you to accept payments from your customers via mobile money in Ghana.
*
* @param array $formParams An associative array of charge data.
* @param array $formParams An associative array of charge data.
*/
public function chargeGhanaMobileMoney(array $formParams): array
{
Expand All @@ -154,7 +154,7 @@ public function chargeGhanaMobileMoney(array $formParams): array
*
* This payment method allows you to accept payments from your customers via mobile money in Uganda.
*
* @param array $formParams An associative array of charge data.
* @param array $formParams An associative array of charge data.
*/
public function chargeUgandaMobileMoney(array $formParams): array
{
Expand All @@ -166,7 +166,7 @@ public function chargeUgandaMobileMoney(array $formParams): array
*
* This payment method allows you to accept payments from your customers via Mobile Money Franco.
*
* @param array $formParams An associative array of charge data.
* @param array $formParams An associative array of charge data.
*/
public function chargeMobileMoneyFranco(array $formParams): array
{
Expand All @@ -178,7 +178,7 @@ public function chargeMobileMoneyFranco(array $formParams): array
*
* This payment method allows you to accept payments from your customers via Mobile Money Rwanda.
*
* @param array $formParams An associative array of charge data.
* @param array $formParams An associative array of charge data.
*/
public function chargeMobileMoneyRwanda(array $formParams): array
{
Expand All @@ -190,7 +190,7 @@ public function chargeMobileMoneyRwanda(array $formParams): array
*
* This payment method allows you to accept payments from your customers via mobile money in Zambia.
*
* @param array $formParams An associative array of charge data.
* @param array $formParams An associative array of charge data.
*/
public function chargeZambiaMobileMoney(array $formParams): array
{
Expand All @@ -202,7 +202,7 @@ public function chargeZambiaMobileMoney(array $formParams): array
*
* This payment method allows you to accept payments from your customers via USSD.
*
* @param array $formParams An associative array of charge data.
* @param array $formParams An associative array of charge data.
*/
public function chargeUssd(array $formParams): array
{
Expand All @@ -212,8 +212,8 @@ public function chargeUssd(array $formParams): array
/**
* Charge a customer's payment using the specified payment method.
*
* @param string $paymentMethod The payment method to use.
* @param array $formParams An associative array of charge data.
* @param string $paymentMethod The payment method to use.
* @param array $formParams An associative array of charge data.
*/
private function chargePayment(string $paymentMethod, array $formParams): array
{
Expand All @@ -231,10 +231,10 @@ private function chargePayment(string $paymentMethod, array $formParams): array
/**
* Encrypts an array payload using 3DES-24 encryption.
*
* @param array $payload The payload to be encrypted.
* @return string The encrypted payload in base64 encoded format.
* @param array $payload The payload to be encrypted.
* @return string The encrypted payload in base64 encoded format.
*
* @throws InvalidConfigurationException If the encryption key is missing.
* @throws InvalidConfigurationException If the encryption key is missing.
*/
private function encryptPayload(array $payload): string
{
Expand All @@ -252,7 +252,7 @@ private function encryptPayload(array $payload): string
/**
* Validate a charge.
*
* @param array $formParams An associative array of charge validation data.
* @param array $formParams An associative array of charge validation data.
*/
public function validateCharge(array $formParams): array
{
Expand All @@ -265,8 +265,8 @@ public function validateCharge(array $formParams): array
/**
* Capture payment for an existing uncaptured charge.
*
* @param string $flwRef The data.flw_ref returned in the charge response.
* @param array $formParams An associative array of charge validation data.
* @param string $flwRef The data.flw_ref returned in the charge response.
* @param array $formParams An associative array of charge validation data.
*/
public function captureCharge(string $flwRef, array $formParams): array
{
Expand All @@ -279,7 +279,7 @@ public function captureCharge(string $flwRef, array $formParams): array
/**
* Void a previously captured charge to release the hold on the funds.
*
* @param string $flwRef The data.flw_ref returned in the charge response.
* @param string $flwRef The data.flw_ref returned in the charge response.
*/
public function voidCharge(string $flwRef): array
{
Expand All @@ -291,8 +291,8 @@ public function voidCharge(string $flwRef): array
/**
* Create a refund for an existing charge
*
* @param string $flwRef The data.flw_ref returned in the charge response.
* @param array $formParams An associative array of charge validation data.
* @param string $flwRef The data.flw_ref returned in the charge response.
* @param array $formParams An associative array of charge validation data.
*/
public function createRefund(string $flwRef, array $formParams): array
{
Expand All @@ -305,7 +305,7 @@ public function createRefund(string $flwRef, array $formParams): array
/**
* Capture the payment of a previously uncaptured PayPal charge
*
* @param array $formParams An associative array of charge validation data.
* @param array $formParams An associative array of charge validation data.
*/
public function capturePaypalCharge(array $formParams): array
{
Expand All @@ -318,7 +318,7 @@ public function capturePaypalCharge(array $formParams): array
/**
* Void a previously captured charge to release the hold on the funds.
*
* @param array $formParams An associative array of charge validation data.
* @param array $formParams An associative array of charge validation data.
*/
public function voidPaypalCharge(array $formParams): array
{
Expand Down
12 changes: 6 additions & 6 deletions src/Traits/Flutterwave/PaymentPlanTrait.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ trait PaymentPlanTrait
*
* This method helps you create a payment plan
*
* @param array $planDetails The details of the plan.
* @param array $planDetails The details of the plan.
*/
public function createPaymentPlan(array $planDetails): array
{
Expand All @@ -26,8 +26,8 @@ public function createPaymentPlan(array $planDetails): array
*
* This method allows you update a payment plan
*
* @param int $paymentPlanId The ID of the payment plan to update.
* @param array $planDetails The updated details of the plan.
* @param int $paymentPlanId The ID of the payment plan to update.
* @param array $planDetails The updated details of the plan.
*/
public function updatePaymentPlan(int $paymentPlanId, array $planDetails): array
{
Expand All @@ -42,7 +42,7 @@ public function updatePaymentPlan(int $paymentPlanId, array $planDetails): array
*
* This method retrieves all payment plans on the account
*
* @param array $queryParams [optional] The query parameters array.
* @param array $queryParams [optional] The query parameters array.
*/
public function getAllPaymentPlans(array $queryParams = []): array
{
Expand All @@ -57,7 +57,7 @@ public function getAllPaymentPlans(array $queryParams = []): array
*
* This method allows you to retrieve a single payment plan based on its ID.
*
* @param int $paymentPlanId The ID of the payment plan to retrieve.
* @param int $paymentPlanId The ID of the payment plan to retrieve.
*/
public function getPaymentPlan(int $paymentPlanId): array
{
Expand All @@ -71,7 +71,7 @@ public function getPaymentPlan(int $paymentPlanId): array
*
* This method allows the merchant/developer cancel an existing payment plan.
*
* @param int $paymentPlanId - The unique ID of the payment plan you want to cancel
* @param int $paymentPlanId - The unique ID of the payment plan you want to cancel
*/
public function cancelPaymentPlan(int $paymentPlanId): array
{
Expand Down
2 changes: 1 addition & 1 deletion src/Traits/Flutterwave/SettlementTrait.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ trait SettlementTrait
/**
* Get the settlement information for a given settlement ID
*
* @param int $settlementId The settlement ID to get information for.
* @param int $settlementId The settlement ID to get information for.
*/
public function getSettlement(int $settlementId): array
{
Expand Down
Loading

0 comments on commit 6f59a19

Please sign in to comment.