Merge pull request #8767 from kenjis/feat-resetTransStatus

feat: add BaseConnection::resetTransStatus()

Author: kenjis

system/Database/BaseConnection.php

@@ -897,6 +897,16 @@ public function transRollback(): bool
         return false;
     }
 
+    /**
+     * Reset transaction status - to restart transactions after strict mode failure
+     */
+    public function resetTransStatus(): static
+    {
+        $this->transStatus = true;
+
+        return $this;
+    }
+
     /**
      * Begin Transaction
      */

tests/system/Database/Live/TransactionDBDebugTrueTest.php

@@ -208,6 +208,54 @@ public function testTransStrictFalse(): void
         $this->seeInDatabase('job', ['name' => 'Comedian']);
     }
 
+    public function testTransStrictTrueAndResetTransStatus(): void
+    {
+        $builder = $this->db->table('job');
+
+        // The first transaction group
+        $this->db->transStart();
+
+        $jobData = [
+            'name'        => 'Grocery Sales',
+            'description' => 'Discount!',
+        ];
+        $builder->insert($jobData);
+
+        $this->assertTrue($this->db->transStatus());
+
+        // Duplicate entry '1' for key 'PRIMARY'
+        $jobData = [
+            'id'          => 1,
+            'name'        => 'Comedian',
+            'description' => 'Theres something in your teeth',
+        ];
+        $builder->insert($jobData);
+
+        $this->assertFalse($this->db->transStatus());
+
+        $this->db->transComplete();
+
+        $this->dontSeeInDatabase('job', ['name' => 'Grocery Sales']);
+
+        // Resets TransStatus
+        $this->db->resetTransStatus();
+
+        // The second transaction group
+        $this->db->transStart();
+
+        $jobData = [
+            'name'        => 'Comedian',
+            'description' => 'Theres something in your teeth',
+        ];
+        $builder->insert($jobData);
+
+        $this->assertTrue($this->db->transStatus());
+
+        $this->db->transComplete();
+
+        $this->seeInDatabase('job', ['name' => 'Comedian']);
+    }
+
     public function testTransBegin(): void
     {
         $builder = $this->db->table('job');

user_guide_src/source/changelogs/v4.6.0.rst

@@ -135,6 +135,8 @@ Others
 ------
 
 - Added a new configuration ``foundRows`` for MySQLi to use ``MYSQLI_CLIENT_FOUND_ROWS``.
+- Added the ``BaseConnection::resetTransStatus()`` method to reset the transaction
+  status. See :ref:`transactions-resetting-transaction-status` for details.
 
 Model
 =====

user_guide_src/source/database/transactions.rst

@@ -14,7 +14,7 @@ transactions.
 
 .. contents::
     :local:
-    :depth: 2
+    :depth: 3
 
 CodeIgniter's Approach to Transactions
 ======================================
@@ -52,16 +52,33 @@ or failure of any given query.
 Strict Mode
 ===========
 
-By default, CodeIgniter runs all transactions in Strict Mode. When strict
-mode is enabled, if you are running multiple groups of transactions, if
-one group fails all subsequent groups will be rolled back. If strict mode is
-disabled, each group is treated independently, meaning a failure of one
-group will not affect any others.
+By default, CodeIgniter runs all transactions in Strict Mode.
+
+When strict mode is enabled, if you are running multiple groups of transactions,
+if one group fails all subsequent groups will be rolled back.
+
+If strict mode is disabled, each group is treated independently, meaning a failure
+of one group will not affect any others.
 
 Strict Mode can be disabled as follows:
 
 .. literalinclude:: transactions/002.php
 
+.. _transactions-resetting-transaction-status:
+
+Resetting Transaction Status
+----------------------------
+
+.. versionadded:: 4.6.0
+
+When strict mode is enabled, if one transaction fails, all subsequent transactions
+will be rolled back.
+
+If you wan to restart transactions after a failure, you can reset the transaction
+status:
+
+.. literalinclude:: transactions/009.php
+
 .. _transactions-managing-errors:
 
 Managing Errors

user_guide_src/source/database/transactions/009.php

@@ -0,0 +1,3 @@
+<?php
+
+$this->db->resetTransStatus();