Use Psalm annotation for ResultInterface::getIterator

Adds Psalm's prefix for the return annotation to avoid lint errors. Signed-off-by: Maurício Meneghini Fauth <mauricio@fauth.dev>
phpmyadmin · Sep 20, 2022 · d0b71b7 · d0b71b7
1 parent cccbf28
commit d0b71b7
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/libraries/classes/Dbal/MysqliResult.php b/libraries/classes/Dbal/MysqliResult.php
@@ -44,7 +44,7 @@ public function __construct($result)
      * Returns a generator that traverses through the whole result set
      * and returns each row as an associative array
      *
-     * @return Generator<int, array<string, string|null>, mixed, void>
+     * @psalm-return Generator<int, array<string, string|null>, mixed, void>
      */
     public function getIterator(): Generator
     {

diff --git a/libraries/classes/Dbal/ResultInterface.php b/libraries/classes/Dbal/ResultInterface.php
@@ -22,7 +22,7 @@ interface ResultInterface extends IteratorAggregate
      * Returns a generator that traverses through the whole result set
      * and returns each row as an associative array
      *
-     * @return Generator<int, array<string, string|null>, mixed, void>
+     * @psalm-return Generator<int, array<string, string|null>, mixed, void>
      */
     public function getIterator(): Generator;
 

diff --git a/test/classes/Stubs/DummyResult.php b/test/classes/Stubs/DummyResult.php
@@ -46,7 +46,7 @@ public function __construct(DbiDummy $link, $result)
      * Returns a generator that traverses through the whole result set
      * and returns each row as an associative array
      *
-     * @return Generator<int, array<string, string|null>, mixed, void>
+     * @psalm-return Generator<int, array<string, string|null>, mixed, void>
      */
     public function getIterator(): Generator
     {