PHP 8.1 fixes

Author: Zenexer

composer.json

@@ -21,6 +21,9 @@
         "php-coveralls/php-coveralls": "*",
         "squizlabs/php_codesniffer": "3.*"
     },
+    "suggest": {
+        "ext-gmp": "Required for optimized binomial calculations (also requires PHP >= 7.3)"
+    },
     "autoload": {
         "psr-4": { "ZxcvbnPhp\\": "src/" }
     },

src/Feedback.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace ZxcvbnPhp;
 
 use ZxcvbnPhp\Matchers\MatchInterface;

src/Matcher.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace ZxcvbnPhp;
 
 use ZxcvbnPhp\Matchers\BaseMatch;

src/Matchers/BaseMatch.php

@@ -1,7 +1,10 @@
 <?php
 
+declare(strict_types=1);
+
 namespace ZxcvbnPhp\Matchers;
 
+use JetBrains\PhpStorm\ArrayShape;
 use ZxcvbnPhp\Scorer;
 
 abstract class BaseMatch implements MatchInterface
@@ -45,13 +48,14 @@ public function __construct(string $password, int $begin, int $end, string $toke
      *
      * @param  bool $isSoleMatch
      *   Whether this is the only match in the password
-     * @return array{warning: string, suggestions: array}
+     * @return array
      *   Associative array with warning (string) and suggestions (array of strings)
      */
+    #[ArrayShape(['warning' => 'string', 'suggestions' => 'string[]'])]
     abstract public function getFeedback(bool $isSoleMatch): array;
 
     /**
-     * Find all occurences of regular expression in a string.
+     * Find all occurrences of regular expression in a string.
      *
      * @param string $string
      *   String to search.
@@ -114,28 +118,48 @@ public static function findAll(string $string, string $regex, int $offset = 0):
     /**
      * Calculate binomial coefficient (n choose k).
      *
-     * http://www.php.net/manual/en/ref.math.php#57895
-     *
-     * @param $n
-     * @param $k
+     * @param int $n
+     * @param int $k
      * @return int
      */
     public static function binom(int $n, int $k): int
     {
-        $j = $res = 1;
+        if (function_exists('gmp_binomial')) {
+            return gmp_intval(gmp_binomial($n, $k));
+        }
 
-        if ($k < 0 || $k > $n) {
-            return 0;
+        return self::binomPolyfill($n, $k);
+    }
+
+    /**
+     * Substitute for gmp_polynomial for non-negative values of n and k.
+     * @param int $n
+     * @param int $k
+     * @return int
+     */
+    public static function binomPolyfill(int $n, int $k): int
+    {
+        if ($k < 0 || $n < 0) {
+            throw new \DomainException("n and k must be non-negative");
         }
-        if (($n - $k) < $k) {
-            $k = $n - $k;
+
+        if ($k > $n) {
+            return 0;
         }
-        while ($j <= $k) {
-            $res *= $n--;
-            $res /= $j++;
+
+        // $k and $n - $k will always produce the same value, so use smaller of the two
+        $k = min($k, $n - $k);
+
+        $c = 1;
+
+        for ($i = 1; $i <= $k; $i++, $n--) {
+            // We're aiming for $c * $n / $i, but the $c * $n part could overflow, so use $c / $i * $n instead. The caveat here is that in
+            // order to get a precise answer, we need to avoid floats, which means we need to deal with whole part and the remainder
+            // separately.
+            $c = intdiv($c, $i) * $n + intdiv($c % $i * $n, $i);
         }
 
-        return $res;
+        return $c;
     }
 
     abstract protected function getRawGuesses(): float;

src/Matchers/Bruteforce.php

@@ -1,7 +1,10 @@
 <?php
 
+declare(strict_types=1);
+
 namespace ZxcvbnPhp\Matchers;
 
+use JetBrains\PhpStorm\ArrayShape;
 use ZxcvbnPhp\Scorer;
 
 /**
@@ -30,6 +33,7 @@ public static function match(string $password, array $userInputs = []): array
     }
 
 
+    #[ArrayShape(['warning' => 'string', 'suggestions' => 'string[]'])]
     public function getFeedback(bool $isSoleMatch): array
     {
         return [

src/Matchers/DateMatch.php

@@ -1,7 +1,10 @@
 <?php
 
+declare(strict_types=1);
+
 namespace ZxcvbnPhp\Matchers;
 
+use JetBrains\PhpStorm\ArrayShape;
 use ZxcvbnPhp\Matcher;
 
 class DateMatch extends BaseMatch
@@ -105,6 +108,7 @@ public static function match(string $password, array $userInputs = []): array
         return $matches;
     }
 
+    #[ArrayShape(['warning' => 'string', 'suggestions' => 'string[]'])]
     public function getFeedback(bool $isSoleMatch): array
     {
         return [
@@ -202,9 +206,9 @@ protected static function datesWithoutSeparators(string $password): array
 
                 $possibleSplits = static::$DATE_SPLITS[mb_strlen($token)];
                 foreach ($possibleSplits as $splitPositions) {
-                    $day = mb_substr($token, 0, $splitPositions[0]);
-                    $month = mb_substr($token, $splitPositions[0], $splitPositions[1] - $splitPositions[0]);
-                    $year = mb_substr($token, $splitPositions[1]);
+                    $day = (int)mb_substr($token, 0, $splitPositions[0]);
+                    $month = (int)mb_substr($token, $splitPositions[0], $splitPositions[1] - $splitPositions[0]);
+                    $year = (int)mb_substr($token, $splitPositions[1]);
 
                     $date = static::checkDate([$day, $month, $year]);
                     if ($date !== false) {
@@ -285,21 +289,21 @@ protected static function checkDate(array $ints)
             return false;
         }
 
-        $invalidYear = count(array_filter($ints, function (int $int) {
+        $invalidYear = count(array_filter($ints, function (int $int): bool {
             return ($int >= 100 && $int < static::MIN_YEAR)
                 || ($int > static::MAX_YEAR);
         }));
         if ($invalidYear > 0) {
             return false;
         }
 
-        $over12 = count(array_filter($ints, function (int $int) {
+        $over12 = count(array_filter($ints, function (int $int): bool {
             return $int > 12;
         }));
-        $over31 = count(array_filter($ints, function (int $int) {
+        $over31 = count(array_filter($ints, function (int $int): bool {
             return $int > 31;
         }));
-        $under1 = count(array_filter($ints, function (int $int) {
+        $under1 = count(array_filter($ints, function (int $int): bool {
             return $int <= 0;
         }));
 
@@ -313,7 +317,7 @@ protected static function checkDate(array $ints)
             [$ints[0], [$ints[1], $ints[2]]], // year first
         ];
 
-        foreach ($possibleYearSplits as list($year, $rest)) {
+        foreach ($possibleYearSplits as [$year, $rest]) {
             if ($year >= static::MIN_YEAR && $year <= static::MAX_YEAR) {
                 if ($dm = static::mapIntsToDayMonth($rest)) {
                     return [
@@ -329,7 +333,7 @@ protected static function checkDate(array $ints)
             }
         }
 
-        foreach ($possibleYearSplits as list($year, $rest)) {
+        foreach ($possibleYearSplits as [$year, $rest]) {
             if ($dm = static::mapIntsToDayMonth($rest)) {
                 return [
                     'year'  => static::twoToFourDigitYear($year),
@@ -349,7 +353,7 @@ protected static function checkDate(array $ints)
      */
     protected static function mapIntsToDayMonth(array $ints)
     {
-        foreach ([$ints, array_reverse($ints)] as list($d, $m)) {
+        foreach ([$ints, array_reverse($ints)] as [$d, $m]) {
             if ($d >= 1 && $d <= 31 && $m >= 1 && $m <= 12) {
                 return [
                     'day'   => $d,

src/Matchers/DictionaryMatch.php

@@ -1,7 +1,10 @@
 <?php
 
+declare(strict_types=1);
+
 namespace ZxcvbnPhp\Matchers;
 
+use JetBrains\PhpStorm\ArrayShape;
 use ZxcvbnPhp\Matcher;
 
 class DictionaryMatch extends BaseMatch
@@ -33,7 +36,7 @@ class DictionaryMatch extends BaseMatch
     protected const ALL_LOWER = "/^[^A-Z]+$/u";
 
     /**
-     * Match occurences of dictionary words in password.
+     * Match occurrences of dictionary words in password.
      *
      * @param string $password
      * @param array $userInputs
@@ -84,6 +87,11 @@ public function __construct(string $password, int $begin, int $end, string $toke
         }
     }
 
+    /**
+     * @param bool $isSoleMatch
+     * @return array
+     */
+    #[ArrayShape(['warning' => 'string', 'suggestions' => 'string[]'])]
     public function getFeedback(bool $isSoleMatch): array
     {
         $startUpper = '/^[A-Z][^A-Z]+$/u';

src/Matchers/L33tMatch.php

@@ -1,7 +1,10 @@
 <?php
 
+declare(strict_types=1);
+
 namespace ZxcvbnPhp\Matchers;
 
+use JetBrains\PhpStorm\ArrayShape;
 use ZxcvbnPhp\Matcher;
 
 /**
@@ -95,6 +98,7 @@ public function __construct(string $password, int $begin, int $end, string $toke
         }
     }
 
+    #[ArrayShape(['warning' => 'string', 'suggestions' => 'string[]'])]
     public function getFeedback(bool $isSoleMatch): array
     {
         $feedback = parent::getFeedback($isSoleMatch);

src/Matchers/MatchInterface.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace ZxcvbnPhp\Matchers;
 
 interface MatchInterface

src/Matchers/RepeatMatch.php

@@ -1,7 +1,10 @@
 <?php
 
+declare(strict_types=1);
+
 namespace ZxcvbnPhp\Matchers;
 
+use JetBrains\PhpStorm\ArrayShape;
 use ZxcvbnPhp\Matcher;
 use ZxcvbnPhp\Scorer;
 
@@ -28,7 +31,7 @@ class RepeatMatch extends BaseMatch
     /**
      * Match 3 or more repeated characters.
      *
-     * @param $password
+     * @param string $password
      * @param array $userInputs
      * @return RepeatMatch[]
      */
@@ -82,6 +85,7 @@ public static function match(string $password, array $userInputs = []): array
         return $matches;
     }
 
+    #[ArrayShape(['warning' => 'string', 'suggestions' => 'string[]'])]
     public function getFeedback(bool $isSoleMatch): array
     {
         $warning = mb_strlen($this->repeatedChar) == 1