Merge pull request #57 from AltaPay/narrow-array-types

Narrow array types

Author: emicha

.github/workflows/code-analysis.yml

@@ -42,14 +42,4 @@ jobs:
        uses: StephaneBour/[email protected]
        with:
          dir: './src'
-
-     - name: Install PHP 5.6
-       uses: shivammathur/setup-php@v2
-       with:
-         php-version: '5.6'
-         
-     - name: Run Linter for PHP5.6
-       uses: StephaneBour/[email protected]
-       with:
-         dir: './src'
 

CHANGELOG.md

@@ -4,6 +4,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [3.5.1] - 2025-06-11
+### Added
+- Improve type hinting.
+- Improve return type annotations for better type clarity.
+- Improve error handling by validating error message types.
+- Add null check before setting the User-Agent header.
+- Restrict supported PHP versions to 7.0 and above.
+
 ## [3.5.0] - 2025-05-12
 ### Added
 - Make billing and shipping address optional for Customer Info

README.md

@@ -26,7 +26,7 @@ try {
 
 ## Requirements
 
-The AltaPay API PHP requires PHP 5.6.0 or greater with the following extensions installed:
+The AltaPay API PHP requires PHP 7.0.0 or greater with the following extensions installed:
 
 - date
 - filter

composer.json

@@ -22,7 +22,7 @@
         ]
     },
     "require": {
-        "php": "^5.6 || ^7.0 || ^8.0",
+        "php": "^7.0 || ^8.0",
         "ext-date": "*",
         "ext-filter": "*",
         "ext-mbstring": "*",
@@ -37,7 +37,7 @@
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^3.0",
         "fzaninotto/faker": "^1.6",
-        "phpstan/phpstan": "^1.8",
+        "phpstan/phpstan": "^2.1",
         "phpstan/phpstan-phpunit": "*",
         "phpstan/phpstan-strict-rules": "*",
         "phpunit/phpunit": "^7.0 || ^8.0 || ^9.0"

src/AbstractApi.php

@@ -55,7 +55,7 @@ abstract class AbstractApi
     /**
      * PHP API version
      */
-    const PHP_API_VERSION = '3.5.0';
+    const PHP_API_VERSION = '3.5.1';
 
     /**
      * Event dispatcher
@@ -128,7 +128,7 @@ abstract protected function configureOptions(OptionsResolver $resolver);
      * @param Request           $request
      * @param ResponseInterface $response
      *
-     * @return AbstractResponse|string|array<Transaction>
+     * @return AbstractResponse|string|list<Transaction>
      */
     abstract protected function handleResponse(Request $request, ResponseInterface $response);
 
@@ -157,7 +157,7 @@ public function __construct(Authentication $authentication)
     /**
      * Generate the response
      *
-     * @return AbstractResponse|string|array<Transaction>
+     * @return AbstractResponse|string|list<Transaction>
      * @throws GuzzleException
      * @throws ResponseHeaderException
      * @throws ResponseMessageException
@@ -233,7 +233,9 @@ protected function doConfigureOptions()
         $this->setCustomerInfoResolver($resolver);
         $this->setValidationUrlResolver($resolver);
         $this->setAppleDomainResolver($resolver);
-        $this->options = $resolver->resolve($this->unresolvedOptions);
+        /** @var array<string, mixed> */
+        $options = $resolver->resolve($this->unresolvedOptions);
+        $this->options = $options;
     }
 
     /**
@@ -253,13 +255,13 @@ protected function validateResponse($response)
         }
 
         if (property_exists($response, 'MerchantErrorMessage')) {
-            if ($response->MerchantErrorMessage) {
+            if ($response->MerchantErrorMessage && is_string($response->MerchantErrorMessage)) {
                 throw new Exceptions\ResponseMessageException($response->MerchantErrorMessage);
             }
         }
 
         if (property_exists($response, 'CardHolderErrorMessage') && property_exists($response, 'CardHolderMessageMustBeShown')) {
-            if ($response->CardHolderMessageMustBeShown) {
+            if ($response->CardHolderMessageMustBeShown && is_string($response->CardHolderErrorMessage)) {
                 throw new Exceptions\ResponseMessageException($response->CardHolderErrorMessage);
             }
         }
@@ -268,7 +270,7 @@ protected function validateResponse($response)
     /**
      * Generate the response
      *
-     * @return AbstractResponse|string|array<Transaction>
+     * @return AbstractResponse|string|list<Transaction>
      * @throws GuzzleException
      * @throws ClientException
      * @throws ResponseHeaderException
@@ -318,7 +320,7 @@ protected function parseUrl()
     /**
      * Get User Agent details
      *
-     * @return string
+     * @return ?string
      */
     protected function getUserAgent()
     {
@@ -328,14 +330,14 @@ protected function getUserAgent()
             $userAgent = 'api-php/' . self::PHP_API_VERSION;
             if (extension_loaded('curl') && function_exists('curl_version')) {
                 $curlInfo = \curl_version();
-                if (is_array($curlInfo) && array_key_exists("version", $curlInfo)) {
+                if (is_array($curlInfo) && array_key_exists("version", $curlInfo) && is_string($curlInfo["version"])) {
                     $userAgent .= ' curl/' . $curlInfo["version"];
                 }
             }
             $userAgent .= ' PHP/' . PHP_VERSION;
         }
 
-        return $userAgent;
+        return is_string($userAgent) ? $userAgent : null;
     }
 
     /**
@@ -380,7 +382,10 @@ protected function getBasicHeaders()
             );
         }
 
-        $headers['User-Agent'] = $this->getUserAgent();
+        $userAgen = $this->getUserAgent();
+        if ($userAgen) {
+            $headers['User-Agent'] = $userAgen;
+        }
 
         return $headers;
     }

src/Api/Ecommerce/PaymentRequest.php

@@ -306,10 +306,10 @@ protected function configureOptions(OptionsResolver $resolver)
         $resolver->setAllowedValues('language', Types\LanguageTypes::getAllowed());
         $resolver->setDefault('type', 'payment');
         $resolver->setAllowedValues('type', Types\PaymentTypes::getAllowed());
-        $resolver->setAllowedValues('sale_reconciliation_identifier', function ($value) {
+        $resolver->setAllowedValues('sale_reconciliation_identifier', function (string $value) {
             return mb_strlen($value) <= 100;
         });
-        $resolver->setAllowedValues('sale_invoice_number', function ($value) {
+        $resolver->setAllowedValues('sale_invoice_number', function (string $value) {
             return mb_strlen($value) <= 100;
         });
         $resolver->setAllowedTypes('sales_tax', ['int', 'float']);
@@ -320,7 +320,7 @@ protected function configureOptions(OptionsResolver $resolver)
         $resolver->setNormalizer('config', function (Options $options, Config $value) {
             return $value->serialize();
         });
-        $resolver->setAllowedValues('organisation_number', function ($value) {
+        $resolver->setAllowedValues('organisation_number', function (string $value) {
             return mb_strlen($value) <= 20;
         });
         $resolver->setAllowedTypes('account_offer', 'bool');

src/Api/Others/Payments.php

@@ -97,7 +97,7 @@ protected function configureOptions(OptionsResolver $resolver)
      * @param Request $request
      * @param ResponseInterface $response
      *
-     * @return Transaction[]
+     * @return list<Transaction>
      * @throws \Exception
      */
     protected function handleResponse(Request $request, ResponseInterface $response)

