codeigniter4 · paulbalandan · Nov 1, 2022 · Oct 24, 2022
diff --git a/phpstan-baseline.neon.dist b/phpstan-baseline.neon.dist
@@ -75,11 +75,6 @@ parameters:
 			count: 1
 			path: system/Database/BaseConnection.php
 
-		-
-			message: "#^Negated boolean expression is always false\\.$#"
-			count: 3
-			path: system/Database/BaseResult.php
-
 		-
 			message: "#^Unreachable statement \\- code above always terminates\\.$#"
 			count: 2
@@ -106,55 +101,15 @@ parameters:
 			path: system/Database/Migration.php
 
 		-
-			message: "#^Property CodeIgniter\\\\Database\\\\BaseConnection\\<mysqli\\|false\\>\\:\\:\\$strictOn \\(bool\\) in isset\\(\\) is not nullable\\.$#"
+			message: "#^Property CodeIgniter\\\\Database\\\\BaseConnection\\<mysqli,mysqli_result\\>\\:\\:\\$strictOn \\(bool\\) in isset\\(\\) is not nullable\\.$#"
 			count: 1
 			path: system/Database/MySQLi/Connection.php
 
 		-
-			message: "#^Access to an undefined property CodeIgniter\\\\Database\\\\BaseConnection\\<mysqli\\|false\\>\\:\\:\\$mysqli\\.$#"
+			message: "#^Access to an undefined property CodeIgniter\\\\Database\\\\BaseConnection\\<mysqli, mysqli_result\\>\\:\\:\\$mysqli\\.$#"
 			count: 3
 			path: system/Database/MySQLi/PreparedQuery.php
 
-		-
-			message: "#^Cannot access property \\$field_count on object\\|resource\\|false\\.$#"
-			count: 1
-			path: system/Database/MySQLi/Result.php
-
-		-
-			message: "#^Cannot access property \\$num_rows on object\\|resource\\|false\\.$#"
-			count: 1
-			path: system/Database/MySQLi/Result.php
-
-		-
-			message: "#^Cannot call method data_seek\\(\\) on object\\|resource\\|false\\.$#"
-			count: 1
-			path: system/Database/MySQLi/Result.php
-
-		-
-			message: "#^Cannot call method fetch_assoc\\(\\) on object\\|resource\\|false\\.$#"
-			count: 1
-			path: system/Database/MySQLi/Result.php
-
-		-
-			message: "#^Cannot call method fetch_field\\(\\) on object\\|resource\\|false\\.$#"
-			count: 1
-			path: system/Database/MySQLi/Result.php
-
-		-
-			message: "#^Cannot call method fetch_fields\\(\\) on object\\|resource\\|false\\.$#"
-			count: 1
-			path: system/Database/MySQLi/Result.php
-
-		-
-			message: "#^Cannot call method fetch_object\\(\\) on object\\|resource\\|false\\.$#"
-			count: 1
-			path: system/Database/MySQLi/Result.php
-
-		-
-			message: "#^Cannot call method field_seek\\(\\) on object\\|resource\\|false\\.$#"
-			count: 1
-			path: system/Database/MySQLi/Result.php
-
 		-
 			message: "#^Strict comparison using \\=\\=\\= between array<string, int|string|null> and false will always evaluate to false\\.$#"
 			count: 1
@@ -170,31 +125,6 @@ parameters:
 			count: 13
 			path: system/Database/SQLSRV/Forge.php
 
-		-
-			message: "#^Cannot call method columnName\\(\\) on object\\|resource\\|false\\.$#"
-			count: 2
-			path: system/Database/SQLite3/Result.php
-
-		-
-			message: "#^Cannot call method columnType\\(\\) on object\\|resource\\|false\\.$#"
-			count: 1
-			path: system/Database/SQLite3/Result.php
-
-		-
-			message: "#^Cannot call method fetchArray\\(\\) on object\\|resource\\|false\\.$#"
-			count: 2
-			path: system/Database/SQLite3/Result.php
-
-		-
-			message: "#^Cannot call method numColumns\\(\\) on object\\|resource\\|false\\.$#"
-			count: 1
-			path: system/Database/SQLite3/Result.php
-
-		-
-			message: "#^Cannot call method reset\\(\\) on object\\|resource\\|false\\.$#"
-			count: 2
-			path: system/Database/SQLite3/Result.php
-
 		-
 			message: "#^Call to an undefined method CodeIgniter\\\\View\\\\RendererInterface\\:\\:getPerformanceData\\(\\)\\.$#"
 			count: 1

