Use more precise phpdoc (#6)

Co-authored-by: Markus Staab <m.staab@complex-it.de>
composer · Jan 21, 2022 · 67a32d7 · 67a32d7
1 parent ad25595
commit 67a32d7
Show file tree

Hide file tree

Showing 7 changed files with 25 additions and 25 deletions.
diff --git a/src/MatchAllResult.php b/src/MatchAllResult.php
@@ -23,7 +23,7 @@ final class MatchAllResult
 
     /**
      * @readonly
-     * @var int
+     * @var 0|positive-int
      */
     public $count;
 
@@ -34,7 +34,7 @@ final class MatchAllResult
     public $matched;
 
     /**
-     * @param int $count
+     * @param 0|positive-int $count
      * @param array<array<string|null>> $matches
      */
     public function __construct($count, array $matches)

diff --git a/src/MatchAllWithOffsetsResult.php b/src/MatchAllWithOffsetsResult.php
@@ -24,7 +24,7 @@ final class MatchAllWithOffsetsResult
 
     /**
      * @readonly
-     * @var int
+     * @var 0|positive-int
      */
     public $count;
 
@@ -35,7 +35,7 @@ final class MatchAllWithOffsetsResult
     public $matched;
 
     /**
-     * @param int $count
+     * @param 0|positive-int $count
      * @param array<int|string, list<array{string|null, int}>> $matches
      * @phpstan-param array<int|string, list<array{string|null, int<-1, max>}>> $matches
      */

diff --git a/src/MatchResult.php b/src/MatchResult.php
@@ -28,7 +28,7 @@ final class MatchResult
     public $matched;
 
     /**
-     * @param int $count
+     * @param 0|positive-int $count
      * @param array<string|null> $matches
      */
     public function __construct($count, array $matches)

diff --git a/src/MatchWithOffsetsResult.php b/src/MatchWithOffsetsResult.php
@@ -29,7 +29,7 @@ final class MatchWithOffsetsResult
     public $matched;
 
     /**
-     * @param int $count
+     * @param 0|positive-int $count
      * @param array<array{string|null, int}> $matches
      * @phpstan-param array<int|string, array{string|null, int<-1, max>}> $matches
      */

diff --git a/src/Preg.php b/src/Preg.php
@@ -16,12 +16,12 @@ class Preg
     const ARRAY_MSG = '$subject as an array is not supported. You can use \'foreach\' instead.';
 
     /**
-     * @param string   $pattern
+     * @param non-empty-string   $pattern
      * @param string   $subject
      * @param array<string|null> $matches Set by method
      * @param int      $flags PREG_UNMATCHED_AS_NULL, only available on PHP 7.2+
      * @param int      $offset
-     * @return int
+     * @return 0|1
      */
     public static function match($pattern, $subject, &$matches = null, $flags = 0, $offset = 0)
     {
@@ -40,12 +40,12 @@ public static function match($pattern, $subject, &$matches = null, $flags = 0, $
     /**
      * Runs preg_match with PREG_OFFSET_CAPTURE
      *
-     * @param string   $pattern
+     * @param non-empty-string   $pattern
      * @param string   $subject
      * @param array<int|string, array{string|null, int}> $matches Set by method
      * @param int      $flags PREG_UNMATCHED_AS_NULL, only available on PHP 7.2+
      * @param int      $offset
-     * @return int
+     * @return 0|1
      *
      * @phpstan-param array<int|string, array{string|null, int<-1, max>}> $matches
      */
@@ -60,12 +60,12 @@ public static function matchWithOffsets($pattern, $subject, &$matches, $flags =
     }
 
     /**
-     * @param string   $pattern
+     * @param non-empty-string   $pattern
      * @param string   $subject
      * @param array<int|string, list<string|null>> $matches Set by method
      * @param int      $flags PREG_UNMATCHED_AS_NULL, only available on PHP 7.2+
      * @param int      $offset
-     * @return int
+     * @return 0|positive-int
      */
     public static function matchAll($pattern, $subject, &$matches = null, $flags = 0, $offset = 0)
     {
@@ -88,12 +88,12 @@ public static function matchAll($pattern, $subject, &$matches = null, $flags = 0
     /**
      * Runs preg_match_all with PREG_OFFSET_CAPTURE
      *
-     * @param string   $pattern
+     * @param non-empty-string   $pattern
      * @param string   $subject
      * @param array<int|string, list<array{string|null, int}>> $matches Set by method
      * @param int      $flags PREG_UNMATCHED_AS_NULL, only available on PHP 7.2+
      * @param int      $offset
-     * @return int
+     * @return 0|positive-int
      *
      * @phpstan-param array<int|string, list<array{string|null, int<-1, max>}>> $matches
      */
@@ -242,7 +242,7 @@ public static function grep($pattern, array $array, $flags = 0)
     }
 
     /**
-     * @param string   $pattern
+     * @param non-empty-string   $pattern
      * @param string   $subject
      * @param array<string|null> $matches Set by method
      * @param int      $flags PREG_UNMATCHED_AS_NULL, only available on PHP 7.2+
@@ -255,7 +255,7 @@ public static function isMatch($pattern, $subject, &$matches = null, $flags = 0,
     }
 
     /**
-     * @param string   $pattern
+     * @param non-empty-string   $pattern
      * @param string   $subject
      * @param array<int|string, list<string|null>> $matches Set by method
      * @param int      $flags PREG_UNMATCHED_AS_NULL, only available on PHP 7.2+
@@ -270,7 +270,7 @@ public static function isMatchAll($pattern, $subject, &$matches = null, $flags =
     /**
      * Runs preg_match with PREG_OFFSET_CAPTURE
      *
-     * @param string   $pattern
+     * @param non-empty-string   $pattern
      * @param string   $subject
      * @param array<int|string, array{string|null, int}> $matches Set by method
      * @param int      $flags PREG_UNMATCHED_AS_NULL, only available on PHP 7.2+
@@ -287,7 +287,7 @@ public static function isMatchWithOffsets($pattern, $subject, &$matches, $flags
     /**
      * Runs preg_match_all with PREG_OFFSET_CAPTURE
      *
-     * @param string   $pattern
+     * @param non-empty-string   $pattern
      * @param string   $subject
      * @param array<int|string, list<array{string|null, int}>> $matches Set by method
      * @param int      $flags PREG_UNMATCHED_AS_NULL, only available on PHP 7.2+

diff --git a/src/Regex.php b/src/Regex.php
@@ -14,7 +14,7 @@
 class Regex
 {
     /**
-     * @param string $pattern
+     * @param non-empty-string $pattern
      * @param string $subject
      * @param int    $offset
      * @return bool
@@ -25,7 +25,7 @@ public static function isMatch($pattern, $subject, $offset = 0)
     }
 
     /**
-     * @param string $pattern
+     * @param non-empty-string $pattern
      * @param string $subject
      * @param int    $flags PREG_UNMATCHED_AS_NULL, only available on PHP 7.2+
      * @param int    $offset
@@ -45,7 +45,7 @@ public static function match($pattern, $subject, $flags = 0, $offset = 0)
     /**
      * Runs preg_match with PREG_OFFSET_CAPTURE
      *
-     * @param string $pattern
+     * @param non-empty-string $pattern
      * @param string $subject
      * @param int    $flags PREG_UNMATCHED_AS_NULL, only available on PHP 7.2+
      * @param int    $offset
@@ -59,7 +59,7 @@ public static function matchWithOffsets($pattern, $subject, $flags = 0, $offset
     }
 
     /**
-     * @param string $pattern
+     * @param non-empty-string $pattern
      * @param string $subject
      * @param int    $flags PREG_UNMATCHED_AS_NULL, only available on PHP 7.2+
      * @param int    $offset
@@ -83,7 +83,7 @@ public static function matchAll($pattern, $subject, $flags = 0, $offset = 0)
     /**
      * Runs preg_match_all with PREG_OFFSET_CAPTURE
      *
-     * @param string $pattern
+     * @param non-empty-string $pattern
      * @param string $subject
      * @param int    $flags PREG_UNMATCHED_AS_NULL, only available on PHP 7.2+
      * @param int    $offset

diff --git a/src/ReplaceResult.php b/src/ReplaceResult.php
@@ -21,7 +21,7 @@ final class ReplaceResult
 
     /**
      * @readonly
-     * @var int
+     * @var 0|positive-int
      */
     public $count;
 
@@ -32,7 +32,7 @@ final class ReplaceResult
     public $matched;
 
     /**
-     * @param int $count
+     * @param 0|positive-int $count
      * @param string $result
      */
     public function __construct($count, $result)