feat: Abstract method and database dependants versions of the "close" method

Author: fpoy

phpstan-baseline.neon.dist

@@ -256,10 +256,15 @@ parameters:
 			path: system/Database/MySQLi/PreparedQuery.php
 
 		-
-			message: "#^Property CodeIgniter\\\\Database\\\\BasePreparedQuery\\:\\:\\$statement \\(object\\|resource\\) in isset\\(\\) is not nullable\\.$#"
+			message: "#^Cannot call method close\\(\\) on object\\|resource\\.$#"
 			count: 1
 			path: system/Database/MySQLi/PreparedQuery.php
 
+		-
+			message: "#^Property CodeIgniter\\\\Database\\\\BasePreparedQuery\\:\\:\\$statement \\(object\\|resource\\) in isset\\(\\) is not nullable\\.$#"
+			count: 2
+			path: system/Database/MySQLi/PreparedQuery.php
+
 		-
 			message: "#^Cannot access property \\$field_count on object\\|resource\\|false\\.$#"
 			count: 1
@@ -307,7 +312,7 @@ parameters:
 
 		-
 			message: "#^Property CodeIgniter\\\\Database\\\\BasePreparedQuery\\:\\:\\$statement \\(object\\|resource\\) in isset\\(\\) is not nullable\\.$#"
-			count: 1
+			count: 2
 			path: system/Database/Postgre/PreparedQuery.php
 
 		-
@@ -322,7 +327,7 @@ parameters:
 
 		-
 			message: "#^Property CodeIgniter\\\\Database\\\\BasePreparedQuery\\:\\:\\$statement \\(object\\|resource\\) in isset\\(\\) is not nullable\\.$#"
-			count: 1
+			count: 2
 			path: system/Database/SQLSRV/PreparedQuery.php
 
 		-
@@ -391,10 +396,15 @@ parameters:
 			path: system/Database/SQLite3/PreparedQuery.php
 
 		-
-			message: "#^Property CodeIgniter\\\\Database\\\\BasePreparedQuery\\:\\:\\$statement \\(object\\|resource\\) in isset\\(\\) is not nullable\\.$#"
+			message: "#^Cannot call method close\\(\\) on object\\|resource\\.$#"
 			count: 1
 			path: system/Database/SQLite3/PreparedQuery.php
 
+		-
+			message: "#^Property CodeIgniter\\\\Database\\\\BasePreparedQuery\\:\\:\\$statement \\(object\\|resource\\) in isset\\(\\) is not nullable\\.$#"
+			count: 2
+			path: system/Database/SQLite3/PreparedQuery.php
+
 		-
 			message: "#^Cannot call method columnName\\(\\) on object\\|resource\\|false\\.$#"
 			count: 2

system/Database/BasePreparedQuery.php

@@ -140,17 +140,18 @@ abstract public function _execute(array $data): bool;
     abstract public function _getResult();
 
     /**
-     * Explicitly closes the statement.
+     * Explicitly closes the prepared statement.
      */
-    public function close()
+    public function close(): bool
     {
-        if (! is_object($this->statement) || ! method_exists($this->statement, 'close')) {
-            return;
-        }
-
-        $this->statement->close();
+        return $this->_close();
     }
 
+    /**
+     * The database dependant version of the close method.
+     */
+    abstract public function _close(): bool;
+
     /**
      * Returns the SQL that has been prepared.
      */

system/Database/MySQLi/PreparedQuery.php

@@ -84,4 +84,18 @@ public function _getResult()
     {
         return $this->statement->get_result();
     }
+
+    /**
+     * Deallocate prepared statements
+     */
+    public function _close(): bool
+    {
+        $error = true;
+        if (isset($this->statement)) {
+            $error = $this->statement->close();
+            unset($this->statement);
+        }
+
+        return $error;
+    }
 }

system/Database/OCI8/PreparedQuery.php

@@ -93,6 +93,20 @@ public function _getResult()
         return $this->statement;
     }
 
+    /**
+     * Deallocate prepared statements
+     */
+    public function _close(): bool
+    {
+        $error = true;
+        if (null !== $this->statement) {
+            $error = oci_free_statement($this->statement);
+            unset($this->statement);
+        }
+
+        return $error;
+    }
+
     /**
      * Replaces the ? placeholders with :0, :1, etc parameters for use
      * within the prepared query.

system/Database/Postgre/PreparedQuery.php

@@ -93,6 +93,20 @@ public function _getResult()
         return $this->result;
     }
 
+    /**
+     * Deallocate prepared statements
+     */
+    public function _close(): bool
+    {
+        $error = true;
+        if (isset($this->statement)) {
+            $error = (bool) pg_query($this->db->connID, 'DEALLOCATE ' . $this->name);
+            unset($this->statement);
+        }
+
+        return $error;
+    }
+
     /**
      * Replaces the ? placeholders with $1, $2, etc parameters for use
      * within the prepared query.

system/Database/SQLSRV/PreparedQuery.php

@@ -95,6 +95,20 @@ public function _getResult()
         return $this->result;
     }
 
+    /**
+     * Deallocate prepared statements
+     */
+    public function _close(): bool
+    {
+        $error = true;
+        if (isset($this->statement)) {
+            $error = sqlsrv_free_stmt($this->statement);
+            unset($this->statement);
+        }
+
+        return $error;
+    }
+
     /**
      * Handle parameters
      */

system/Database/SQLite3/PreparedQuery.php

@@ -88,4 +88,18 @@ public function _getResult()
     {
         return $this->result;
     }
+
+    /**
+     * Deallocate prepared statements
+     */
+    public function _close(): bool
+    {
+        $error = true;
+        if (isset($this->statement)) {
+            $error = $this->statement->close();
+            unset($this->statement);
+        }
+
+        return $error;
+    }
 }