Merge pull request #8244 from kenjis/fix-phpdoc-types-for-psalm

docs: fix incorrect PHPDoc types
codeigniter4 · Nov 25, 2023 · e346a6f · e346a6f
2 parents 1d6b7ac + 49ac664
commit e346a6f
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 7 deletions.
diff --git a/system/Database/BaseResult.php b/system/Database/BaseResult.php
@@ -254,14 +254,16 @@ public function getResultObject(): array
      *
      * If row doesn't exist, returns null.
      *
-     * @param int    $n    The index of the results to return
-     * @param string $type The type of result object. 'array', 'object' or class name.
+     * @param int|string $n    The index of the results to return, or column name.
+     * @param string     $type The type of result object. 'array', 'object' or class name.
+     * @phpstan-param class-string|'array'|'object' $type
      *
      * @return array|object|stdClass|null
      * @phpstan-return ($type is 'object' ? stdClass|null : ($type is 'array' ? array|null : object|null))
      */
     public function getRow($n = 0, string $type = 'object')
     {
+        // $n is a column name.
         if (! is_numeric($n)) {
             // We cache the row data for subsequent uses
             if (! is_array($this->rowData)) {

diff --git a/system/Database/ResultInterface.php b/system/Database/ResultInterface.php
@@ -57,8 +57,9 @@ public function getResultObject(): array;
      *
      * If row doesn't exist, returns null.
      *
-     * @param int    $n    The index of the results to return
-     * @param string $type The type of result object. 'array', 'object' or class name.
+     * @param int|string $n    The index of the results to return, or column name.
+     * @param string     $type The type of result object. 'array', 'object' or class name.
+     * @phpstan-param class-string|'array'|'object' $type
      *
      * @return array|object|stdClass|null
      * @phpstan-return ($type is 'object' ? stdClass|null : ($type is 'array' ? array|null : object|null))

diff --git a/system/Email/Email.php b/system/Email/Email.php
@@ -731,7 +731,7 @@ public function setHeader($header, $value)
     }
 
     /**
-     * @param string $email
+     * @param array|string $email
      *
      * @return array
      */

diff --git a/system/HTTP/Files/FileCollection.php b/system/HTTP/Files/FileCollection.php
@@ -77,7 +77,7 @@ public function getFile(string $name)
     /**
      * Verify if a file exist in the collection of uploaded files and is have been uploaded with multiple option.
      *
-     * @return array|null
+     * @return list<UploadedFile>|null
      */
     public function getFileMultiple(string $name)
     {
@@ -245,7 +245,7 @@ protected function fixFilesArray(array $data): array
      * @param array $index The index sequence we are navigating down
      * @param array $value The portion of the array to process
      *
-     * @return UploadedFile|null
+     * @return list<UploadedFile>|UploadedFile|null
      */
     protected function getValueDotNotationSyntax(array $index, array $value)
     {