refactor: Improve types for phpstan (#9685)

* refactor: Improve types for phpstan

* fix: Update phpstan baseline

* fix: Remove phpDoc duplicate from parent

Author: neznaika0

system/Common.php

@@ -1226,7 +1226,7 @@ function view_cell(string $library, $params = null, int $ttl = 0, ?string $cache
     /**
      * Get the class "basename" of the given object / class.
      *
-     * @param object|string $class
+     * @param class-string|object $class
      *
      * @return string
      *
@@ -1244,9 +1244,9 @@ function class_basename($class)
     /**
      * Returns all traits used by a class, its parent classes and trait of their traits.
      *
-     * @param object|string $class
+     * @param class-string|object $class
      *
-     * @return array
+     * @return array<class-string, class-string>
      *
      * @codeCoverageIgnore
      */
@@ -1270,9 +1270,9 @@ function class_uses_recursive($class)
     /**
      * Returns all traits used by a trait and its traits.
      *
-     * @param string $trait
+     * @param class-string $trait
      *
-     * @return array
+     * @return array<class-string, class-string>
      *
      * @codeCoverageIgnore
      */

system/Test/CIUnitTestCase.php

@@ -19,6 +19,7 @@
 use CodeIgniter\Database\MigrationRunner;
 use CodeIgniter\Database\Seeder;
 use CodeIgniter\Events\Events;
+use CodeIgniter\HTTP\Header;
 use CodeIgniter\Router\RouteCollection;
 use CodeIgniter\Session\Handlers\ArrayHandler;
 use CodeIgniter\Test\Mock\MockCache;
@@ -72,6 +73,8 @@ abstract class CIUnitTestCase extends TestCase
 
     /**
      * Store of identified traits.
+     *
+     * @var array<class-string, class-string>|null
      */
     private ?array $traits = null;
 
@@ -109,9 +112,9 @@ 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
+     * Should be fully-namespaced or relative to $basePath.
      *
-     * @var class-string<Seeder>|list<class-string<Seeder>>
+     * @var ''|class-string<Seeder>|list<class-string<Seeder>>
      */
     protected $seed = '';
 
@@ -127,9 +130,9 @@ abstract class CIUnitTestCase extends TestCase
      * The namespace(s) to help us find the migration classes.
      * `null` is equivalent to running `spark migrate --all`.
      * Note that running "all" runs migrations in date order,
-     * but specifying namespaces runs them in namespace order (then date)
+     * but specifying namespaces runs them in namespace order (then date).
      *
-     * @var array|string|null
+     * @var list<string>|string|null
      */
     protected $namespace = 'Tests\Support';
 
@@ -156,17 +159,17 @@ abstract class CIUnitTestCase extends TestCase
     protected $migrations;
 
     /**
-     * Seeder instance
+     * Seeder instance.
      *
-     * @var Seeder
+     * @var Seeder|null
      */
     protected $seeder;
 
     /**
      * Stores information needed to remove any
-     * rows inserted via $this->hasInDatabase();
+     * rows inserted via $this->hasInDatabase().
      *
-     * @var array
+     * @var list<array<int|string, mixed>>
      */
     protected $insertCache = [];
 
@@ -186,27 +189,27 @@ abstract class CIUnitTestCase extends TestCase
      * Values to be set in the SESSION global
      * before running the test.
      *
-     * @var array
+     * @var array<int|string, mixed>
      */
     protected $session = [];
 
     /**
-     * Enabled auto clean op buffer after request call
+     * Enabled auto clean op buffer after request call.
      *
      * @var bool
      */
     protected $clean = true;
 
     /**
-     * Custom request's headers
+     * Custom request's headers.
      *
-     * @var array
+     * @var array<string, Header|list<Header>>
      */
     protected $headers = [];
 
     /**
      * Allows for formatting the request body to what
-     * the controller is going to expect
+     * the controller is going to expect.
      *
      * @var string
      */
@@ -276,7 +279,7 @@ protected function tearDown(): void
      * Checks for traits with corresponding
      * methods for setUp or tearDown.
      *
-     * @param string $stage 'setUp' or 'tearDown'
+     * @param 'setUp'|'tearDown' $stage
      */
     private function callTraitMethods(string $stage): void
     {
@@ -298,7 +301,7 @@ private function callTraitMethods(string $stage): void
     // --------------------------------------------------------------------
 
     /**
-     * Resets shared instanced for all Factories components
+     * Resets shared instanced for all Factories components.
      *
      * @return void
      */
@@ -308,7 +311,7 @@ protected function resetFactories()
     }
 
     /**
-     * Resets shared instanced for all Services
+     * Resets shared instanced for all Services.
      *
      * @return void
      */
@@ -318,7 +321,7 @@ protected function resetServices(bool $initAutoloader = true)
     }
 
     /**
-     * Injects the mock Cache driver to prevent filesystem collisions
+     * Injects the mock Cache driver to prevent filesystem collisions.
      *
      * @return void
      */
@@ -328,7 +331,7 @@ protected function mockCache()
     }
 
     /**
-     * Injects the mock email driver so no emails really send
+     * Injects the mock email driver so no emails really send.
      *
      * @return void
      */
