docs: update/add PHPDoc types

Author: kenjis

system/BaseModel.php

@@ -98,7 +98,7 @@ abstract class BaseModel
      * An array of field names that are allowed
      * to be set by the user in inserts/updates.
      *
-     * @var array
+     * @var list<string>
      */
     protected $allowedFields = [];
 
@@ -177,15 +177,15 @@ abstract class BaseModel
      * The array must match the format of data passed to the Validation
      * library.
      *
-     * @var array|string
+     * @var list<string>|string
      */
     protected $validationRules = [];
 
     /**
      * Contains any custom error messages to be
      * used during data validation.
      *
-     * @var array
+     * @var array<string, array<string, string>>
      */
     protected $validationMessages = [];
 

system/Config/Routing.php

@@ -22,6 +22,8 @@ class Routing extends BaseConfig
      * found taking precedence.
      *
      * Default: APPPATH . 'Config/Routes.php'
+     *
+     * @var list<string>
      */
     public array $routeFiles = [
         APPPATH . 'Config/Routes.php',
@@ -104,7 +106,7 @@ class Routing extends BaseConfig
      *       'blog' => 'Acme\Blog\Controllers',
      *   ]
      *
-     * @var array [ uri_segment => namespace ]
+     * @var array<string, string> [ uri_segment => namespace ]
      */
     public array $moduleRoutes = [];
 }

system/Controller.php

@@ -11,7 +11,9 @@
 
 namespace CodeIgniter;
 
+use CodeIgniter\HTTP\CLIRequest;
 use CodeIgniter\HTTP\Exceptions\HTTPException;
+use CodeIgniter\HTTP\IncomingRequest;
 use CodeIgniter\HTTP\RequestInterface;
 use CodeIgniter\HTTP\ResponseInterface;
 use CodeIgniter\Validation\Exceptions\ValidationException;
@@ -30,14 +32,14 @@ class Controller
     /**
      * Helpers that will be automatically loaded on class instantiation.
      *
-     * @var array
+     * @var list<string>
      */
     protected $helpers = [];
 
     /**
      * Instance of the main Request object.
      *
-     * @var RequestInterface
+     * @var CLIRequest|IncomingRequest
      */
     protected $request;
 

system/Database/Seeder.php

@@ -181,7 +181,7 @@ public function setSilent(bool $silent)
      * Child classes must implement this method and take care
      * of inserting their data here.
      *
-     * @return mixed
+     * @return void
      *
      * @codeCoverageIgnore
      */

system/HTTP/ContentSecurityPolicy.php

@@ -643,7 +643,7 @@ public function upgradeInsecureRequests(bool $value = true)
     /**
      * DRY method to add an string or array to a class property.
      *
-     * @param array|string $options
+     * @param list<string>|string $options
      *
      * @return void
      */

system/Test/CIUnitTestCase.php

@@ -50,7 +50,7 @@ abstract class CIUnitTestCase extends TestCase
      * WARNING: Do not override unless you know exactly what you are doing.
      *          This property may be deprecated in the future.
      *
-     * @var array of methods
+     * @var list<string> array of methods
      */
     protected $setUpMethods = [
         'resetFactories',
@@ -64,7 +64,7 @@ abstract class CIUnitTestCase extends TestCase
      *
      * WARNING: This property may be deprecated in the future.
      *
-     * @var array of methods
+     * @var list<string> array of methods
      */
     protected $tearDownMethods = [];
 
@@ -109,7 +109,7 @@ abstract class CIUnitTestCase extends TestCase
      * The seed file(s) used for all tests within this test case.
      * Should be fully-namespaced or relative to $basePath
      *
-     * @var array|string
+     * @var class-string<Seeder>|list<class-string<Seeder>>
      */
     protected $seed = '';
 

system/Test/DatabaseTestTrait.php

@@ -48,6 +48,8 @@ trait DatabaseTestTrait
 
     /**
      * Runs the trait set up methods.
+     *
+     * @return void
      */
     protected function setUpDatabase()
     {
@@ -58,6 +60,8 @@ protected function setUpDatabase()
 
     /**
      * Runs the trait set up methods.
+     *
+     * @return void
      */
     protected function tearDownDatabase()
     {
@@ -66,6 +70,8 @@ protected function tearDownDatabase()
 
     /**
      * Load any database test dependencies.
+     *
+     * @return void
      */
     public function loadDependencies()
     {
@@ -95,6 +101,8 @@ public function loadDependencies()
 
     /**
      * Migrate on setUp
+     *
+     * @return void
      */
     protected function setUpMigrate()
     {
@@ -112,6 +120,8 @@ protected function setUpMigrate()
 
     /**
      * Regress migrations as defined by the class
+     *
+     * @return void
      */
     protected function regressDatabase()
     {
@@ -138,6 +148,8 @@ protected function regressDatabase()
 
     /**
      * Run migrations as defined by the class
+     *
+     * @return void
      */
     protected function migrateDatabase()
     {
@@ -169,6 +181,8 @@ protected function migrateDatabase()
 
     /**
      * Seed on setUp
+     *
+     * @return void
      */
     protected function setUpSeed()
     {
@@ -179,6 +193,8 @@ protected function setUpSeed()
 
     /**
      * Run seeds as defined by the class
+     *
+     * @return void
      */
     protected function runSeeds()
     {
@@ -199,6 +215,8 @@ protected function runSeeds()
 
     /**
      * Seeds that database with a specific seeder.
+     *
+     * @return void
      */
     public function seed(string $name)
     {
@@ -213,6 +231,8 @@ public function seed(string $name)
      * Reset $doneMigration and $doneSeed
      *
      * @afterClass
+     *
+     * @return void
      */
     public static function resetMigrationSeedCount()
     {
@@ -222,6 +242,8 @@ public static function resetMigrationSeedCount()
 
     /**
      * Removes any rows inserted via $this->hasInDatabase()
+     *
+     * @return void
      */
     protected function clearInsertCache()
     {
@@ -248,6 +270,8 @@ public function loadBuilder(string $tableName)
      * Fetches a single column from a database row with criteria
      * matching $where.
      *
+     * @param array<string, mixed> $where
+     *
      * @return bool
      *
      * @throws DatabaseException
@@ -272,6 +296,10 @@ public function grabFromDatabase(string $table, string $column, array $where)
      * Asserts that records that match the conditions in $where DO
      * exist in the database.
      *
+     * @param array<string, mixed> $where
+     *
+     * @return void
+     *
      * @throws DatabaseException
      */
     public function seeInDatabase(string $table, array $where)
@@ -283,6 +311,10 @@ public function seeInDatabase(string $table, array $where)
     /**
      * Asserts that records that match the conditions in $where do
      * not exist in the database.
+     *
+     * @param array<string, mixed> $where
+     *
+     * @return void
      */
     public function dontSeeInDatabase(string $table, array $where)
     {
@@ -297,6 +329,8 @@ public function dontSeeInDatabase(string $table, array $where)
      * Inserts a row into to the database. This row will be removed
      * after the test has run.
      *
+     * @param array<string, mixed> $data
+     *
      * @return bool
      */
     public function hasInDatabase(string $table, array $data)
@@ -313,6 +347,10 @@ public function hasInDatabase(string $table, array $data)
      * Asserts that the number of rows in the database that match $where
      * is equal to $expected.
      *
+     * @param array<string, mixed> $where
+     *
+     * @return void
+     *
      * @throws DatabaseException
      */
     public function seeNumRecords(int $expected, string $table, array $where)