【PHP8.x】Pdo\Sqlite::SQLITE_ATTR_EXTENDED_RESULT_CODES定数の使い方

Copy
1<?php
2
3/**
4 * SQLITE_ATTR_EXTENDED_RESULT_CODES の使用例と、
5 * 古い sqlite_escape_string の代替となるプリペアドステートメントによる安全なデータ操作を示す関数。
6 *
7 * PHP 8 環境では sqlite_escape_string は存在せず、
8 * SQLインジェクション対策には PDO のプリペアドステートメントが推奨されます。
9 * この関数は、SQLite データベースへの接続、テーブル作成、
10 * データの挿入および取得を安全に行う方法を示します。
11 */
12function demonstratePdoSqliteSafety(): void
13{
14    // データベース接続情報 (インメモリデータベースを使用)
15    $dsn = 'sqlite::memory:';
16
17    try {
18        // PDO データベース接続を確立
19        // PDO::ATTR_ERRMODE を設定し、エラー発生時に例外をスローするようにします。
20        $pdo = new PDO($dsn);
21        $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
22
23        // SQLITE_ATTR_EXTENDED_RESULT_CODES 定数の設定
24        // この定数を true に設定すると、SQLite の拡張結果コードが有効になります。
25        // 例えば、ON CONFLICT 句などで詳細なエラーコードを取得できるようになります。
26        // 安全なデータ操作（プリペアドステートメント）とは直接関係ありませんが、
27        // PDO SQLite 拡張の機能として設定することができます。
28        $pdo->setAttribute(PDO::SQLITE_ATTR_EXTENDED_RESULT_CODES, true);
29
30        echo "SQLite データベースに接続しました。\n";
31        echo "SQLITE_ATTR_EXTENDED_RESULT_CODES が有効に設定されました。\n\n";
32
33        // テーブルが存在しない場合に作成
34        $pdo->exec("CREATE TABLE IF NOT EXISTS users (
35            id INTEGER PRIMARY KEY AUTOINCREMENT,
36            name TEXT NOT NULL,
37            email TEXT UNIQUE NOT NULL
38        )");
39        echo "users テーブルを作成しました (既に存在する場合はスキップ)。\n\n";
40
41        // 安全なデータの挿入: プリペアドステートメントを使用
42        // これは、古い sqlite_escape_string の代替として推奨される方法です。
43        // ユーザー入力由来の文字列（例: `O'Malley`）を安全に扱えます。
44        $userName = "O'Malley"; // SQLインジェクションのリスクがある文字列を模擬
45        $userEmail = "o.malley@example.com";
46
47        $stmt = $pdo->prepare("INSERT INTO users (name, email) VALUES (:name, :email)");
48        $stmt->bindParam(':name', $userName);
49        $stmt->bindParam(':email', $userEmail);
50        $stmt->execute();
51        echo "ユーザー '{$userName}' を安全に挿入しました。\n\n";
52
53        // 別のユーザーを挿入
54        $anotherName = "John Doe";
55        $anotherEmail = "john.doe@example.com";
56        $stmt->bindParam(':name', $anotherName);
57        $stmt->bindParam(':email', $anotherEmail);
58        $stmt->execute();
59        echo "ユーザー '{$anotherName}' を安全に挿入しました。\n\n";
60
61        // 安全なデータの取得: プリペアドステートメントを使用
62        // 検索条件にユーザー入力を使う場合も、プリペアドステートメントで安全に処理します。
63        $searchName = "O'Malley";
64        $stmt = $pdo->prepare("SELECT id, name, email FROM users WHERE name = :name");
65        $stmt->bindParam(':name', $searchName);
66        $stmt->execute();
67
68        echo "検索結果 (名前: '{$searchName}'):\n";
69        if ($stmt->rowCount() > 0) {
70            while ($row = $stmt->fetch(PDO::FETCH_ASSOC)) {
71                echo "  ID: {$row['id']}, 名前: {$row['name']}, メール: {$row['email']}\n";
72            }
73        } else {
74            echo "  該当するユーザーは見つかりませんでした。\n";
75        }
76        echo "\n";
77
78    } catch (PDOException $e) {
79        // データベース操作中のエラーをキャッチ
80        echo "エラーが発生しました: " . $e->getMessage() . "\n";
81    } finally {
82        // データベース接続を閉じる (PDOはスクリプト終了時に自動的に閉じます)
83        // 明示的にnullを代入することもできます。
84        $pdo = null;
85        echo "データベース接続を閉じました。\n";
86    }
87}
88
89// 関数の実行
90demonstratePdoSqliteSafety();

