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

Copy
1<?php
2
3/**
4 * PHP SQLite3 データベース操作のサンプル
5 *
6 * SQLITE3_ASSOC 定数を使用して結果を連想配列で取得し、
7 * SQLインジェクション対策として SQLite3::escapeString を使用して文字列をエスケープする方法を示します。
8 * (キーワードの sqlite_escape_string は PHP 7.0 で削除されたため、現代の代替である SQLite3::escapeString を使用します。)
9 */
10function runSqlite3Example(): void
11{
12    // データベースファイル名
13    $dbFile = 'my_sample_database.db';
14
15    // データベースに接続または新規作成
16    try {
17        $db = new SQLite3($dbFile);
18        $db->enableExceptions(true); // 例外を有効にする
19    } catch (Exception $e) {
20        // 接続に失敗した場合、エラーメッセージを出力して終了
21        die("データベース接続エラー: " . $e->getMessage());
22    }
23
24    echo "データベースに接続しました: {$dbFile}\n";
25
26    // テーブルを作成 (もし存在しなければ)
27    // CREATE TABLE 文は固定文字列で、外部からの入力を含まないためエスケープは不要
28    try {
29        $db->exec('CREATE TABLE IF NOT EXISTS users (
30            id INTEGER PRIMARY KEY AUTOINCREMENT,
31            name TEXT NOT NULL,
32            email TEXT NOT NULL UNIQUE
33        )');
34        echo "テーブル 'users' が作成または既に存在します。\n";
35    } catch (Exception $e) {
36        die("テーブル作成エラー: " . $e->getMessage());
37    }
38
39    // --- データ挿入時のエスケープ処理 ---
40    echo "\n--- データ挿入 ---\n";
41
42    // ユーザーからの入力値を想定 (SQLインジェクションの可能性がある文字列を含む)
43    $userName = "John O'Malley"; // シングルクォートを含む
44    $userEmail = "john.o'malley@example.com"; // シングルクォートを含む
45
46    // SQLインジェクションを防ぐため、入力値をエスケープする
47    // SQLite3::escapeString は安全に文字列をSQLクエリに埋め込むための処理
48    $escapedName = $db->escapeString($userName);
49    $escapedEmail = $db->escapeString($userEmail);
50
51    // エスケープされた値を使用して INSERT 文を構築
52    $insertSql = "INSERT INTO users (name, email) VALUES ('{$escapedName}', '{$escapedEmail}')";
53
54    try {
55        $db->exec($insertSql);
56        echo "データを挿入しました (名前: '{$userName}', メール: '{$userEmail}')\n";
57    } catch (Exception $e) {
58        // UNIQUE 制約違反などで挿入に失敗した場合
59        echo "データの挿入に失敗しました: " . $e->getMessage() . "\n";
60    }
61
62    // --- データ取得と SQLITE3_ASSOC の使用 ---
63    echo "\n--- ユーザー一覧 ---\n";
64
65    // SELECT 文を実行
66    // query() メソッドは SQLite3Result オブジェクトを返す
67    $results = $db->query('SELECT id, name, email FROM users');
68
69    // 結果セットから行をフェッチする
70    // SQLITE3_ASSOC 定数は、結果を連想配列 (キーがカラム名) で取得することを指定
71    // 例: ['id' => 1, 'name' => 'John O\'Malley', 'email' => 'john.o\'malley@example.com']
72    if ($results) {
73        while ($row = $results->fetchArray(SQLITE3_ASSOC)) {
74            echo "ID: {$row['id']}, 名前: {$row['name']}, メール: {$row['email']}\n";
75        }
76    } else {
77        echo "ユーザーデータが見つかりませんでした。\n";
78    }
79
80    // データベース接続を閉じる
81    $db->close();
82    echo "\nデータベース接続を閉じました。\n";
83
84    // (オプション) データベースファイルを削除する場合
85    // この行をコメントアウトすると、次回実行時もデータが残ります。
86    // if (file_exists($dbFile)) {
87    //     unlink($dbFile);
88    //     echo "データベースファイル '{$dbFile}' を削除しました。\n";
89    // }
90}
91
92// サンプル関数を実行
93runSqlite3Example();

このサンプルコードは、PHPでSQLite3データベースを安全かつ効率的に操作する方法を示しています。特に、データの取得方法とセキュリティ対策の二点に焦点を当てています。

まず、データベースからデータを読み込む際、SQLITE3_ASSOC 定数を使用しています。これはSQLite3拡張機能の一部であり、fetchArray メソッドの引数に指定することで、結果の各行を「連想配列」として取得できるようにします。連想配列では、データベースのカラム名が配列のキーとなるため、$row['name'] のように直感的にデータにアクセスできます。SQLITE3_ASSOC は引数を取りませんが、整数値の識別子を返します。

