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

Copy
1<?php
2
3/**
4 * PDOのATTR_ERRMODE定数を使用して、エラーハンドリングを設定するサンプルコード。
5 *
6 * ATTR_ERRMODEは、PDOがエラーをどのように報告するかを決定するPDO属性です。
7 * PDO::ERRMODE_EXCEPTIONに設定することで、SQLエラーが発生した際に
8 * PDOExceptionをスローさせ、try-catchブロックでエラーを捕捉しやすくなります。
9 * これは、堅牢なアプリケーション開発において推奨される方法です。
10 */
11function configurePdoErrorMode(): void
12{
13    // SQLiteのインメモリデータベースに接続を試みます。
14    // 実際のアプリケーションでは、ファイルパスを指定するか、別のデータベースを使用します。
15    try {
16        $dsn = 'sqlite::memory:'; // インメモリSQLiteデータベース
17        $pdo = new PDO($dsn);
18
19        // ATTR_ERRMODE属性をPDO::ERRMODE_EXCEPTIONに設定します。
20        // これにより、SQL実行時のエラーがPDOExceptionとしてスローされるようになります。
21        $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
22
23        echo "PDOエラーモードがERRMODE_EXCEPTIONに設定されました。\n";
24
25        // エラーモードが正しく設定されていることを示すために、意図的に無効なSQLを実行します。
26        echo "不正なSQLクエリを実行してエラーハンドリングをデモンストレーションします。\n";
27        try {
28            // 存在しないテーブルに対するINSERT文
29            $pdo->exec("INSERT INTO non_existent_table (id) VALUES (1)");
30            echo "このメッセージが表示されるべきではありません（エラーが発生するはずです）。\n";
31        } catch (PDOException $e) {
32            // PDOExceptionが捕捉され、エラーメッセージが表示されます。
33            echo "PDOExceptionを捕捉しました: " . $e->getMessage() . "\n";
34            echo "エラーコード: " . $e->getCode() . "\n";
35            // 本番環境では、エラーをログに記録し、ユーザーにはより丁寧なメッセージを表示します。
36        }
37
38        echo "ATTR_ERRMODEのデモンストレーションが完了しました。\n";
39
40    } catch (PDOException $e) {
41        // データベース接続自体に失敗した場合の処理
42        echo "データベース接続エラー: " . $e->getMessage() . "\n";
43        // 適切なエラー処理（ログ記録、アプリケーションの終了など）を行います。
44        exit(1);
45    }
46}
47
48// 関数を実行してデモンストレーションを開始します。
49configurePdoErrorMode();

ATTR_ERRMODEは、PHPのPDO拡張機能において、データベース操作中に発生したエラーをどのように報告するかを設定するための属性定数です。この定数はPDOクラスに属し、エラー処理の挙動を制御します。定数であるため、これ自体に引数はなく、戻り値もありません。

サンプルコードでは、このATTR_ERRMODEをPDO::ERRMODE_EXCEPTIONに設定する方法を示しています。PDOオブジェクトのsetAttributeメソッドを使用して、この属性を設定することで、SQLエラーが発生した際にPDOExceptionという例外がスローされるようになります。これにより、アプリケーションはtry-catchブロックを使用してエラーを捕捉し、適切に処理できるようになります。

具体的には、SQLiteのインメモリデータベースに接続した後、$pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);という記述でエラーモードを設定しています。その後、意図的に存在しないテーブルへのクエリを実行し、PDOExceptionが捕捉される様子を実演しています。この例外処理の仕組みは、予期せぬデータベースエラーが発生した場合でも、アプリケーションがクラッシュすることなく、エラーメッセージの表示やログ記録といった適切な対応を行うために非常に重要です。この方法を用いることで、堅牢で信頼性の高いアプリケーションを構築できます。

