Merge pull request #150 from maxmind/greg/types

Extend type hinting

Author: horgh

.travis.yml

@@ -5,15 +5,12 @@ dist: trusty
 
 matrix:
   include:
-    - php: '5.6'
-    - php: '7.0'
-    - php: '7.1'
     - php: '7.2'
     - php: '7.3'
+    - php: '7.4'
       env:
         - RUN_LINTER=1
         - RUN_SNYK=1
-    - php: '7.4'
     - php: 'master'
     - php: 'nightly'
   fast_finish: true

CHANGELOG.md

@@ -4,8 +4,10 @@ CHANGELOG
 2.11.0
 -------------------
 
+* IMPORTANT: PHP 7.2 or greater is now required.
 * Added the `isResidentialProxy` property to `GeoIp2\Model\AnonymousIP` and
   `GeoIp2\Record\Traits`.
+* Additional type hints have been added.
 
 2.10.0 (2019-12-12)
 -------------------

composer.json

@@ -13,14 +13,14 @@
         }
     ],
     "require": {
-        "maxmind-db/reader": "~1.5",
+        "maxmind-db/reader": "~1.7",
         "maxmind/web-service-common": "~0.6",
-        "php": ">=5.6",
+        "php": ">=7.2",
         "ext-json": "*"
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "2.*",
-        "phpunit/phpunit": "5.*",
+        "phpunit/phpunit": "^8.0 || ^9.0",
         "squizlabs/php_codesniffer": "3.*"
     },
     "autoload": {

src/Database/Reader.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace GeoIp2\Database;
 
 use GeoIp2\Exception\AddressNotFoundException;
@@ -48,8 +50,8 @@ class Reader implements ProviderInterface
      *                                                     is corrupt or invalid
      */
     public function __construct(
-        $filename,
-        $locales = ['en']
+        string $filename,
+        array $locales = ['en']
     ) {
         $this->dbReader = new DbReader($filename);
         $this->dbType = $this->dbReader->metadata()->databaseType;
@@ -65,10 +67,8 @@ public function __construct(
      *                                                     not in the database
      * @throws \MaxMind\Db\Reader\InvalidDatabaseException if the database
      *                                                     is corrupt or invalid
-     *
-     * @return \GeoIp2\Model\City
      */
-    public function city($ipAddress)
+    public function city(string $ipAddress): \GeoIp2\Model\City
     {
         return $this->modelFor('City', 'City', $ipAddress);
     }
@@ -82,10 +82,8 @@ public function city($ipAddress)
      *                                                     not in the database
      * @throws \MaxMind\Db\Reader\InvalidDatabaseException if the database
      *                                                     is corrupt or invalid
-     *
-     * @return \GeoIp2\Model\Country
      */
-    public function country($ipAddress)
+    public function country(string $ipAddress): \GeoIp2\Model\Country
     {
         return $this->modelFor('Country', 'Country', $ipAddress);
     }
@@ -99,10 +97,8 @@ public function country($ipAddress)
      *                                                     not in the database
      * @throws \MaxMind\Db\Reader\InvalidDatabaseException if the database
      *                                                     is corrupt or invalid
-     *
-     * @return \GeoIp2\Model\AnonymousIp
      */
-    public function anonymousIp($ipAddress)
+    public function anonymousIp(string $ipAddress): \GeoIp2\Model\AnonymousIp
     {
         return $this->flatModelFor(
             'AnonymousIp',
@@ -120,10 +116,8 @@ public function anonymousIp($ipAddress)
      *                                                     not in the database
      * @throws \MaxMind\Db\Reader\InvalidDatabaseException if the database
      *                                                     is corrupt or invalid
-     *
-     * @return \GeoIp2\Model\Asn
      */
-    public function asn($ipAddress)
+    public function asn(string $ipAddress): \GeoIp2\Model\Asn
     {
         return $this->flatModelFor(
             'Asn',
@@ -141,10 +135,8 @@ public function asn($ipAddress)
      *                                                     not in the database
      * @throws \MaxMind\Db\Reader\InvalidDatabaseException if the database
      *                                                     is corrupt or invalid
-     *
-     * @return \GeoIp2\Model\ConnectionType
      */
-    public function connectionType($ipAddress)
+    public function connectionType(string $ipAddress): \GeoIp2\Model\ConnectionType
     {
         return $this->flatModelFor(
             'ConnectionType',
@@ -162,10 +154,8 @@ public function connectionType($ipAddress)
      *                                                     not in the database
      * @throws \MaxMind\Db\Reader\InvalidDatabaseException if the database
      *                                                     is corrupt or invalid
-     *
-     * @return \GeoIp2\Model\Domain
      */
-    public function domain($ipAddress)
+    public function domain(string $ipAddress): \GeoIp2\Model\Domain
     {
         return $this->flatModelFor(
             'Domain',
@@ -183,10 +173,8 @@ public function domain($ipAddress)
      *                                                     not in the database
      * @throws \MaxMind\Db\Reader\InvalidDatabaseException if the database
      *                                                     is corrupt or invalid
-     *
-     * @return \GeoIp2\Model\Enterprise
      */
-    public function enterprise($ipAddress)
+    public function enterprise(string $ipAddress): \GeoIp2\Model\Enterprise
     {
         return $this->modelFor('Enterprise', 'Enterprise', $ipAddress);
     }
@@ -200,10 +188,8 @@ public function enterprise($ipAddress)
      *                                                     not in the database
      * @throws \MaxMind\Db\Reader\InvalidDatabaseException if the database
      *                                                     is corrupt or invalid
-     *
-     * @return \GeoIp2\Model\Isp
      */
-    public function isp($ipAddress)
+    public function isp(string $ipAddress): \GeoIp2\Model\Isp
     {
         return $this->flatModelFor(
             'Isp',
@@ -212,7 +198,7 @@ public function isp($ipAddress)
         );
     }
 
-    private function modelFor($class, $type, $ipAddress)
+    private function modelFor(string $class, string $type, string $ipAddress)
     {
         list($record, $prefixLen) = $this->getRecord($class, $type, $ipAddress);
 
@@ -224,7 +210,7 @@ private function modelFor($class, $type, $ipAddress)
         return new $class($record, $this->locales);
     }
 
-    private function flatModelFor($class, $type, $ipAddress)
+    private function flatModelFor(string $class, string $type, string $ipAddress)
     {
         list($record, $prefixLen) = $this->getRecord($class, $type, $ipAddress);
 
@@ -235,7 +221,7 @@ private function flatModelFor($class, $type, $ipAddress)
         return new $class($record);
     }
 
-    private function getRecord($class, $type, $ipAddress)
+    private function getRecord(string $class, string $type, string $ipAddress): array
     {
         if (strpos($this->dbType, $type) === false) {
             $method = lcfirst($class);
@@ -272,15 +258,15 @@ private function getRecord($class, $type, $ipAddress)
      *
      * @return \MaxMind\Db\Reader\Metadata object for the database
      */
-    public function metadata()
+    public function metadata(): \MaxMind\Db\Reader\Metadata
     {
         return $this->dbReader->metadata();
     }
 
     /**
      * Closes the GeoIP2 database and returns the resources to the system.
      */
-    public function close()
+    public function close(): void
     {
         $this->dbReader->close();
     }

src/Exception/AddressNotFoundException.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace GeoIp2\Exception;
 
 /**

src/Exception/AuthenticationException.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace GeoIp2\Exception;
 
 /**

src/Exception/GeoIp2Exception.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace GeoIp2\Exception;
 
 /**

src/Exception/HttpException.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace GeoIp2\Exception;
 
 /**
@@ -13,9 +15,9 @@ class HttpException extends GeoIp2Exception
     public $uri;
 
     public function __construct(
-        $message,
-        $httpStatus,
-        $uri,
+        string $message,
+        int $httpStatus,
+        string $uri,
         \Exception $previous = null
     ) {
         $this->uri = $uri;

src/Exception/InvalidRequestException.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace GeoIp2\Exception;
 
 /**
@@ -14,10 +16,10 @@ class InvalidRequestException extends HttpException
     public $error;
 
     public function __construct(
-        $message,
-        $error,
-        $httpStatus,
-        $uri,
+        string $message,
+        string $error,
+        int $httpStatus,
+        string $uri,
         \Exception $previous = null
     ) {
         $this->error = $error;

src/Exception/OutOfQueriesException.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace GeoIp2\Exception;
 
 /**