FileList: improve doc specificity

jrfnl · jrfnl · commit 1b4652ced74d · 2024-11-08T16:06:57.000+01:00
Make the iterator list type specifications more specific to comply with expectations in PHPStan 2.0.

Note: in reality the type should be `\RegexIterator&lt;int, string, \Traversable&lt;int, string&gt;&gt;`, but would yield yet another PHPStan error, so let's just leave it like this for now.
diff --git a/Scripts/FileList.php b/Scripts/FileList.php
@@ -47,7 +47,7 @@ class FileList
     /**
      * Regex iterator.
      *
-     * @var \RegexIterator
+     * @var \RegexIterator<mixed, mixed, \Traversable<mixed, mixed>>
      */
     protected $fileIterator;
 
@@ -85,7 +85,7 @@ public function __construct($directory, $rootPath = '', $filter = '')
     /**
      * Retrieve the filtered file list iterator.
      *
-     * @return \RegexIterator
+     * @return \RegexIterator<mixed, mixed, \Traversable<mixed, mixed>>
      */
     public function getIterator()
     {

Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ class FileList`
`47`	`47`	`/**`
`48`	`48`	`* Regex iterator.`
`49`	`49`	`*`
`50`		`- * @var \RegexIterator`
	`50`	`+ * @var \RegexIterator<mixed, mixed, \Traversable<mixed, mixed>>`
`51`	`51`	`*/`
`52`	`52`	`protected $fileIterator;`
`53`	`53`
`@@ -85,7 +85,7 @@ public function __construct($directory, $rootPath = '', $filter = '')`
`85`	`85`	`/**`
`86`	`86`	`* Retrieve the filtered file list iterator.`
`87`	`87`	`*`
`88`		`- * @return \RegexIterator`
	`88`	`+ * @return \RegexIterator<mixed, mixed, \Traversable<mixed, mixed>>`
`89`	`89`	`*/`
`90`	`90`	`public function getIterator()`
`91`	`91`	`{`