@@ -338,7 +341,7 @@ protected function mockEmail()
     }
 
     /**
-     * Injects the mock session driver into Services
+     * Injects the mock session driver into Services.
      *
      * @return void
      */

system/Test/DatabaseTestTrait.php

@@ -14,11 +14,13 @@
 namespace CodeIgniter\Test;
 
 use CodeIgniter\Database\BaseBuilder;
+use CodeIgniter\Database\BaseConnection;
 use CodeIgniter\Database\Exceptions\DatabaseException;
+use CodeIgniter\Database\MigrationRunner;
+use CodeIgniter\Database\Seeder;
 use CodeIgniter\Test\Constraints\SeeInDatabase;
 use Config\Database;
 use Config\Migrations;
-use Config\Services;
 use PHPUnit\Framework\Attributes\AfterClass;
 
 /**
@@ -27,6 +29,12 @@
  * Provides functionality for refreshing/seeding
  * the database during testing.
  *
+ * @property BaseConnection                 $db
+ * @property list<array<int|string, mixed>> $insertCache
+ * @property Seeder|null                    $seeder
+ * @property MigrationRunner|null           $migrations
+ * @property list<string>|string|null       $namespace
+ *
  * @mixin CIUnitTestCase
  */
 trait DatabaseTestTrait
@@ -88,7 +96,7 @@ public function loadDependencies()
             $config          = new Migrations();
             $config->enabled = true;
 
-            $this->migrations = Services::migrations($config, $this->db, false);
+            $this->migrations = service('migrations', $config, $this->db, false);
             $this->migrations->setSilent(false);
         }
 

system/Test/FeatureTestTrait.php

@@ -13,13 +13,17 @@
 
 namespace CodeIgniter\Test;
 
+use Closure;
 use CodeIgniter\Events\Events;
 use CodeIgniter\HTTP\Exceptions\RedirectException;
+use CodeIgniter\HTTP\Header;
 use CodeIgniter\HTTP\IncomingRequest;
 use CodeIgniter\HTTP\Method;
 use CodeIgniter\HTTP\Request;
+use CodeIgniter\HTTP\ResponseInterface;
 use CodeIgniter\HTTP\SiteURI;
 use CodeIgniter\HTTP\URI;
+use CodeIgniter\Router\RouteCollection;
 use Config\App;
 use Config\Services;
 use Exception;
@@ -30,6 +34,12 @@
  *
  * Provides additional utilities for doing full HTTP testing
  * against your application in trait format.
+ *
+ * @property array<int|string, mixed>           $session
+ * @property array<string, Header|list<Header>> $headers
+ * @property RouteCollection|null               $routes
+ *
+ * @mixin CIUnitTestCase
  */
 trait FeatureTestTrait
 {
@@ -42,7 +52,12 @@ trait FeatureTestTrait
      *    ['GET', 'home', 'Home::index'],
      * ]
      *
-     * @param array|null $routes Array to set routes
+     * @param array<int, array{
+     *      0: string,
+     *      1: string,
+     *      2: ((Closure(mixed...): (ResponseInterface|string|void)))|string,
+     *      3?: array<string, mixed>
+     *  }>|null $routes Array to set routes
      *
      * @return $this
      */
