ext/sqlite3: SQLite3::close, SQLite3Stmt::close and SQLite3Result::finalize

changed from bool return value to void.

Author: devnexen

UPGRADING

@@ -102,6 +102,10 @@ PHP 8.3 UPGRADE NOTES
     argument is non empty with the class not having constructor.
   . pg_insert now raises a ValueError instead of a WARNING when the table specified is invalid.
 
+- Sqlite:
+  . SQLite3::close, SQLite3Result::finalize and SQLite3Stmt::close are void.
+    Previously, they always returned true.
+
 - Standard:
   . E_NOTICEs emitted by unserialized() have been promoted to E_WARNING.
     RFC: https://wiki.php.net/rfc/improve_unserialize_error_handling

ext/sqlite3/sqlite3.c

@@ -194,8 +194,6 @@ PHP_METHOD(SQLite3, close)
 		}
 		db_obj->initialised = 0;
 	}
-
-	RETURN_TRUE;
 }
 /* }}} */
 
@@ -1418,8 +1416,6 @@ PHP_METHOD(SQLite3Stmt, close)
 	if(stmt_obj->db_obj) {
 		zend_llist_del_element(&(stmt_obj->db_obj->free_list), object, (int (*)(void *, void *)) php_sqlite3_compare_stmt_zval_free);
 	}
-
-	RETURN_TRUE;
 }
 /* }}} */
 
@@ -2052,8 +2048,6 @@ PHP_METHOD(SQLite3Result, finalize)
 	} else {
 		sqlite3_reset(result_obj->stmt_obj->stmt);
 	}
-
-	RETURN_TRUE;
 }
 /* }}} */
 

ext/sqlite3/sqlite3.stub.php

@@ -311,8 +311,8 @@ public function __construct(string $filename, int $flags = SQLITE3_OPEN_READWRIT
     /** @tentative-return-type */
     public function open(string $filename, int $flags = SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE, string $encryptionKey = ""): void {}
 
-    /** @return bool */
-    public function close() {} // TODO make return type void
+    /** @tentative-return-type */
+    public function close(): void {}
 
     /** @tentative-return-type */
     public static function version(): array {}
@@ -397,7 +397,7 @@ public function bindValue(string|int $param, mixed $value, int $type = SQLITE3_T
     public function clear(): bool {}
 
     /** @tentative-return-type */
-    public function close(): bool {}
+    public function close(): void {}
 
     /** @tentative-return-type */
     public function execute(): SQLite3Result|false {}
@@ -435,6 +435,6 @@ public function fetchArray(int $mode = SQLITE3_BOTH): array|false {}
     /** @tentative-return-type */
     public function reset(): bool {}
 
-    /** @return bool */
-    public function finalize() {} // TODO make return type void
+    /** @tentative-return-type */
+    public function finalize(): void {}
 }

ext/sqlite3/sqlite3_arginfo.h

@@ -9,14 +9,12 @@ require_once(__DIR__ . '/new_db.inc');
 
 $stmt = $db->prepare("SELECT 1");
 
-var_dump($stmt->close());
+$stmt->close();
 
-var_dump($db->close());
+$db->close();
 
 print "done";
 
 ?>
 --EXPECT--
-bool(true)
-bool(true)
 done

ext/sqlite3/tests/bug47159.phpt

@@ -8,7 +8,7 @@ $db = new SQLite3(':memory:');
 echo "SELECTING from invalid table\n";
 $result = $db->query("SELECT * FROM non_existent_table");
 echo "Closing database\n";
-var_dump($db->close());
+$db->close();
 echo "Done\n";
 
 // Trigger the use-after-free
@@ -20,7 +20,6 @@ SELECTING from invalid table
 
 Warning: SQLite3::query(): Unable to prepare statement: 1, no such table: non_existent_table in %sbug69972.php on line %d
 Closing database
-bool(true)
 Done
 Error Code: 0
 Error Msg:

ext/sqlite3/tests/bug69972.phpt

@@ -10,13 +10,12 @@ $db = new SQLite3($db_file);
 //require_once(__DIR__ . '/new_db.inc');
 
 var_dump($db);
-var_dump($db->close());
+$db->close();
 
 unlink($db_file);
 echo "Done\n";
 ?>
 --EXPECTF--
 object(SQLite3)#%d (0) {
 }
-bool(true)
 Done

ext/sqlite3/tests/sqlite3_01_open-mb.phpt

@@ -8,11 +8,10 @@ sqlite3
 require_once(__DIR__ . '/new_db.inc');
 
 var_dump($db);
-var_dump($db->close());
+$db->close();
 echo "Done\n";
 ?>
 --EXPECTF--
 object(SQLite3)#%d (0) {
 }
-bool(true)
 Done

ext/sqlite3/tests/sqlite3_01_open.phpt

@@ -17,7 +17,7 @@ echo "Dropping database\n";
 var_dump($db->exec('DROP TABLE test'));
 
 echo "Closing database\n";
-var_dump($db->close());
+$db->close();
 echo "Done\n";
 ?>
 --EXPECTF--
@@ -30,5 +30,4 @@ bool(false)
 Dropping database
 bool(true)
 Closing database
-bool(true)
 Done

ext/sqlite3/tests/sqlite3_02_create.phpt

@@ -24,7 +24,7 @@ while ($result = $results->fetchArray(SQLITE3_NUM))
 $results->finalize();
 
 echo "Closing database\n";
-var_dump($db->close());
+$db->close();
 echo "Done\n";
 ?>
 --EXPECTF--
@@ -47,5 +47,4 @@ array(2) {
   string(1) "b"
 }
 Closing database
-bool(true)
 Done