diff --git a/system/Database/BaseConnection.php b/system/Database/BaseConnection.php
@@ -46,9 +46,10 @@
  * @property bool       $transFailure
  * @property bool       $transStatus
  *
- * @template TConnection of false|object|resource
+ * @template TConnection of object|resource
+ * @template TResult of object|resource
  *
- * @implements ConnectionInterface<TConnection>
+ * @implements ConnectionInterface<TConnection, TResult>
  */
 abstract class BaseConnection implements ConnectionInterface
 {
@@ -194,14 +195,15 @@ abstract class BaseConnection implements ConnectionInterface
      * Connection ID
      *
      * @var false|object|resource
-     * @phpstan-var TConnection
+     * @phpstan-var false|TConnection
      */
     public $connID = false;
 
     /**
      * Result ID
      *
-     * @var bool|object|resource
+     * @var false|object|resource
+     * @phpstan-var false|TResult
      */
     public $resultID = false;
 
@@ -538,7 +540,8 @@ public function addTableAlias(string $table)
     /**
      * Executes the query against the database.
      *
-     * @return bool|object|resource
+     * @return false|object|resource
+     * @phpstan-return false|TResult
      */
     abstract protected function execute(string $sql);
 
@@ -553,6 +556,7 @@ abstract protected function execute(string $sql);
      * @param mixed ...$binds
      *
      * @return BaseResult|bool|Query BaseResult when “read” type query, bool when “write” type query, Query when prepared query
+     * @phpstan-return BaseResult<TConnection, TResult>|bool|Query
      *
      * @todo BC set $queryClass default as null in 4.1
      */
@@ -662,7 +666,8 @@ public function query(string $sql, $binds = null, bool $setEscapeFlags = true, s
      * is performed, nor are transactions handled. Simply takes a raw
      * query string and returns the database-specific result id.
      *
-     * @return mixed
+     * @return false|object|resource
+     * @phpstan-return false|TResult
      */
     public function simpleQuery(string $sql)
     {

diff --git a/system/Database/BasePreparedQuery.php b/system/Database/BasePreparedQuery.php
@@ -18,12 +18,11 @@
 use ErrorException;
 
 /**
- * Base prepared query
- *
- * @template TConnection of false|object|resource
+ * @template TConnection of object|resource
  * @template TStatement of object|resource
+ * @template TResult of object|resource
  *
- * @implements PreparedQueryInterface<TConnection, TStatement>
+ * @implements PreparedQueryInterface<TConnection, TStatement, TResult>
  */
 abstract class BasePreparedQuery implements PreparedQueryInterface
 {
@@ -61,7 +60,7 @@ abstract class BasePreparedQuery implements PreparedQueryInterface
      * A reference to the db connection to use.
      *
      * @var BaseConnection
-     * @phpstan-var BaseConnection<TConnection>
+     * @phpstan-var BaseConnection<TConnection, TResult>
      */
     protected $db;
 
@@ -77,7 +76,7 @@ public function __construct(BaseConnection $db)
      * NOTE: This version is based on SQL code. Child classes should
      * override this method.
      *
-     * @return mixed
+     * @return $this
      */
     public function prepare(string $sql, array $options = [], string $queryClass = Query::class)
     {
@@ -103,7 +102,7 @@ public function prepare(string $sql, array $options = [], string $queryClass = Q
     /**
      * The database-dependent portion of the prepare statement.
      *
-     * @return mixed
+     * @return $this
      */
     abstract public function _prepare(string $sql, array $options = []);
 
@@ -112,6 +111,7 @@ abstract public function _prepare(string $sql, array $options = []);
      * prepared query. Upon success, will return a Results object.
      *
      * @return bool|ResultInterface
+     * @phpstan-return bool|ResultInterface<TConnection, TResult>
      *
      * @throws DatabaseException
      */
@@ -195,7 +195,7 @@ abstract public function _execute(array $data): bool;
     /**
      * Returns the result object for the prepared query.
      *
-     * @return mixed
+     * @return object|resource|null
      */
     abstract public function _getResult();
 

diff --git a/system/Database/BaseResult.php b/system/Database/BaseResult.php
@@ -14,21 +14,26 @@
 use CodeIgniter\Entity\Entity;
 
 /**
- * Class BaseResult
+ * @template TConnection of object|resource
+ * @template TResult of object|resource
+ *
+ * @implements ResultInterface<TConnection, TResult>
  */
 abstract class BaseResult implements ResultInterface
 {
     /**
      * Connection ID
      *
      * @var object|resource
+     * @phpstan-var TConnection
      */
     public $connID;
 
     /**
      * Result ID
      *
      * @var false|object|resource
+     * @phpstan-var false|TResult
      */
     public $resultID;
 
@@ -79,6 +84,8 @@ abstract class BaseResult implements ResultInterface
      *
      * @param object|resource $connID
      * @param object|resource $resultID
+     * @phpstan-param TConnection $connID
+     * @phpstan-param TResult     $resultID
      */
     public function __construct(&$connID, &$resultID)
     {
@@ -117,7 +124,7 @@ public function getCustomResultObject(string $className)
             return $this->customResultObject[$className];
         }
 
-        if (is_bool($this->resultID) || ! $this->resultID) {
+        if (! $this->isValidResultId()) {
             return [];
         }
 
@@ -171,7 +178,7 @@ public function getResultArray(): array
         // In the event that query caching is on, the result_id variable
         // will not be a valid resource so we'll simply return an empty
         // array.
-        if (is_bool($this->resultID) || ! $this->resultID) {
+        if (! $this->isValidResultId()) {
             return [];
         }
 
@@ -208,7 +215,7 @@ public function getResultObject(): array
         // In the event that query caching is on, the result_id variable
         // will not be a valid resource so we'll simply return an empty
         // array.
-        if (is_bool($this->resultID) || ! $this->resultID) {
+        if (! $this->isValidResultId()) {
             return [];
         }
 
@@ -463,6 +470,11 @@ public function getNumRows(): int
         return $this->numRows = count($this->getResultArray());
     }
 
+    private function isValidResultId(): bool
+    {
+        return is_resource($this->resultID) || is_object($this->resultID);
+    }
+
     /**
      * Gets the number of fields in the result set.
      */

diff --git a/system/Database/ConnectionInterface.php b/system/Database/ConnectionInterface.php
@@ -12,9 +12,8 @@
 namespace CodeIgniter\Database;
 
 /**
- * Interface ConnectionInterface
- *
- * @template TConnection of false|object|resource
+ * @template TConnection of object|resource
+ * @template TResult of object|resource
  */
 interface ConnectionInterface
 {
@@ -29,15 +28,15 @@ public function initialize();
      * Connect to the database.
      *
      * @return false|object|resource
-     * @phpstan-return TConnection
+     * @phpstan-return false|TConnection
      */
     public function connect(bool $persistent = false);
 
     /**
      * Create a persistent database connection.
      *
      * @return false|object|resource
-     * @phpstan-return TConnection
+     * @phpstan-return false|TConnection
      */
     public function persistentConnect();
 
@@ -56,7 +55,7 @@ public function reconnect();
      * connection is present, it must return the sole connection.
      *
      * @return false|object|resource
-     * @phpstan-return TConnection
+     * @phpstan-return false|TConnection
      */
     public function getConnection(?string $alias = null);
 
@@ -102,6 +101,7 @@ public function getVersion(): string;
      * @param mixed ...$binds
      *
      * @return BaseResult|bool|Query
+     * @phpstan-return BaseResult<TConnection, TResult>|bool|Query
      */
     public function query(string $sql, $binds = null);
 
@@ -110,7 +110,8 @@ public function query(string $sql, $binds = null);
      * is performed, nor are transactions handled. Simply takes a raw
      * query string and returns the database-specific result id.
      *
-     * @return mixed
+     * @return false|object|resource
+     * @phpstan-return false|TResult
      */
     public function simpleQuery(string $sql);
 

diff --git a/system/Database/MySQLi/Connection.php b/system/Database/MySQLi/Connection.php
@@ -15,14 +15,15 @@
 use CodeIgniter\Database\Exceptions\DatabaseException;
 use LogicException;
 use mysqli;
+use mysqli_result;
 use mysqli_sql_exception;
 use stdClass;
 use Throwable;
 
 /**
  * Connection for MySQLi
  *
- * @extends BaseConnection<false|mysqli>
+ * @extends BaseConnection<mysqli, mysqli_result>
  */
 class Connection extends BaseConnection
 {
@@ -279,7 +280,7 @@ public function getVersion(): string
     /**
      * Executes the query against the database.
      *
-     * @return bool|object
+     * @return false|mysqli_result;
      */
     protected function execute(string $sql)
     {