@@ -84,7 +99,7 @@ protected function withRoutes(?array $routes = null)
     /**
      * Sets any values that should exist during this session.
      *
-     * @param array|null $values Array of values, or null to use the current $_SESSION
+     * @param array<int|string, mixed>|null $values Array of values, or null to use the current $_SESSION
      *
      * @return $this
      */
@@ -103,7 +118,7 @@ public function withSession(?array $values = null)
      *  'Authorization' => 'Token'
      * ])
      *
-     * @param array $headers Array of headers
+     * @param array<string, Header|list<Header>> $headers Array of headers
      *
      * @return $this
      */

tests/system/Database/DatabaseTestCase/DatabaseTestCaseMigrationOnce1Test.php

@@ -29,29 +29,9 @@ final class DatabaseTestCaseMigrationOnce1Test extends CIUnitTestCase
 {
     use DatabaseTestTrait;
 
-    /**
-     * Should run db migration only once?
-     *
-     * @var bool
-     */
     protected $migrateOnce = true;
-
-    /**
-     * Should the db be refreshed before test?
-     *
-     * @var bool
-     */
-    protected $refresh = true;
-
-    /**
-     * The namespace(s) to help us find the migration classes.
-     * Empty is equivalent to running `spark migrate -all`.
-     * Note that running "all" runs migrations in date order,
-     * but specifying namespaces runs them in namespace order (then date)
-     *
-     * @var array|string|null
-     */
-    protected $namespace = [
+    protected $refresh     = true;
+    protected $namespace   = [
         'Tests\Support\MigrationTestMigrations',
     ];
 

tests/system/Database/DatabaseTestCase/DatabaseTestCaseMigrationOnce2Test.php

@@ -29,29 +29,9 @@ final class DatabaseTestCaseMigrationOnce2Test extends CIUnitTestCase
 {
     use DatabaseTestTrait;
 
-    /**
-     * Should run db migration only once?
-     *
-     * @var bool
-     */
     protected $migrateOnce = true;
-
-    /**
-     * Should the db be refreshed before test?
-     *
-     * @var bool
-     */
-    protected $refresh = true;
-
-    /**
-     * The namespace(s) to help us find the migration classes.
-     * Empty is equivalent to running `spark migrate -all`.
-     * Note that running "all" runs migrations in date order,
-     * but specifying namespaces runs them in namespace order (then date)
-     *
-     * @var array|string|null
-     */
-    protected $namespace = [
+    protected $refresh     = true;
+    protected $namespace   = [
         'Tests\Support\MigrationTestMigrations',
     ];
 

tests/system/Database/DatabaseTestCaseTest.php

@@ -28,33 +28,11 @@ final class DatabaseTestCaseTest extends CIUnitTestCase
 {
     use DatabaseTestTrait;
 
-    /**
-     * Should the db be refreshed before
-     * each test?
-     *
-     * @var bool
-     */
     protected $refresh = true;
-
-    /**
-     * The seed file(s) used for all tests within this test case.
-     * Should be fully-namespaced or relative to $basePath
-     *
-     * @var array|string
-     */
-    protected $seed = [
+    protected $seed    = [
         CITestSeeder::class,
         AnotherSeeder::class,
     ];
-
-    /**
-     * The namespace(s) to help us find the migration classes.
-     * Empty is equivalent to running `spark migrate -all`.
-     * Note that running "all" runs migrations in date order,
-     * but specifying namespaces runs them in namespace order (then date)
-     *
-     * @var array|string|null
-     */
     protected $namespace = [
         'Tests\Support',
         'Tests\Support\MigrationTestMigrations',

tests/system/Database/Live/MetadataTest.php

@@ -27,13 +27,7 @@ final class MetadataTest extends CIUnitTestCase
 {
     use DatabaseTestTrait;
 
-    /**
-     * The seed file used for all tests within this test case.
-     *
-     * @var string
-     */
-    protected $seed = CITestSeeder::class;
-
+    protected $seed               = CITestSeeder::class;
     private array $expectedTables = [];
 
     protected function setUp(): void