次に、データベースを不正な操作から守るためのセキュリティ対策として、SQLite3::escapeString メソッドが使われています。ユーザーからの入力には、SQLクエリの一部として解釈されてしまう可能性のある特殊文字（例: シングルクォート）が含まれることがあります。これをそのままクエリに含めると、「SQLインジェクション」という脆弱性を引き起こし、意図しないデータの改ざんや漏洩につながる危険があります。SQLite3::escapeString は、指定された文字列内のこれらの特殊文字を安全な形式に変換（エスケープ）し、安全にSQLクエリに埋め込めるようにします。このメソッドはエスケープしたい文字列を引数に取り、エスケープ済みの文字列を返します。以前使われていた sqlite_escape_string はPHP 7.0で削除されており、現在はこの SQLite3 クラスのメソッドが推奨されます。

このサンプルコードは、データベースの接続からテーブル作成、安全なデータ挿入、そして連想配列を使ったデータ取得までの一連のプロセスを通じて、これらの重要な機能を具体的に学ぶことができます。

Copy
1<?php
2
3/**
4 * SQLite3 データベースに接続し、データ操作を行うサンプル関数です。
5 * SQLITE3_ASSOC 定数を使用して結果を連想配列で取得する方法を示します。
6 *
7 * @return void
8 */
9function operateSqliteDatabase(): void
10{
11    // データベースファイルのパスを指定
12    // ファイルが存在しない場合は新規作成されます
13    $dbFile = 'my_database.db';
14    $db = null;
15
16    try {
17        // SQLite3 データベースに接続
18        // 最初の引数はデータベースファイルのパスです
19        $db = new SQLite3($dbFile);
20        echo "データベースに接続しました: " . $dbFile . PHP_EOL;
21
22        // テーブルを作成 (既に存在する場合は何もしない)
23        $createTableSql = "
24            CREATE TABLE IF NOT EXISTS users (
25                id INTEGER PRIMARY KEY AUTOINCREMENT,
26                name TEXT NOT NULL,
27                email TEXT NOT NULL UNIQUE
28            );
29        ";
30        $db->exec($createTableSql);
31        echo "users テーブルの存在を確認し、必要であれば作成しました。" . PHP_EOL;
32
33        // データを挿入 (重複しないように ON CONFLICT IGNORE を使用)
34        $insertSql = "
35            INSERT INTO users (name, email) VALUES
36            ('山田 太郎', 'taro.yamada@example.com'),
37            ('鈴木 花子', 'hanako.suzuki@example.com')
38            ON CONFLICT(email) DO NOTHING;
39        ";
40        $db->exec($insertSql);
41        echo "サンプルデータを挿入しました (既存データはスキップ)。" . PHP_EOL;
42
43        // データを取得
44        $selectSql = "SELECT id, name, email FROM users;";
45        $results = $db->query($selectSql);
46
47        if ($results) {
48            echo PHP_EOL . "--- ユーザーデータ一覧 ---" . PHP_EOL;
49            // fetchArray メソッドに SQLITE3_ASSOC を渡すと、結果が連想配列として取得されます。
50            // キーはカラム名になります。
51            while ($row = $results->fetchArray(SQLITE3_ASSOC)) {
52                echo "ID: " . $row['id'] . ", ";
53                echo "名前: " . $row['name'] . ", ";
54                echo "メール: " . $row['email'] . PHP_EOL;
55            }
56            // 結果セットを解放します
57            $results->finalize();
58        } else {
59            echo "データの取得に失敗しました: " . $db->lastErrorMsg() . PHP_EOL;
60        }
61
62    } catch (Exception $e) {
63        // データベース接続や操作でエラーが発生した場合
64        echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
65    } finally {
66        // データベース接続を閉じる
67        if ($db) {
68            $db->close();
69            echo PHP_EOL . "データベース接続を閉じました。" . PHP_EOL;
70        }
71    }
72}
73
74// 関数を実行
75operateSqliteDatabase();
76
77?>

このサンプルコードは、PHPでSQLite3データベースに接続し、基本的なデータ操作を行う方法を示しています。特に、データベースから取得した結果を、SQLITE3_ASSOC定数を用いて連想配列として処理する流れを解説しています。

SQLITE3_ASSOCは、PHPのSQLite3拡張機能が提供する定数で、データベースクエリの結果を連想配列として取得する際に使用します。この定数自体には引数がなく、内部的には整数値（int）を返しますが、その値によってSQLite3Result::fetchArray()メソッドの挙動が変化します。

コードではまず、new SQLite3()でmy_database.dbというファイルにデータベース接続を確立し、CREATE TABLE IF NOT EXISTS文でusersテーブルを作成後、INSERT文でサンプルデータを挿入しています。

データ取得の部分では、$db->query($selectSql)でSQLクエリを実行し、結果セットを$results変数に保持します。その後、while ($row = $results->fetchArray(SQLITE3_ASSOC)) の箇所でSQLITE3_ASSOC定数が利用されています。これをfetchArrayメソッドの引数として渡すことで、取得される各行のデータ$rowは、テーブルのカラム名（例: 'id'、'name'、'email'）をキーとする連想配列として格納されます。これにより、$row['name']のように、名前でデータにアクセスでき、コードの可読性と保守性が向上します。

最後に、データベース接続は$db->close()で確実に閉じられ、例外処理も適切に記述されています。SQLITE3_ASSOCを用いることで、データベースから取得したデータをアプリケーションで扱いやすい形式に変換できるため、実用的なシステム開発において非常に重要な定数です。