Merge pull request #41 from dotkernel/issue-40

alexmerlin · web-flow · commit 0d9cb0e7d403 · 2025-01-27T07:36:23.000+02:00
Issue #40: Added support for PHP 8.4
diff --git a/.laminas-ci.json b/.laminas-ci.json
@@ -0,0 +1,6 @@
+{
+  "ignore_php_platform_requirements": {
+    "8.4": true
+  },
+  "backwardCompatibilityCheck": true
+}
diff --git a/README.md b/README.md
@@ -2,11 +2,9 @@
 
 > [!IMPORTANT]
 > dot-geoip is a wrapper on top of [maxmind/GeoIP2-php](https://github.com/maxmind/GeoIP2-php)
->
-> ![OSS Lifecycle](https://img.shields.io/osslifecycle/maxmind/GeoIP2-php)
 
 ![OSS Lifecycle](https://img.shields.io/osslifecycle/dotkernel/dot-geoip)
-![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-geoip/3.6.0)
+![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-geoip/3.8.0)
 
 [![GitHub issues](https://img.shields.io/github/issues/dotkernel/dot-geoip)](https://github.com/dotkernel/dot-geoip/issues)
 [![GitHub forks](https://img.shields.io/github/forks/dotkernel/dot-geoip)](https://github.com/dotkernel/dot-geoip/network)
@@ -15,13 +13,13 @@
 
 [![Build Static](https://github.com/dotkernel/dot-geoip/actions/workflows/continuous-integration.yml/badge.svg?branch=3.0)](https://github.com/dotkernel/dot-geoip/actions/workflows/continuous-integration.yml)
 
-[![SymfonyInsight](https://insight.symfony.com/projects/f1468fbc-7c76-48d3-9ca7-0f4d135c0ff3/big.svg)](https://insight.symfony.com/projects/f1468fbc-7c76-48d3-9ca7-0f4d135c0ff3)
-
 ## Install
 
 You can install this library by running the following command:
 
-    composer require dotkernel/dot-geoip
+```shell
+composer require dotkernel/dot-geoip
+```
 
 If your application didn't already use it, the above command also installed [dotkernel/dot-cli](https://github.com/dotkernel/dot-cli).
 In this case, see it's [README](https://github.com/dotkernel/dot-cli/blob/3.0/README.md) file on how to use it.
@@ -30,86 +28,98 @@ Copy config file `vendor/dotkernel/dot-geoip/config/autoload/geoip.global.php` i
 
 Register the library's ConfigProvider by adding the following line to your application's `config/config.php` file:
 
-    Dot\GeoIP\ConfigProvider::class,
+```php
+Dot\GeoIP\ConfigProvider::class,
+```
 
 Register the library's synchronizer command by adding the following line to your application's `config/autoload/cli.global.php` file under the `commands` array key:
 
-    Dot\GeoIP\Command\GeoIpCommand::getDefaultName() => Dot\GeoIP\Command\GeoIpCommand::class,
+```php
+Dot\GeoIP\Command\GeoIpCommand::getDefaultName() => Dot\GeoIP\Command\GeoIpCommand::class,
+```
 
 ## Manage GeoLite2 database
 
 You can download/update a specific GeoLite2 database, by running the following command:
 
-    php bin/cli.php geoip:synchronize -d {DATABASE}
+```shell
+php ./bin/cli.php geoip:synchronize -d {DATABASE}
+```
 
 Where _{DATABASE}_ takes one of the following values: `asn`, `city`, `country`.
 
 You can download/update all GeoLite2 databases at once, by running the following command:
 
-    php bin/cli.php geoip:synchronize
+```shell
+php ./bin/cli.php geoip:synchronize
+```
 
 The output should be similar to the below, displaying per row: `database identifier`: `previous build datetime` -> `current build datetime`.
 
-    asn: n/a -> 2021-07-01 02:09:34
-    city: n/a -> 2021-07-01 02:09:20
-    country: n/a -> 2021-07-01 02:05:12
+```text
+asn: n/a -> 2021-07-01 02:09:34
+city: n/a -> 2021-07-01 02:09:20
+country: n/a -> 2021-07-01 02:05:12
+```
 
-Get help for this command by running `php bin/cli.php help geoip:synchronize`.
+Get help for this command by running `php ./bin/cli.php help geoip:synchronize`.
 
-**Tip**: If you setup the synchronizer command as a cronjob, you can add the `-q|--quiet` option, and it will output data only if an error has occurred.
+> If you set up the synchronizer command as a cronjob, you can add the `-q|--quiet` option, and it will output data only if an error has occurred.
 
 ## Usage
 
 Below is an example implementation of using DotGeoip to retrieve information about an IP address.
 
-    <?php
-    
-    declare(strict_types=1);
-    
-    namespace Api\Example\Service;
-    
-    use Dot\GeoIP\Service\LocationServiceInterface;
-    use Throwable;
-    
+```php
+<?php
+
+declare(strict_types=1);
+
+namespace Api\Example\Service;
+
+use Dot\GeoIP\Service\LocationServiceInterface;
+use Throwable;
+
+/**
+ * Class ExampleService
+ * @package Api\Example\Service
+ */
+class ExampleService
+{
+    protected LocationServiceInterface $locationService;
+
     /**
-     * Class ExampleService
-     * @package Api\Example\Service
+     * ExampleService constructor.
+     * @param LocationServiceInterface $locationService
      */
-    class ExampleService
+    public function __construct(LocationServiceInterface $locationService)
     {
-        protected LocationServiceInterface $locationService;
-    
-        /**
-         * ExampleService constructor.
-         * @param LocationServiceInterface $locationService
-         */
-        public function __construct(LocationServiceInterface $locationService)
-        {
-            $this->locationService = $locationService;
-        }
-    
-        /**
-         * @param string $ipAddress
-         * @return object
-         */
-        public function myMethod(string $ipAddress): object
-        {
-            try {
-                // You can use any of the below methods:
-                
-                // Get CountryData which includes isEuMember, isoCode and name
-                return $this->locationService->getCountry($ipAddress);
-                
-                // Get ContinentData which includes code and name
-                return $this->locationService->getContinent($ipAddress);
-                
-                // Get OrganizationData which includes asn and name
-                return $this->locationService->getOrganization($ipAddress);
-    
-                // Get LocationData which includes all of the above + estimated coordinates + timezone
-                return $this->locationService->getLocation($ipAddress);
-            } catch (Throwable $exception) {
-                // handle errors
-            }
+        $this->locationService = $locationService;
+    }
+
+    /**
+     * @param string $ipAddress
+     * @return object
+     */
+    public function myMethod(string $ipAddress): object
+    {
+        try {
+            // You can use any of the below methods:
+            
+            // Get CountryData which includes isEuMember, isoCode and name
+            return $this->locationService->getCountry($ipAddress);
+            
+            // Get ContinentData which includes code and name
+            return $this->locationService->getContinent($ipAddress);
+            
+            // Get OrganizationData which includes asn and name
+            return $this->locationService->getOrganization($ipAddress);
+
+            // Get LocationData which includes all of the above + estimated coordinates + timezone
+            return $this->locationService->getLocation($ipAddress);
+        } catch (Throwable $exception) {
+            // handle errors
         }
     }
+}
+```
diff --git a/composer.json b/composer.json
@@ -1,6 +1,6 @@
 {
     "name": "dotkernel/dot-geoip",
-    "description": "DotKernel component based on Maxmind's geoip2/geoip2 package, using their free GeoLite2 databases to provide geographical details about an IP address.",
+    "description": "Dotkernel component based on Maxmind's geoip2/geoip2 package, using their free GeoLite2 databases to provide geographical details about an IP address.",
     "type": "library",
     "license": "MIT",
     "keywords": [
@@ -11,7 +11,7 @@
     ],
     "authors": [
         {
-            "name": "DotKernel Team",
+            "name": "Dotkernel Team",
             "email": "team@dotkernel.com"
         }
     ],
@@ -22,7 +22,7 @@
         }
     },
     "require": {
-        "php": "~8.2.0 || ~8.3.0",
+        "php": "~8.2.0 || ~8.3.0 || ~8.4.0",
         "dotkernel/dot-cli": "^3.5",
         "geoip2/geoip2": "^3.0",
         "guzzlehttp/guzzle": "^7.8",
@@ -31,7 +31,7 @@
         "symfony/filesystem": "^7.0"
     },
     "require-dev": {
-        "laminas/laminas-coding-standard": "^2.5",
+        "laminas/laminas-coding-standard": "^3.0",
         "mikey179/vfsstream": "^1.6.7",
         "phpunit/phpunit": "^10.5",
         "vimeo/psalm": "^5.21"
@@ -49,7 +49,8 @@
     "scripts": {
         "check": [
             "@cs-check",
-            "@test"
+            "@test",
+            "@static-analysis"
         ],
         "cs-check": "phpcs",
         "cs-fix": "phpcbf",
diff --git a/docs/book/index.md b/docs/book/index.md
diff --git a/docs/book/index.md b/docs/book/index.md
@@ -0,0 +1 @@
+../../README.md
diff --git a/docs/book/v3/configuration.md b/docs/book/v3/configuration.md
@@ -4,8 +4,12 @@ Copy config file `vendor/dotkernel/dot-geoip/config/autoload/geoip.global.php` i
 
 Register the library's ConfigProvider by adding the following line to your application's `config/config.php` file:
 
-    Dot\GeoIP\ConfigProvider::class,
+```php
+Dot\GeoIP\ConfigProvider::class,
+```
 
 Register the library's synchronizer command by adding the following line to your application's `config/autoload/cli.global.php` file under the `commands` array key:
 
-    Dot\GeoIP\Command\GeoIpCommand::getDefaultName() => Dot\GeoIP\Command\GeoIpCommand::class,
+```php
+Dot\GeoIP\Command\GeoIpCommand::getDefaultName() => Dot\GeoIP\Command\GeoIpCommand::class,
+```
diff --git a/docs/book/v3/installation.md b/docs/book/v3/installation.md
@@ -2,4 +2,6 @@
 
 Install `dotkernel/dot-geoip` by executing the following Composer command:
 
-    composer require dotkernel/dot-geoip
+```shell
+composer require dotkernel/dot-geoip
+```
diff --git a/docs/book/v3/manage-geolite2-database.md b/docs/book/v3/manage-geolite2-database.md
@@ -2,16 +2,16 @@
 
 You can download/update a specific GeoLite2 database, by running the following command:
 
-```bash
-php bin/cli.php geoip:synchronize -d {DATABASE}
+```shell
+php ./bin/cli.php geoip:synchronize -d {DATABASE}
 ```
 
 Where _{DATABASE}_ takes one of the following values: `asn`, `city`, `country`.
 
 You can download/update all GeoLite2 databases at once, by running the following command:
 
-```bash
-php bin/cli.php geoip:synchronize
+```shell
+php ./bin/cli.php geoip:synchronize
 ```
 
 The output should be similar to the below, displaying per row: `database identifier`: `previous build datetime` -> `current build datetime`.
@@ -24,4 +24,4 @@ country: n/a -> 2021-07-01 02:05:12
 
 Get help for this command by running `php bin/cli.php help geoip:synchronize`.
 
-**Tip**: If you set up the synchronizer command as a cronjob, you can add the `-q|--quiet` option, and it will output data only if an error has occurred.
+> If you set up the synchronizer command as a cronjob, you can add the `-q|--quiet` option, and it will output data only if an error has occurred.
diff --git a/docs/book/v3/overview.md b/docs/book/v3/overview.md
@@ -1,5 +1,3 @@
 # Overview
 
 > dot-geoip is a wrapper on top of [dot-geoip](https://github.com/maxmind/GeoIP2-php)
->
-> ![OSS Lifecycle](https://img.shields.io/osslifecycle/maxmind/GeoIP2-php)
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -14,7 +14,7 @@ nav:
       - "Manage GeoLite2 database": v3/manage-geolite2-database.md
       - Usage: v3/usage.md
 site_name: dot-geoip
-site_description: "DotKernel's component to provide geographical details about an IP address"
+site_description: "Dotkernel's component to provide geographical details about an IP address"
 repo_url: "https://github.com/dotkernel/dot-geoip"
 plugins:
   - search
