Fix: False positive for invalid Generator return type

Author: gmazzap

Inpsyde/Sniffs/CodeQuality/ReturnTypeDeclarationSniff.php

@@ -347,10 +347,13 @@ private function checkInvalidGenerator(
     ): bool {
 
         $hasGenerator = false;
+        $hasIterator = false;
         while (!$hasGenerator && $returnTypes) {
             $returnType = explode('&', rtrim(ltrim(array_shift($returnTypes), '('), ')'));
             $hasGenerator = in_array('Generator', $returnType, true)
-                || in_array('\Generator', $returnType, true)
+                || in_array('\Generator', $returnType, true);
+            $hasIterator = $hasIterator
+                || $hasGenerator
                 || in_array('Traversable', $returnType, true)
                 || in_array('\Traversable', $returnType, true)
                 || in_array('Iterator', $returnType, true)
@@ -383,7 +386,7 @@ private function checkInvalidGenerator(
             return true;
         }
 
-        if (!$hasGenerator && ($yieldCount > 0)) {
+        if (!$hasIterator && ($yieldCount > 0)) {
             $file->addError(
                 'Return type does not contain "Generator" but yield found in the function body',
                 $position,

tests/fixtures/return-type-declaration.php

@@ -1,8 +1,22 @@
 <?php
 // @phpcsSniff Inpsyde.CodeQuality.ReturnTypeDeclaration
 
+use Brain\Assets\Enqueue\Enqueue;
 use Psr\Container\ContainerInterface as PsrContainer;
 
+class FooIterator implements IteratorAggregate
+{
+    private array $collection = [];
+
+    /**
+     * @return Iterator<int, Foo>
+     */
+    public function getIterator(): \Iterator
+    {
+        return new ArrayIterator($this->collection);
+    }
+}
+
 function returnMixed(): mixed
 {
     return null;