【PHP8.x】PDO::inTransaction()メソッドの使い方

Copy
1<?php
2
3/**
4 * PDO::inTransaction() メソッドのデモンストレーションを行う関数。
5 *
6 * この関数は、データベーストランザクションの状態が PDO::inTransaction() によって
7 * どのように報告されるかを示します。
8 * トランザクションの開始前、開始後（トランザクション中）、そして終了後（コミット後）の
9 * 状態を確認します。
10 */
11function demonstratePdoInTransaction(): void
12{
13    echo "PDO::inTransaction() のデモンストレーションを開始します。\n\n";
14
15    try {
16        // 1. SQLiteのインメモリデータベースに接続
17        //    エラー発生時にPDOExceptionをスローするよう設定します。
18        $pdo = new PDO('sqlite::memory:');
19        $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
20
21        // 接続直後、トランザクションは開始されていない状態
22        echo "--- 接続直後（トランザクション開始前）---\n";
23        echo "inTransaction(): " . ($pdo->inTransaction() ? 'true' : 'false') . "\n\n"; // 期待値: false
24
25        // 2. トランザクションを開始
26        echo "--- beginTransaction() を呼び出し ---\n";
27        $pdo->beginTransaction();
28        echo "トランザクションが開始されました。\n";
29        // トランザクション開始後、inTransaction() は true を返す
30        echo "inTransaction(): " . ($pdo->inTransaction() ? 'true' : 'false') . "\n\n"; // 期待値: true
31
32        // 3. トランザクション内でダミーのデータベース操作を実行
33        echo "--- トランザクション内での操作 ---\n";
34        $pdo->exec("CREATE TABLE IF NOT EXISTS users (id INTEGER PRIMARY KEY, name TEXT)");
35        $pdo->exec("INSERT INTO users (name) VALUES ('Alice')");
36        echo "データベース操作を実行しました。\n";
37        // 操作後もトランザクション中なので、inTransaction() は true を返す
38        echo "inTransaction(): " . ($pdo->inTransaction() ? 'true' : 'false') . "\n\n"; // 期待値: true
39
40        // 4. トランザクションをコミット
41        echo "--- commit() を呼び出し ---\n";
42        $pdo->commit();
43        echo "トランザクションがコミットされました。\n";
44        // コミット後、トランザクションは終了しているので、inTransaction() は false を返す
45        echo "inTransaction(): " . ($pdo->inTransaction() ? 'true' : 'false') . "\n\n"; // 期待値: false
46
47        echo "デモンストレーションが正常に完了しました。\n";
48
49    } catch (PDOException $e) {
50        echo "データベースエラーが発生しました: " . $e->getMessage() . "\n";
51        // エラー発生時にトランザクションがアクティブな場合はロールバックします
52        if (isset($pdo) && $pdo->inTransaction()) {
53            echo "トランザクションがアクティブなため、ロールバックします。\n";
54            $pdo->rollBack();
55            echo "ロールバック後の inTransaction(): " . ($pdo->inTransaction() ? 'true' : 'false') . "\n";
56        }
57    } catch (Exception $e) {
58        echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
59    }
60}
61
62// 関数を実行してデモンストレーションを開始
63demonstratePdoInTransaction();
64
65?>

PDO::inTransaction()は、現在のデータベース接続でトランザクションがアクティブであるかどうかを判定するPHPのメソッドです。このメソッドはPDOクラスに属し、引数は不要で、真偽値（bool）を返します。

トランザクションがbeginTransaction()によって開始され、まだcommit()（コミット）またはrollBack()（ロールバック）されていないアクティブな状態である場合はtrueを返します。それ以外の場合、つまりトランザクションが開始されていないか、既に終了している場合はfalseを返します。

サンプルコードでは、この挙動が段階的に示されています。まず、データベースに接続した直後にはトランザクションは開始されていないため、inTransaction()はfalseを返します。次に、beginTransaction()を呼び出してトランザクションを開始すると、メソッドはtrueを返すようになります。この間に行われるデータベース操作中も、トランザクションがアクティブであるためtrueが維持されます。最後に、commit()によってトランザクションが正常にコミットされると、再びfalseに戻ります。

このように、PDO::inTransaction()は、現在のトランザクションの状態を正確に確認したい場合に非常に便利なメソッドです。特に、エラー発生時のロールバック処理など、現在のトランザクション状態に基づいて条件分岐を行う際に活用できます。