refactor: fix phpstan errors in mock classes (codeigniter4#9594)

paulbalandan · web-flow · commit af6835887823 · 2025-06-04T01:57:36.000+08:00
diff --git a/system/Database/BaseBuilder.php b/system/Database/BaseBuilder.php
@@ -256,7 +256,7 @@ class BaseBuilder
      * Specifies which sql statements
      * support the ignore option.
      *
-     * @var array
+     * @var array<string, string>
      */
     protected $supportedIgnoreStatements = [];
 
diff --git a/system/Database/BaseResult.php b/system/Database/BaseResult.php
@@ -529,9 +529,9 @@ abstract protected function fetchAssoc();
     /**
      * Returns the result set as an object.
      *
-     * Overridden by child classes.
+     * @param class-string $className
      *
-     * @return Entity|false|object|stdClass
+     * @return false|object
      */
-    abstract protected function fetchObject(string $className = 'stdClass');
+    abstract protected function fetchObject(string $className = stdClass::class);
 }
diff --git a/system/Database/MySQLi/Builder.php b/system/Database/MySQLi/Builder.php
@@ -33,7 +33,7 @@ class Builder extends BaseBuilder
      * Specifies which sql statements
      * support the ignore option.
      *
-     * @var array
+     * @var array<string, string>
      */
     protected $supportedIgnoreStatements = [
         'update' => 'IGNORE',
diff --git a/system/Database/Postgre/Builder.php b/system/Database/Postgre/Builder.php
@@ -36,7 +36,7 @@ class Builder extends BaseBuilder
      * Specifies which sql statements
      * support the ignore option.
      *
-     * @var array
+     * @var array<string, string>
      */
     protected $supportedIgnoreStatements = [
         'insert' => 'ON CONFLICT DO NOTHING',
diff --git a/system/Database/SQLite3/Builder.php b/system/Database/SQLite3/Builder.php
@@ -49,7 +49,7 @@ class Builder extends BaseBuilder
     ];
 
     /**
-     * @var array
+     * @var array<string, string>
      */
     protected $supportedIgnoreStatements = [
         'insert' => 'OR IGNORE',
diff --git a/system/HTTP/CURLRequest.php b/system/HTTP/CURLRequest.php
@@ -696,6 +696,8 @@ protected function setCURLOptions(array $curlOptions = [], array $config = [])
      * Does the actual work of initializing cURL, setting the options,
      * and grabbing the output.
      *
+     * @param array<int, mixed> $curlOptions
+     *
      * @codeCoverageIgnore
      */
     protected function sendRequest(array $curlOptions = []): string
diff --git a/system/Test/Mock/MockBuilder.php b/system/Test/Mock/MockBuilder.php
@@ -17,6 +17,9 @@
 
 class MockBuilder extends BaseBuilder
 {
+    /**
+     * @var array<string, string>
+     */
     protected $supportedIgnoreStatements = [
         'update' => 'IGNORE',
         'insert' => 'IGNORE',
diff --git a/system/Test/Mock/MockCLIConfig.php b/system/Test/Mock/MockCLIConfig.php
@@ -17,14 +17,19 @@
 
 class MockCLIConfig extends App
 {
-    public string $baseURL         = 'http://example.com/';
-    public string $uriProtocol     = 'REQUEST_URI';
-    public array $proxyIPs         = [];
-    public string $CSRFTokenName   = 'csrf_test_name';
-    public string $CSRFCookieName  = 'csrf_cookie_name';
-    public int $CSRFExpire         = 7200;
-    public bool $CSRFRegenerate    = true;
-    public $CSRFExcludeURIs        = ['http://example.com'];
+    public string $baseURL        = 'http://example.com/';
+    public string $uriProtocol    = 'REQUEST_URI';
+    public array $proxyIPs        = [];
+    public string $CSRFTokenName  = 'csrf_test_name';
+    public string $CSRFCookieName = 'csrf_cookie_name';
+    public int $CSRFExpire        = 7200;
+    public bool $CSRFRegenerate   = true;
+
+    /**
+     * @var list<string>
+     */
+    public array $CSRFExcludeURIs = ['http://example.com'];
+
     public string $CSRFSameSite    = 'Lax';
     public bool $CSPEnabled        = false;
     public string $defaultLocale   = 'en';
diff --git a/system/Test/Mock/MockCURLRequest.php b/system/Test/Mock/MockCURLRequest.php
@@ -23,7 +23,14 @@
  */
 class MockCURLRequest extends CURLRequest
 {
+    /**
+     * @var array<int, mixed>
+     */
     public $curl_options;
+
+    /**
+     * @var string
+     */
     protected $output = '';
 
     /**
@@ -38,11 +45,13 @@ public function setOutput($output)
         return $this;
     }
 
+    /**
+     * @param array<int, mixed> $curlOptions
+     */
     protected function sendRequest(array $curlOptions = []): string
     {
         $this->response = clone $this->responseOrig;
 
-        // Save so we can access later.
         $this->curl_options = $curlOptions;
 
         return $this->output;
diff --git a/system/Test/Mock/MockCache.php b/system/Test/Mock/MockCache.php
@@ -214,8 +214,9 @@ public function getCacheInfo()
     /**
      * Returns detailed information about the specific item in the cache.
      *
-     * @return array|null Returns null if the item does not exist, otherwise array<string, mixed>
-     *                    with at least the 'expire' key for absolute epoch expiry (or null).
+     * @return array{expire: int|null}|null Returns null if the item does not exist,
+     *                                      otherwise, array with the 'expire' key for
+     *                                      absolute epoch expiry (or null).
      */
     public function getMetaData(string $key)
     {
diff --git a/system/Test/Mock/MockConnection.php b/system/Test/Mock/MockConnection.php
@@ -18,14 +18,18 @@
 use CodeIgniter\Database\BaseResult;
 use CodeIgniter\Database\Query;
 use CodeIgniter\Database\TableName;
+use stdClass;
 
 /**
  * @extends BaseConnection<object|resource, object|resource>
  */
 class MockConnection extends BaseConnection
 {
     /**
-     * @var array{connect?: mixed, execute?: bool|object}
+     * @var array{
+     *   connect?: object|resource|false|list<object|resource|false>,
+     *   execute?: object|resource|false,
+     * }
      */
     protected $returnValues = [];
 
@@ -36,11 +40,18 @@ class MockConnection extends BaseConnection
      */
     protected $schema;
 
+    /**
+     * @var string
+     */
     public $database;
+
+    /**
+     * @var Query
+     */
     public $lastQuery;
 
     /**
-     * @param mixed $return
+     * @param false|list<false|object|resource>|object|resource $return
      *
      * @return $this
      */
@@ -59,14 +70,15 @@ public function shouldReturn(string $method, $return)
      * Should automatically handle different connections for read/write
      * queries if needed.
      *
-     * @param mixed ...$binds
+     * @param mixed $binds
      *
-     * @return BaseResult|bool|Query
+     * @return BaseResult<object|resource, object|resource>|bool|Query
      *
      * @todo BC set $queryClass default as null in 4.1
      */
     public function query(string $sql, $binds = null, bool $setEscapeFlags = true, string $queryClass = '')
     {
+        /** @var class-string<Query> $queryClass */
         $queryClass = str_replace('Connection', 'Query', static::class);
 
         $query = new $queryClass($this);
@@ -81,23 +93,24 @@ public function query(string $sql, $binds = null, bool $setEscapeFlags = true, s
 
         $this->lastQuery = $query;
 
-        // Run the query
-        if (false === ($this->resultID = $this->simpleQuery($query->getQuery()))) {
+        $this->resultID = $this->simpleQuery($query->getQuery());
+
+        if ($this->resultID === false) {
             $query->setDuration($startTime, $startTime);
 
             // @todo deal with errors
-
             return false;
         }
 
         $query->setDuration($startTime);
 
         // resultID is not false, so it must be successful
-        if ($query->isWriteType($sql)) {
+        if ($query->isWriteType()) {
             return true;
         }
 
         // query is not write-type, so it must be read-type query; return QueryResult
+        /** @var class-string<BaseResult> $resultClass */
         $resultClass = str_replace('Connection', 'Result', static::class);
 
         return new $resultClass($this->connID, $this->resultID);
@@ -106,7 +119,7 @@ public function query(string $sql, $binds = null, bool $setEscapeFlags = true, s
     /**
      * Connect to the database.
      *
-     * @return mixed
+     * @return false|object|resource
      */
     public function connect(bool $persistent = false)
     {
@@ -153,7 +166,7 @@ public function getVersion(): string
     /**
      * Executes the query against the database.
      *
-     * @return bool|object
+     * @return false|object|resource
      */
     protected function execute(string $sql)
     {
@@ -171,9 +184,7 @@ public function affectedRows(): int
     /**
      * Returns the last error code and message.
      *
-     * Must return an array with keys 'code' and 'message':
-     *
-     *  return ['code' => null, 'message' => null);
+     * @return array{code: int, message: string}
      */
     public function error(): array
     {
@@ -183,9 +194,6 @@ public function error(): array
         ];
     }
 
-    /**
-     * Insert ID
-     */
     public function insertID(): int
     {
         return $this->connID->insert_id;
@@ -211,16 +219,25 @@ protected function _listColumns($table = ''): string
         return '';
     }
 
+    /**
+     * @return list<stdClass>
+     */
     protected function _fieldData(string $table): array
     {
         return [];
     }
 
+    /**
+     * @return array<string, stdClass>
+     */
     protected function _indexData(string $table): array
     {
         return [];
     }
 
+    /**
+     * @return array<string, stdClass>
+     */
     protected function _foreignKeyData(string $table): array
     {
         return [];
diff --git a/system/Test/Mock/MockEvents.php b/system/Test/Mock/MockEvents.php
@@ -18,15 +18,15 @@
 class MockEvents extends Events
 {
     /**
-     * @return array
+     * @return array<string, array{0: bool, 1: list<int>, 2: list<callable(mixed): mixed>}>
      */
     public function getListeners()
     {
         return self::$listeners;
     }
 
     /**
-     * @return array<int, string>
+     * @return list<string>
      */
     public function getEventsFile()
     {
diff --git a/system/Test/Mock/MockInputOutput.php b/system/Test/Mock/MockInputOutput.php
@@ -78,6 +78,8 @@ public function getOutput(?int $index = null): string
 
     /**
      * Returns the outputs array.
+     *
+     * @return list<string>
      */
     public function getOutputs(): array
     {
diff --git a/system/Test/Mock/MockResult.php b/system/Test/Mock/MockResult.php
@@ -31,6 +31,8 @@ public function getFieldCount(): int
 
     /**
      * Generates an array of column names in the result set.
+     *
+     * @return array{}
      */
     public function getFieldNames(): array
     {
@@ -39,6 +41,8 @@ public function getFieldNames(): array
 
     /**
      * Generates an array of objects representing field meta-data.
+     *
+     * @return array{}
      */
     public function getFieldData(): array
     {
@@ -73,7 +77,7 @@ public function dataSeek($n = 0)
      *
      * Overridden by driver classes.
      *
-     * @return mixed
+     * @return array{}
      */
     protected function fetchAssoc()
     {
@@ -83,13 +87,11 @@ protected function fetchAssoc()
     /**
      * Returns the result set as an object.
      *
-     * Overridden by child classes.
-     *
-     * @param string $className
+     * @param class-string $className
      *
-     * @return object|stdClass
+     * @return object
      */
-    protected function fetchObject($className = 'stdClass')
+    protected function fetchObject($className = stdClass::class)
     {
         return new $className();
     }
diff --git a/system/Test/Mock/MockServices.php b/system/Test/Mock/MockServices.php
@@ -18,9 +18,16 @@
 
 class MockServices extends BaseService
 {
+    /**
+     * @var array<non-empty-string, non-empty-string>
+     */
     public $psr4 = [
         'Tests/Support' => TESTPATH . '_support/',
     ];
+
+    /**
+     * @var array<class-string, string>
+     */
     public $classmap = [];
 
     public function __construct()
diff --git a/system/Test/Mock/MockSession.php b/system/Test/Mock/MockSession.php
@@ -30,9 +30,9 @@ class MockSession extends Session
      *
      * @var list<Cookie>
      */
-    public $cookies = [];
+    public array $cookies = [];
 
-    public $didRegenerate = false;
+    public bool $didRegenerate = false;
 
     /**
      * Sets the driver as the session handler in PHP.
diff --git a/tests/system/Database/BaseConnectionTest.php b/tests/system/Database/BaseConnectionTest.php
diff --git a/tests/system/Database/Builder/InsertTest.php b/tests/system/Database/Builder/InsertTest.php
diff --git a/tests/system/Database/Builder/UpdateTest.php b/tests/system/Database/Builder/UpdateTest.php
diff --git a/utils/phpstan-baseline/loader.neon b/utils/phpstan-baseline/loader.neon
diff --git a/utils/phpstan-baseline/method.childReturnType.neon b/utils/phpstan-baseline/method.childReturnType.neon
diff --git a/utils/phpstan-baseline/missingType.iterableValue.neon b/utils/phpstan-baseline/missingType.iterableValue.neon
diff --git a/utils/phpstan-baseline/missingType.property.neon b/utils/phpstan-baseline/missingType.property.neon

Original file line number	Diff line number	Diff line change
`@@ -256,7 +256,7 @@ class BaseBuilder`
`256`	`256`	`* Specifies which sql statements`
`257`	`257`	`* support the ignore option.`
`258`	`258`	`*`
`259`		`- * @var array`
	`259`	`+ * @var array<string, string>`
`260`	`260`	`*/`
`261`	`261`	`protected $supportedIgnoreStatements = [];`
`262`	`262`
Original file line number	Diff line number	Diff line change
`@@ -529,9 +529,9 @@ abstract protected function fetchAssoc();`
`529`	`529`	`/**`
`530`	`530`	`* Returns the result set as an object.`
`531`	`531`	`*`
`532`		`- * Overridden by child classes.`
	`532`	`+ * @param class-string $className`
`533`	`533`	`*`
`534`		`- * @return Entity\|false\|object\|stdClass`
	`534`	`+ * @return false\|object`
`535`	`535`	`*/`
`536`		`- abstract protected function fetchObject(string $className = 'stdClass');`
	`536`	`+ abstract protected function fetchObject(string $className = stdClass::class);`
`537`	`537`	`}`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ class Builder extends BaseBuilder`
`33`	`33`	`* Specifies which sql statements`
`34`	`34`	`* support the ignore option.`
`35`	`35`	`*`
`36`		`- * @var array`
	`36`	`+ * @var array<string, string>`
`37`	`37`	`*/`
`38`	`38`	`protected $supportedIgnoreStatements = [`
`39`	`39`	`'update' => 'IGNORE',`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ class Builder extends BaseBuilder`
`36`	`36`	`* Specifies which sql statements`
`37`	`37`	`* support the ignore option.`
`38`	`38`	`*`
`39`		`- * @var array`
	`39`	`+ * @var array<string, string>`
`40`	`40`	`*/`
`41`	`41`	`protected $supportedIgnoreStatements = [`
`42`	`42`	`'insert' => 'ON CONFLICT DO NOTHING',`
Original file line number	Diff line number	Diff line change
`@@ -696,6 +696,8 @@ protected function setCURLOptions(array $curlOptions = [], array $config = [])`
`696`	`696`	`* Does the actual work of initializing cURL, setting the options,`
`697`	`697`	`* and grabbing the output.`
`698`	`698`	`*`
	`699`	`+ * @param array<int, mixed> $curlOptions`
	`700`	`+ *`
`699`	`701`	`* @codeCoverageIgnore`
`700`	`702`	`*/`
`701`	`703`	`protected function sendRequest(array $curlOptions = []): string`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,9 @@`
`17`	`17`
`18`	`18`	`class MockBuilder extends BaseBuilder`
`19`	`19`	`{`
	`20`	`+ /**`
	`21`	`+ * @var array<string, string>`
	`22`	`+ */`
`20`	`23`	`protected $supportedIgnoreStatements = [`
`21`	`24`	`'update' => 'IGNORE',`
`22`	`25`	`'insert' => 'IGNORE',`
Original file line number	Diff line number	Diff line change
`@@ -214,8 +214,9 @@ public function getCacheInfo()`
`214`	`214`	`/**`
`215`	`215`	`* Returns detailed information about the specific item in the cache.`
`216`	`216`	`*`
`217`		`- * @return array\|null Returns null if the item does not exist, otherwise array<string, mixed>`
`218`		`- * with at least the 'expire' key for absolute epoch expiry (or null).`
	`217`	`+ * @return array{expire: int\|null}\|null Returns null if the item does not exist,`
	`218`	`+ * otherwise, array with the 'expire' key for`
	`219`	`+ * absolute epoch expiry (or null).`
`219`	`220`	`*/`
`220`	`221`	`public function getMetaData(string $key)`
`221`	`222`	`{`