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

Copy
1<?php
2
3/**
4 * PDO::inTransaction() メソッドの動作をデモンストレーションします。
5 * SQLite データベースを使用し、トランザクションの開始、コミット、エラー時のロールバック、
6 * そしてその間での inTransaction() の戻り値の変化を示します。
7 */
8function demonstratePdoInTransaction(): void
9{
10    $dbFile = 'test.sqlite';
11    $dsn = 'sqlite:' . $dbFile;
12    $pdo = null; // PDOオブジェクトを初期化
13
14    try {
15        // 1. SQLiteデータベースに接続します。
16        // データベースファイルが存在しない場合は新規作成されます。
17        $pdo = new PDO($dsn);
18        // エラー発生時に例外をスローするように設定します。
19        $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
20
21        echo "データベース接続成功。\n";
22
23        // テーブルが存在しない場合は作成します。
24        $pdo->exec("CREATE TABLE IF NOT EXISTS users (id INTEGER PRIMARY KEY, name TEXT NOT NULL)");
25        echo "テーブル 'users' の準備完了。\n";
26
27        // トランザクション開始前の状態を確認します。
28        // まだトランザクションは開始されていないため、通常は「非アクティブ」です。
29        echo "トランザクション開始前: " . ($pdo->inTransaction() ? "アクティブ" : "非アクティブ") . "\n";
30
31        // トランザクションを開始します。
32        $pdo->beginTransaction();
33        echo "トランザクション開始。\n";
34
35        // トランザクション開始後の状態を確認します。
36        // beginTransaction() の呼び出しにより「アクティブ」になります。
37        echo "トランザクション開始後: " . ($pdo->inTransaction() ? "アクティブ" : "非アクティブ") . "\n";
38
39        // トランザクション内でSQL操作を実行します。
40        $stmt = $pdo->prepare("INSERT INTO users (name) VALUES (?)");
41        $stmt->execute(['Alice']);
42        echo "ユーザー 'Alice' を挿入 (トランザクション内)。\n";
43
44        $stmt->execute(['Bob']);
45        echo "ユーザー 'Bob' を挿入 (トランザクション内)。\n";
46
47        // トランザクションをコミットします。
48        // ここまでの変更がデータベースに永続的に保存されます。
49        $pdo->commit();
50        echo "トランザクションをコミットしました。\n";
51
52        // トランザクション終了後の状態を確認します。
53        // commit() または rollBack() が呼び出されると「非アクティブ」に戻ります。
54        echo "トランザクション終了後: " . ($pdo->inTransaction() ? "アクティブ" : "非アクティブ") . "\n";
55
56        // コミットされたデータが実際に存在するか確認します。
57        echo "挿入されたデータを検証:\n";
58        foreach ($pdo->query("SELECT id, name FROM users") as $row) {
59            echo "ID: " . $row['id'] . ", Name: " . $row['name'] . "\n";
60        }
61
62    } catch (PDOException $e) {
63        // データベース操作中にエラーが発生した場合
64        echo "エラーが発生しました: " . $e->getMessage() . "\n";
65        // エラー発生時にトランザクションがアクティブな場合はロールバックします。
66        // これにより、トランザクション開始後に行われたすべての変更が取り消されます。
67        if ($pdo && $pdo->inTransaction()) {
68            $pdo->rollBack();
69            echo "エラーによりトランザクションをロールバックしました。\n";
70        }
71    } finally {
72        // クリーンアップ: 作成したデータベースファイルを削除します。
73        if (file_exists($dbFile)) {
74            unlink($dbFile);
75            echo "データベースファイル '{$dbFile}' を削除しました。\n";
76        }
77    }
78}
79
80// デモンストレーション関数を実行します。
81demonstratePdoInTransaction();
82

PHPのPDO::inTransaction()メソッドは、現在データベーストランザクションがアクティブな状態であるかを確認するために使用されます。このメソッドは引数を取らず、戻り値として真偽値（bool）を返します。トランザクションが開始されている場合はtrueを、そうでない場合はfalseを返します。

提供されたサンプルコードでは、まずデータベース接続後、PDO::beginTransaction()を呼び出す前にinTransaction()を実行すると「非アクティブ」を示すfalseが返されます。その後、PDO::beginTransaction()でトランザクションを開始すると、inTransaction()は「アクティブ」を示すtrueを返します。この状態の間にデータベース操作が行われます。

トランザクションがPDO::commit()で正常に完了するか、またはPDO::rollBack()で取り消されると、トランザクションは終了します。この時点で再度inTransaction()を実行すると「非アクティブ」を示すfalseに戻ることが確認できます。また、エラーが発生した場合にトランザクションがアクティブであれば安全にrollBack()を呼び出す判断をする際にも、このメソッドが役立ちます。このように、inTransaction()はトランザクションの状態を正確に把握し、適切なデータベース操作を行うための重要なツールです。