Improve PHP docblocks

thephpleague · Jan 16, 2024 · 88466fd · 88466fd
1 parent a6f2bda
commit 88466fd
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/src/Reader.php b/src/Reader.php
@@ -410,12 +410,15 @@ protected function prepareHeader($header = []): array
     }
 
     /**
-     * @param class-string $className
+     * @template T of object
+     * @param class-string<T> $className
      * @param array<string> $header
      *
      * @throws Exception
      * @throws MappingFailed
      * @throws TypeCastingFailed
+     *
+     * @return iterator<T>
      */
     public function getRecordsAsObject(string $className, array $header = []): Iterator
     {

diff --git a/src/ResultSet.php b/src/ResultSet.php
@@ -215,12 +215,14 @@ public function getRecords(array $header = []): Iterator
     }
 
     /**
-     * @param class-string $className
+     * @template T of object
+     * @param class-string<T> $className
      * @param array<string> $header
      *
      * @throws Exception
      * @throws MappingFailed
      * @throws TypeCastingFailed
+     * @return iterator<T>
      */
     public function getRecordsAsObject(string $className, array $header = []): Iterator
     {