Copy
1<?php
2
3/**
4 * PDO::ATTR_ERRMODE を設定し、データベースエラーの処理方法を実演するサンプルコード。
5 * PDO_SQLite を使用して、簡単なデータベース接続と操作を行います。
6 * エラーが発生した場合に PDOException がスローされるように設定します。
7 */
8function demonstratePdoErrorMode(): void
9{
10    // SQLite データベースファイルのパスを定義
11    // このファイルはスクリプト実行時に自動的に作成されます。
12    $dbFile = './my_application.db';
13    $dsn = "sqlite:$dbFile";
14
15    try {
16        // 1. データベースに接続
17        // PDO (PHP Data Objects) オブジェクトを作成します。
18        $pdo = new PDO($dsn);
19        echo "データベースに接続しました。\n";
20
21        // 2. エラー処理モードを設定 (PDO::ATTR_ERRMODE)
22        // PDO::ATTR_ERRMODE を PDO::ERRMODE_EXCEPTION に設定します。
23        // これにより、SQL 実行中にエラーが発生した場合、PDOException がスローされます。
24        // デフォルトでは警告 (warning) が発生するだけで、スクリプトが続行される可能性があります。
25        $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
26        echo "エラーモードを PDO::ERRMODE_EXCEPTION に設定しました。\n";
27
28        // 3. 簡単なテーブルを作成
29        // テーブルが存在しない場合のみ作成します。
30        $pdo->exec("CREATE TABLE IF NOT EXISTS users (
31            id INTEGER PRIMARY KEY AUTOINCREMENT,
32            name TEXT NOT NULL,
33            email TEXT UNIQUE NOT NULL
34        );");
35        echo "users テーブルが存在しない場合は作成しました。\n";
36
37        // 4. データを挿入
38        // 準備されたステートメント (prepared statement) を使用してデータを安全に挿入します。
39        // 同じメールアドレスを複数回挿入しようとすると、UNIQUE 制約違反でエラーが発生します。
40        $userName = '山田 太郎';
41        $userEmail = 'taro@example.com';
42        $stmt = $pdo->prepare("INSERT INTO users (name, email) VALUES (:name, :email)");
43        $stmt->execute([':name' => $userName, ':email' => $userEmail]);
44        echo "ユーザー '{$userName}' ({$userEmail}) を挿入しました。\n";
45
46        // (オプション) わざとエラーを発生させる例
47        // ここで同じメールアドレスを再度挿入しようとすると、UNIQUE 制約違反で
48        // PDOException がスローされ、catch ブロックで捕捉されます。
49        // $stmt->execute([':name' => '次郎', ':email' => 'taro@example.com']);
50        // echo "ユーザー '次郎' を挿入しようとしました。\n"; // ここは実行されない
51
52        // 5. データを取得して表示
53        $stmt = $pdo->query("SELECT id, name, email FROM users");
54        echo "--- 現在のユーザー一覧 ---\n";
55        while ($row = $stmt->fetch(PDO::FETCH_ASSOC)) {
56            echo "ID: {$row['id']}, 名前: {$row['name']}, メール: {$row['email']}\n";
57        }
58        echo "-----------------------\n";
59
60    } catch (PDOException $e) {
61        // PDOException を捕捉し、データベースエラーを処理します。
62        // ATTR_ERRMODE が PDO::ERRMODE_EXCEPTION に設定されているため、
63        // ここで SQL エラーが捕捉されます。
64        echo "データベースエラーが発生しました: " . $e->getMessage() . "\n";
65        // 実際のシステムでは、エラーログへの記録やユーザーへの適切なメッセージ表示を行います。
66    } catch (Exception $e) {
67        // その他の予期せぬエラーを捕捉します。
68        echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
69    } finally {
70        // データベース接続を閉じる (PDO はスクリプト終了時に自動的に閉じますが、明示的に null を代入することも可能です)
71        $pdo = null;
72        // データベースファイルを削除する場合 (デモ目的で毎回クリーンな状態にしたい場合)
73        // if (file_exists($dbFile)) {
74        //     unlink($dbFile);
75        //     echo "データベースファイルを削除しました。\n";
76        // }
77    }
78}
79
80// 関数を実行してデモンストレーションを開始
81demonstratePdoErrorMode();

このPHPサンプルコードは、データベース操作におけるエラー処理方法を制御するPDO::ATTR_ERRMODE定数の使い方を実演しています。PDO::ATTR_ERRMODEは、PHPのPDO（PHP Data Objects）機能で使用される特別な定数の一つで、データベース操作中にエラーが発生した際の挙動を定義するために利用されます。この定数自体は引数を持たず、値を返しませんが、PDO::setAttribute()メソッドの第一引数として利用することで、PDOオブジェクトの振る舞いを細かく設定できます。

サンプルコードでは、PDO::setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION)と設定しています。この設定により、データベースへのSQL実行中にエラーが発生した場合、PHPが自動的にPDOExceptionという例外を発生させるようになります。これにより、開発者はtry...catchブロックを使用してデータベースエラーを確実に捕捉し、安全かつ柔軟なエラー処理を実装できます。例えば、重複データの挿入によるユニーク制約違反などが発生した際に、スクリプトが予期せず終了するのではなく、エラーメッセージの表示やログ記録といった適切な処理を行うことが可能になります。この設定がない場合、エラーは警告として扱われ、スクリプトが続行される可能性があるため、エラーの見落としにつながる恐れがあります。