このサンプルコードは、PHP 8環境でPDO（PHP Data Objects）とSQLiteデータベースを用いて安全にデータ操作を行う方法を示しています。特に、古いsqlite_escape_string関数の代替として推奨される、プリペアドステートメントの利用方法に焦点を当てています。

SQLITE_ATTR_EXTENDED_RESULT_CODESは、PDO SQLite拡張機能で利用できる定数で、データベース接続時にPDO::setAttribute()メソッドを使って設定します。この定数をtrueに設定することで、SQLiteが提供する詳細なエラーコード（拡張結果コード）が有効になり、データベース操作時のエラーハンドリングをより細かく行えるようになります。この定数自体に引数や戻り値はありません。

PHP 8ではsqlite_escape_string関数は存在せず、SQLインジェクション攻撃を防ぐためには、PDOのプリペアドステートメントを使用することが不可欠です。プリペアドステートメントは、SQLクエリの構造とユーザーが入力するデータを分離して処理するため、悪意のある文字列がSQLの一部として実行されるのを効果的に防ぎます。コードでは、安全なデータの挿入（例: O'Malleyのような特殊文字を含む名前）と、検索条件を用いた安全なデータ取得の具体的な手順が示されており、安全なデータベース操作の基本を学ぶことができます。

Copy
1<?php
2
3/**
4 * PHPとSQLiteを使用して、拡張エラーコードを伴うエラー処理をデモンストレーションします。
5 *
6 * SQLITE_ATTR_EXTENDED_RESULT_CODES オプションを有効にすることで、
7 * より詳細なSQLiteのエラー情報を取得できるようになります。
8 *
9 * システムエンジニアを目指す初心者向けに、データベース接続、テーブル作成、
10 * そして意図的なエラー発生とPDOExceptionによるエラー捕捉の基本を示します。
11 */
12function demonstrateExtendedSqliteErrorCodes(): void
13{
14    // データベースファイルのパスを定義します。
15    // スクリプトと同じディレクトリに 'test.db' というファイルが作成されます。
16    $dbPath = __DIR__ . '/test.db';
17
18    // 以前の実行で残ったデータベースファイルがあれば削除し、クリーンな状態で開始します。
19    if (file_exists($dbPath)) {
20        unlink($dbPath);
21    }
22
23    try {
24        // PDO (PHP Data Objects) のオプションを設定します。
25        $options = [
26            // SQLITE_ATTR_EXTENDED_RESULT_CODES を true に設定することで、
27            // SQLiteの拡張エラーコード（例えば、UNIQUE制約違反の詳細など）が有効になります。
28            // これにより、PDO::errorInfo()[1] で返されるエラーコードがより詳細になります。
29            PDO::SQLITE_ATTR_EXTENDED_RESULT_CODES => true,
30
31            // エラー発生時にPDOExceptionをスローするように設定します。
32            // これが初心者にとって最も一般的なエラーハンドリング方法であり、推奨されます。
33            PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION,
34
35            // 結果セットのカラム名を元のケース（データベースに定義された通り）で返すように設定します。
36            PDO::ATTR_DEFAULT_FETCH_MODE => PDO::FETCH_ASSOC,
37        ];
38
39        // SQLiteデータベースに接続します。
40        // DSN (Data Source Name) は 'sqlite:' の後にデータベースファイルのパスを指定します。
41        $pdo = new PDO("sqlite:$dbPath", null, null, $options);
42        echo "データベースに接続しました。\n\n";
43
44        // 'users' テーブルを作成します。
45        // id: 主キー、自動インクリメント
46        // name: テキスト型、NULLを許容しない (NOT NULL)、一意である (UNIQUE)
47        $pdo->exec("
48            CREATE TABLE IF NOT EXISTS users (
49                id INTEGER PRIMARY KEY AUTOINCREMENT,
50                name TEXT NOT NULL UNIQUE
51            )
52        ");
53        echo "users テーブルを作成しました。\n";
54
55        // 正常なデータの挿入
56        $pdo->exec("INSERT INTO users (name) VALUES ('Alice')");
57        echo "データを挿入しました: Alice\n";
58
59        // --- 意図的にエラーを発生させるシナリオ ---
60
61        // 1. UNIQUE制約違反を試みます。
62        echo "\n--- UNIQUE制約違反を試みます ---\n";
63        try {
64            // 'Alice' は既に存在する名前なので、UNIQUE制約に違反します。
65            $pdo->exec("INSERT INTO users (name) VALUES ('Alice')");
66            echo "重複した名前の挿入に成功しました (これは表示されるべきではありません)\n";
67        } catch (PDOException $e) {
68            echo "エラーが発生しました (UNIQUE制約違反):\n";
69            // PDOExceptionから詳細なエラー情報を取得します。
70            // errorInfo() は [SQLSTATE, Driver-specific error code, Driver-specific error message] の配列を返します。
71            $errorInfo = $e->errorInfo;
72            echo "  SQLSTATE: {$errorInfo[0]}\n"; // 標準SQLSTATEコード
73            echo "  ドライバ固有エラーコード: {$errorInfo[1]}\n"; // SQLiteの拡張エラーコード（SQLITE_ATTR_EXTENDED_RESULT_CODES有効時）
74            echo "  ドライバ固有エラーメッセージ: {$errorInfo[2]}\n"; // ドライバからの詳細メッセージ
75            echo "  PDOExceptionメッセージ: {$e->getMessage()}\n"; // PDOExceptionの一般的なメッセージ
76
77            // SQLITE_CONSTRAINT_UNIQUE の拡張エラーコードは 1555 です。
78            // (SQLiteのエラーコードは https://www.sqlite.org/rescode.html で確認できます)
79            if ($errorInfo[1] === 1555) {
80                echo "  (拡張エラーコード 1555 は UNIQUE 制約違反を示します。)\n";
81            }
82        }
83
84        // 2. NOT NULL制約違反を試みます。
85        echo "\n--- NOT NULL制約違反を試みます ---\n";
86        try {
87            // 'name' カラムは NOT NULL に設定されているため、NULLを挿入すると違反します。
88            $pdo->exec("INSERT INTO users (name) VALUES (NULL)");
89            echo "NULL名の挿入に成功しました (これは表示されるべきではありません)\n";
90        } catch (PDOException $e) {
91            echo "エラーが発生しました (NOT NULL制約違反):\n";
92            $errorInfo = $e->errorInfo;
93            echo "  SQLSTATE: {$errorInfo[0]}\n";
94            echo "  ドライバ固有エラーコード: {$errorInfo[1]}\n";
95            echo "  ドライバ固有エラーメッセージ: {$errorInfo[2]}\n";
96            echo "  PDOExceptionメッセージ: {$e->getMessage()}\n";
97
98            // SQLITE_CONSTRAINT_NOTNULL の拡張エラーコードは 1571 です。
99            if ($errorInfo[1] === 1571) {
100                echo "  (拡張エラーコード 1571 は NOT NULL 制約違反を示します。)\n";
101            }
102        }
103
104    } catch (PDOException $e) {
105        // データベース接続自体でエラーが発生した場合（例: ファイルパスが不正、SQLiteドライバが見つからないなど）
106        echo "致命的なデータベースエラー: " . $e->getMessage() . "\n";
107    } finally {
108        // データベース接続を閉じます。
109        // PDOオブジェクトがスコープ外に出ると自動的に閉じられますが、明示的にnullを設定することも可能です。
110        $pdo = null;
111        echo "\nデータベース接続を閉じました。\n";
112    }
113}
114
115// 関数を実行します。
116demonstrateExtendedSqliteErrorCodes();

PHPの定数PDO::SQLITE_ATTR_EXTENDED_RESULT_CODESは、SQLiteデータベースのエラーコードを拡張するための設定です。これをPDO接続オプションでtrueに設定すると、データベース操作時にエラーが発生した場合、PDOExceptionオブジェクトのerrorInfo()メソッドを通じて、標準SQLSTATEコードに加え、UNIQUE制約違反（1555）やNOT NULL制約違反（1571）といった、SQLite固有の具体的なエラー原因を示す詳細なコードを取得できるようになります。

このサンプルコードでは、まずSQLiteデータベースに接続し、UNIQUEおよびNOT NULL制約を持つusersテーブルを作成します。次に、これらの制約に違反するデータ挿入を意図的に行い、try-catchブロックでPDOExceptionを捕捉しています。捕捉した例外からerrorInfo()を用いて、拡張エラーコードを含んだ詳細なエラー情報を表示することで、問題の特定に役立つことを示します。この定数自体に引数や戻り値はありませんが、その設定値がPDOオブジェクトのエラー情報取得挙動を制御する役割を果たします。システムエンジニアを目指す初心者にとって、データベースエラーの効率的な診断とハンドリングを学ぶ上で非常に有用な機能です。