Add function param/return types, fix a lot more phpstorm complaints

1 files changed, 18 insertions, 16 deletions

diff --git a/inc/iputil.inc.php b/inc/iputil.inc.php
index 69311d7f..ecd8c198 100644
--- a/inc/iputil.inc.php
+++ b/inc/iputil.inc.php
@@ -3,38 +3,39 @@
 class IpUtil
 {
 
-	public static function rangeToCidr($start, $end)
+	public static function rangeToCidr(int $start, int $end): string
 	{
-		$value = (int)$start ^ (int)$end;
+		$value = $start ^ $end;
 		if (!self::isAllOnes($value))
 			return 'NOT SUBNET: ' . long2ip($start) . '-' . long2ip($end);
-		$ones = self::countOnes($value);
+		$ones = self::bitLength($value);
 		return long2ip($start) . '/' . (32 - $ones);
 	}
 
-	public static function isValidSubnetRange($start, $end)
+	public static function isValidSubnetRange(int $start, int $end): bool
 	{
-		return self::isAllOnes((int)$start ^ (int)$end);
+		return self::isAllOnes($start ^ $end);
 	}
 
 	/**
-	 * Return number of one bits required to represent
-	 * this number. Assumes given number is 2^n - 1.
+	 * Return number of bits required to represent
+	 * this number.
+	 * !! Assumes given number is 2^n - 1 !!
 	 */
-	private static function countOnes($value)
+	private static function bitLength(int $value): int
 	{
 		// This is log(value) / log(2)
 		// It should actually be $value + 1, but floating point errors
 		// start to happen either way at higher values, so with
 		// the round() thrown in, it doesn't matter...
-		return round(log($value) / 0.69314718055995);
+		return (int)round(log($value) / 0.69314718055995);
 	}
 
 	/**
 	 * Is the given number just ones if converted to
 	 * binary (ignoring leading zeros)?
 	 */
-	private static function isAllOnes($value)
+	private static function isAllOnes(int $value): bool
 	{
 		return ($value & ($value + 1)) === 0;
 	}
@@ -44,16 +45,17 @@ class IpUtil
 	 * ['start' => (int), 'end' => (int)] representing
 	 * the according start and end addresses as integer
 	 * values. Returns false on malformed input.
+	 *
 	 * @param string $cidr 192.168.101/24, 1.2.3.4/16, ...
-	 * @return array|false start and end address, false on error
+	 * @return array{start: int, end: int}|null start and end address, false on error
 	 */
-	public static function parseCidr($cidr)
+	public static function parseCidr(string $cidr): ?array
 	{
 		$parts = explode('/', $cidr);
 		if (count($parts) !== 2) {
 			$ip = ip2long($cidr);
 			if ($ip === false)
-				return false;
+				return null;
 			if (PHP_INT_SIZE === 4) {
 				$ip = sprintf('%u', $ip);
 			}
@@ -62,15 +64,15 @@ class IpUtil
 		$ip = $parts[0];
 		$bits = $parts[1];
 		if (!is_numeric($bits) || $bits < 0 || $bits > 32)
-			return false;
+			return null;
 		$dots = substr_count($ip, '.');
 		if ($dots < 3) {
 			$ip .= str_repeat('.0', 3 - $dots);
 		}
 		$ip = ip2long($ip);
 		if ($ip === false)
-			return false;
-		$bits = pow(2, 32 - $bits) - 1;
+			return null;
+		$bits = (int)((2 ** (32 - $bits)) - 1);
 		if (PHP_INT_SIZE === 4)
 			return ['start' => sprintf('%u', $ip & ~$bits), 'end' => sprintf('%u', $ip | $bits)];
 		return ['start' => $ip & ~$bits, 'end' => $ip | $bits];