- fix bug: #1

- improvement for php8.4
- add doc comment phpstan & readabilities improvement

Author: ArrayIterator

src/Util/CIDR.php

@@ -24,6 +24,12 @@
 
 class CIDR
 {
+    /**
+     * Normalize ip6 address
+     *
+     * @param string $ip ip address
+     * @return string|null normalized ip address
+     */
     public static function normalizeIp6(string $ip) :?string
     {
         if (!str_contains($ip, ':')) {
@@ -35,6 +41,12 @@ public static function normalizeIp6(string $ip) :?string
         return implode(':', str_split(bin2hex($bin), 4));
     }
 
+    /**
+     * Normalize ip4 address
+     *
+     * @param string $arg ip address
+     * @return string|null normalized ip address
+     */
     public static function normalizeIp4(string $arg): ?string
     {
         $arg = trim($arg);
@@ -66,6 +78,8 @@ public static function normalizeIp4(string $arg): ?string
     }
 
     /**
+     * Convert ip4 cidr to range
+     *
      * @param string $cidr
      * @return ?array{0:string, 1:string}
      */
@@ -87,13 +101,21 @@ public static function ip4CidrToRange(string $cidr): ?array
             return null;
         }
         $range = (int) $range;
-        return [
-            long2ip((ip2long($ip)) & ((-1 << (32 - $range)))),
-            long2ip((ip2long($ip)) + pow(2, (32 - $range)) - 1)
-        ];
+        $ipLong = ip2long($ip);
+        if ($ipLong === false) {
+            return null;
+        }
+        $first = long2ip(($ipLong) & ((-1 << (32 - $range))));
+        $last  = long2ip(($ipLong) + pow(2, (32 - $range)) - 1);
+        if (!$first || !$last) {
+            return null;
+        }
+        return [$first, $last];
     }
 
     /**
+     * Convert ip6 cidr to range
+     *
      * @param string $cidr
      * @return ?array{0:string, 1:string}
      */
@@ -145,17 +167,24 @@ public static function ip6cidrToRange(string $cidr) : ?array
     }
 
     /**
+     * Convert cidr to range
+     *
      * @param string $cidr
      * @return ?array{0:string, 1:string}
      */
     public static function cidrToRange(string $cidr) : ?array
     {
-        if (str_contains($cidr, ':')) {
-            return self::ip6cidrToRange($cidr);
-        }
-        return self::ip4cidrToRange($cidr);
+        return str_contains($cidr, ':')
+            ? self::ip6CidrToRange($cidr)
+            : self::ip4CidrToRange($cidr);
     }
 
+    /**
+     * Normalize ip address
+     *
+     * @param string $ip
+     * @return string|null
+     */
     public static function normalize(string $ip): ?string
     {
         $ip = trim($ip);
@@ -168,32 +197,52 @@ public static function normalize(string $ip): ?string
         return self::normalizeIp4($ip);
     }
 
+    /**
+     * Filter ip6 address
+     *
+     * @param string $ip
+     * @return string|null
+     */
     public static function filterIp6(string $ip): ?string
     {
         $ip = trim($ip);
         if ($ip === '' || !str_contains($ip, ':')) {
             return null;
         }
         $bin = inet_pton($ip);
-        return $bin !== false ? inet_ntop($bin) : null;
+        return $bin !== false ? (inet_ntop($bin)?:null) : null;
     }
 
+    /**
+     * Filter ip4 address
+     *
+     * @param string $ip
+     * @return string|null
+     */
     public static function filterIp4(string $ip): ?string
     {
         $ip = trim($ip);
         if ($ip === '' || !str_contains($ip, '.')) {
             return null;
         }
         $bin = ip2long($ip);
-        return $bin !== false ? long2ip($bin) : null;
+        return $bin !== false ? (long2ip($bin)?:null) : null;
     }
 
+    /**
+     * Filter ip address
+     *
+     * @param string $ip
+     * @return string|null
+     */
     public static function filter(string $ip): ?string
     {
         return self::filterIp6($ip)??self::filterIp4($ip);
     }
 
     /**
+     * Check if ip is in range
+     *
      * @param string $ip
      * @param string $startIP
      * @param string $endIP
@@ -208,6 +257,8 @@ public static function inRange(string $ip, string $startIP, string $endIP): bool
     }
 
     /**
+     * Check if ip is in range cidr
+     *
      * @param string $ip
      * @param string $cidr
      * @return bool
@@ -218,7 +269,6 @@ public static function inRangeCidr(string $ip, string $cidr): bool
         if (!$cidr) {
             return false;
         }
-
         return self::inRange($ip, $cidr[0], $cidr[1]);
     }
 }