src/Api/Payments/CardWalletAuthorize.php

@@ -291,10 +291,10 @@ protected function configureOptions(OptionsResolver $resolver)
         $resolver->setAllowedValues('language', Types\LanguageTypes::getAllowed());
         $resolver->setDefault('type', 'payment');
         $resolver->setAllowedValues('type', Types\PaymentTypes::getAllowed());
-        $resolver->setAllowedValues('sale_reconciliation_identifier', function ($value) {
+        $resolver->setAllowedValues('sale_reconciliation_identifier', function (string $value) {
             return mb_strlen($value) <= 100;
         });
-        $resolver->setAllowedValues('sale_invoice_number', function ($value) {
+        $resolver->setAllowedValues('sale_invoice_number', function (string $value) {
             return mb_strlen($value) <= 100;
         });
         $resolver->setAllowedTypes('sales_tax', ['int', 'float']);
@@ -305,7 +305,7 @@ protected function configureOptions(OptionsResolver $resolver)
         $resolver->setNormalizer('config', function (Options $options, Config $value) {
             return $value->serialize();
         });
-        $resolver->setAllowedValues('organisation_number', function ($value) {
+        $resolver->setAllowedValues('organisation_number', function (string $value) {
             return mb_strlen($value) <= 20;
         });
         $resolver->setAllowedTypes('account_offer', 'bool');

src/Api/Payments/ReservationOfFixedAmount.php

@@ -303,7 +303,7 @@ protected function configureOptions(OptionsResolver $resolver)
             return $value->serialize();
         });
         $resolver->setAllowedTypes('surcharge', ['int', 'float']);
-        $resolver->setAllowedValues('sale_invoice_number', function ($value) {
+        $resolver->setAllowedValues('sale_invoice_number', function (string $value) {
             return mb_strlen($value) <= 100;
         });
         $resolver->setNormalizer('cardnum', function (Options $options, $value) {

src/Request/Customer.php

@@ -841,11 +841,11 @@ public function serialize()
         }
 
         if ($this->clientJavascriptEnabled !== null) {
-            $output['client_javascript_enabled'] = $this->clientJavascriptEnabled;
+            $output['client_javascript_enabled'] = (string)$this->clientJavascriptEnabled;
         }
 
         if ($this->clientJavaEnabled !== null) {
-            $output['client_java_enabled'] = $this->clientJavaEnabled;
+            $output['client_java_enabled'] = (string)$this->clientJavaEnabled;
         }
 
         if ($this->clientColorDepth) {