【PHP8.x】CREATE_TRIGGER定数の使い方

Copy
1<?php
2
3/**
4 * SQLite3::CREATE_TRIGGER 定数の値と、それに関連するSQLiteトリガーの作成方法をデモンストレーションします。
5 * この定数は、ユーザー定義関数がトリガー内で使用される意図があることを示すためのフラグとして用いられます。
6 *
7 * Demonstrates the value of the SQLite3::CREATE_TRIGGER constant and how to create
8 * an SQLite trigger. This constant is used as a flag to indicate that a
9 * user-defined function is intended for use within a trigger.
10 */
11function demonstrateSqliteTriggerConstant(): void
12{
13    // 1. SQLite3 データベースをオープン（メモリ上で一時的に作成）
14    // Opens an SQLite3 database (in-memory for a temporary database).
15    $db = new SQLite3(':memory:');
16
17    if (!$db) {
18        echo "データベースを開けませんでした。\n";
19        return;
20    }
21
22    // SQLite3::CREATE_TRIGGER 定数の値を出力
23    // Outputs the integer value of the SQLite3::CREATE_TRIGGER constant.
24    echo "SQLite3::CREATE_TRIGGER の値: " . SQLite3::CREATE_TRIGGER . "\n\n";
25
26    // 2. サンプルテーブルを作成
27    // Creates a sample table named 'products'.
28    $db->exec('CREATE TABLE IF NOT EXISTS products (
29        id INTEGER PRIMARY KEY AUTOINCREMENT,
30        name TEXT NOT NULL,
31        price REAL NOT NULL
32    )');
33    echo "テーブル 'products' を作成しました。\n";
34
35    // 3. ユーザー定義関数を登録
36    // この関数はトリガー内で呼び出されることを想定しており、
37    // SQLite3::CREATE_TRIGGER フラグは、その関数の使用意図を示すために createFunction() に渡されます。
38    // Registers a user-defined function 'log_change'.
39    // This function is intended to be called within a trigger.
40    // The SQLite3::CREATE_TRIGGER flag is passed to createFunction() to indicate this intent.
41    $db->createFunction(
42        'log_change', // SQLで使用する関数名
43        function (int $product_id, float $old_price, float $new_price): bool {
44            // ここで、商品の価格変更をログに記録するなどの処理を行うことができます。
45            // In a real application, you would typically log this to a file or a dedicated log table.
46            echo sprintf(
47                "トリガー発動: Product ID %d の価格が %.2f から %.2f に変更されました。\n",
48                $product_id,
49                $old_price,
50                $new_price
51            );
52            return true; // 処理が成功したことを示す
53        },
54        3, // 関数の引数の数
55        SQLite3::CREATE_TRIGGER // この関数がトリガー内で使用されることを示すフラグ
56    );
57    echo "ユーザー定義関数 'log_change' を登録しました。\n";
58
59    // 4. トリガーを作成
60    // トリガーはSQL文を使って作成され、SQLite3::exec() メソッドで実行します。
61    // 'product_price_update' トリガーは、'products' テーブルの 'price' カラムが更新された後に発動し、
62    // 登録したユーザー定義関数 'log_change' を呼び出します。
63    // Creates a trigger using a standard SQL statement executed via SQLite3::exec().
64    // The 'product_price_update' trigger fires AFTER an update to the 'price' column
65    // in the 'products' table, calling the user-defined 'log_change' function.
66    $db->exec('
67        CREATE TRIGGER IF NOT EXISTS product_price_update
68        AFTER UPDATE OF price ON products
69        FOR EACH ROW
70        WHEN NEW.price <> OLD.price
71        BEGIN
72            SELECT log_change(OLD.id, OLD.price, NEW.price);
73        END;
74    ');
75    echo "トリガー 'product_price_update' を作成しました。\n\n";
76
77    // 5. データ挿入と更新でトリガーをテスト
78    // Insert initial data into the 'products' table.
79    $db->exec("INSERT INTO products (name, price) VALUES ('Laptop', 1200.00)");
80    echo "製品 'Laptop' を挿入しました。\n";
81    $db->exec("INSERT INTO products (name, price) VALUES ('Mouse', 25.00)");
82    echo "製品 'Mouse' を挿入しました。\n";
83    $db->exec("INSERT INTO products (name, price) VALUES ('Keyboard', 75.00)");
84    echo "製品 'Keyboard' を挿入しました。\n\n";
85
86    // データの更新を行い、トリガーを意図的に発動させます。
87    // Updates product prices to fire the trigger.
88    echo "製品の価格を更新します...\n";
89    $db->exec("UPDATE products SET price = 1250.00 WHERE name = 'Laptop'"); // 価格変更あり -> トリガー発動
90    $db->exec("UPDATE products SET price = 30.00 WHERE name = 'Mouse'");    // 価格変更あり -> トリガー発動
91    $db->exec("UPDATE products SET price = 75.00 WHERE name = 'Keyboard'"); // 価格変更なし (WHEN条件で除外) -> トリガーは発動しない
92    echo "\n製品の価格更新が完了しました。\n";
93
94    // データベース接続をクローズ
95    // Closes the database connection.
96    $db->close();
97}
98
99// 関数を実行してデモンストレーションを開始
100// Executes the function to start the demonstration.
101demonstrateSqliteTriggerConstant();

SQLite3::CREATE_TRIGGERは、PHPでSQLiteデータベースを扱う際に、登録するユーザー定義関数がデータベースのトリガー内で使用されることを示すための定数です。この定数の値は整数型であり、SQLite3::createFunction()メソッドの引数として渡すことで、関数の利用意図を明確にします。

サンプルコードでは、まず一時的なSQLiteデータベースを開き、この定数の具体的な値を出力しています。次に、productsというサンプルテーブルを作成した後、商品の価格変更を記録するlog_changeというユーザー定義関数を登録します。この際、SQLite3::CREATE_TRIGGERをフラグとして渡すことで、log_change関数がトリガー内で呼び出されることを示しています。その後、product_price_updateというトリガーを定義し、productsテーブルのpriceカラムが更新された場合に、登録したlog_change関数が古い価格と新しい価格を引数として自動的に実行されるように設定しています。最後に、データを挿入し、価格を更新することで、実際にトリガーが発動し、ユーザー定義関数による出力が行われる一連の流れを確認することができます。これにより、データベースのイベントに応じてカスタム処理を自動実行する方法を理解できます。