Add InfiniteIterator stub

phpstan · Jun 23, 2022 · 895e90e · 895e90e
1 parent ce7772d
commit 895e90e
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 0 deletions.
diff --git a/conf/config.neon b/conf/config.neon
@@ -28,6 +28,7 @@ parameters:
 			- AppendIterator
 			- NoRewindIterator
 			- LimitIterator
+			- InfiniteIterator
 		explicitMixedInUnknownGenericNew: false
 		explicitMixedForGlobalVariables: false
 		explicitMixedViaIsArray: false

diff --git a/stubs/iterable.stub b/stubs/iterable.stub
@@ -345,3 +345,27 @@ class LimitIterator extends IteratorIterator implements OuterIterator {
      */
     public function key() {}
 }
+
+/**
+ * @template-covariant TKey
+ * @template-covariant TValue
+ * @template TIterator as Iterator<TKey, TValue>
+ *
+ * @template-extends IteratorIterator<TKey, TValue, TIterator>
+ */
+class InfiniteIterator extends IteratorIterator {
+    /**
+     * @param TIterator $iterator
+     */
+    public function __construct(Iterator $iterator) {}
+
+    /**
+     * @return TValue
+     */
+    public function current() {}
+
+    /**
+     * @return TKey
+     */
+    public function key() {}
+}