【PHP8.x】PDO::ERRMODE_EXCEPTION定数の使い方

Copy
1<?php
2
3/**
4 * PDO::ERRMODE_EXCEPTION の使用例
5 *
6 * PDO 接続時のエラーモードを例外発生に設定し、SQL実行エラー時に
7 * PDOException がスローされることをシステムエンジニアを目指す初心者にも
8 * わかりやすく示します。
9 */
10function demonstratePdoErrModeException(): void
11{
12    // SQLite のインメモリデータベースを使用し、PDO接続を確立します。
13    // 実際の本番環境では、'mysql:host=localhost;dbname=testdb', 'user', 'password'
14    // のように、実際のデータベースの接続情報を指定します。
15    $dsn = 'sqlite::memory:';
16    $user = null; // SQLiteインメモリではユーザーは不要
17    $password = null; // SQLiteインメモリではパスワードは不要
18
19    try {
20        // PDOオブジェクトを作成し、データベースに接続します。
21        $pdo = new PDO($dsn, $user, $password);
22
23        // PDOのエラーモードを例外をスローするように設定します。
24        // これが PDO::ERRMODE_EXCEPTION の核心です。
25        // この設定により、SQLエラーが発生した場合に PDOException が捕捉可能になります。
26        $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
27
28        echo "PDO::ERRMODE_EXCEPTION が設定されました。\n\n";
29
30        // --- 成功するSQLクエリの例 ---
31        echo "✔ 有効なSQLクエリを実行します (テーブル 'users' を作成)。\n";
32        $pdo->exec("CREATE TABLE users (id INTEGER PRIMARY KEY, name TEXT)");
33        echo "   テーブル 'users' が正常に作成されました。\n\n";
34
35        // --- 失敗するSQLクエリの例 (例外が発生する) ---
36        echo "❌ 存在しないテーブル 'products' への挿入を試みます。\n";
37        echo "   この操作はエラーとなり、PDOException がスローされるはずです。\n\n";
38
39        // 'products' テーブルは存在しないため、SQLSTATE '42S02' のエラーが発生します。
40        // ERRMODE_EXCEPTION の設定により、この時点で PDOException がスローされ、
41        // 処理は catch ブロックにジャンプします。
42        $stmt = $pdo->prepare("INSERT INTO products (name) VALUES (?)");
43        $stmt->execute(['テスト商品']);
44
45        // 上記の`execute`で例外が発生するため、このメッセージは表示されません。
46        echo "このメッセージは表示されません。\n";
47
48    } catch (PDOException $e) {
49        // PDO::ERRMODE_EXCEPTION を設定しているため、SQLエラーは
50        // PDOException オブジェクトとして捕捉されます。
51        echo "--- PDOException が捕捉されました！ ---\n";
52        echo "エラーメッセージ: " . $e->getMessage() . "\n";
53        echo "SQLSTATEコード: " . $e->errorInfo[0] . "\n"; // 例: '42S02' (no such table)
54        echo "ドライバ固有のエラーコード: " . $e->errorInfo[1] . "\n";
55        echo "ドライバ固有のエラーメッセージ: " . $e->errorInfo[2] . "\n";
56    } catch (Exception $e) {
57        // PDOException 以外の予期せぬ一般的な例外を捕捉します。
58        echo "--- 予期せぬエラーが発生しました --- \n";
59        echo "エラーメッセージ: " . $e->getMessage() . "\n";
60    }
61
62    echo "\n処理が終了しました。\n";
63}
64
65// 関数を実行します。
66demonstratePdoErrModeException();

PHPのPDO::ERRMODE_EXCEPTIONは、データベースを操作するPDOクラスに属する定数の一つです。この定数自体は引数を取らず、内部的には整数値（int）として定義されています。その役割は、PDOでデータベース操作中にエラーが発生した場合に、PHPが「PDOException」という特別なエラー（例外）を発生させるよう設定することです。

サンプルコードでは、まずPDOオブジェクトを作成しデータベースに接続した後、$pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);という記述で、このエラーモードを設定しています。これにより、以降のデータベース操作でSQLエラーなどの問題が発生すると、通常の警告表示ではなく、PDOExceptionが自動的にスローされるようになります。

具体的には、存在しないテーブルへのデータ挿入を試みる誤ったSQLクエリを実行すると、この設定によってPDOExceptionが発生し、プログラムのcatch (PDOException $e)ブロックでその例外を捕捉できます。例外を捕捉することで、エラーメッセージやSQLSTATEコードなどの詳細な情報を取得し、予期せぬエラーでプログラムが停止するのを防ぎながら、より柔軟で堅牢なエラー処理を実装することが可能になります。

Copy
1<?php
2
3/**
4 * PDO::ERRMODE_EXCEPTION を使用して、データベースエラーを例外として処理するサンプルコード
5 *
6 * この定数は、PDO がデータベース操作中にエラーを検出した場合に、
7 * PDOException をスローするように設定するために使われます。
8 * これにより、エラーハンドリングを一元的に行い、コードの可読性と堅牢性を高めることができます。
9 */
10
11// データベース接続情報 (ここではSQLiteのインメモリデータベースを使用)
12// 実際のアプリケーションでは、MySQLやPostgreSQLなどの接続情報を設定します。
13$dsn = 'sqlite::memory:';
14
15try {
16    // 1. PDO オブジェクトを生成し、データベースに接続
17    // 新しいPDOオブジェクトを作成する際に、例外モードを設定することも可能ですが、
18    // ここでは setAttribute() を使用して明示的に設定する例を示します。
19    $pdo = new PDO($dsn);
20
21    // 2. PDO::ATTR_ERRMODE 属性を PDO::ERRMODE_EXCEPTION に設定
22    // これにより、SQLエラーが発生した際に PDOException がスローされるようになります。
23    $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
24    echo "データベースに接続し、エラーモードを例外に設定しました。\n";
25
26    // 3. サンプルのテーブルを作成 (成功するクエリ)
27    $pdo->exec("CREATE TABLE users (id INTEGER PRIMARY KEY, name TEXT)");
28    echo "テーブル 'users' を作成しました。\n";
29
30    // 4. 不正なSQLクエリを実行し、意図的にエラーを発生させる
31    // 存在しないテーブルからの選択を試みます。
32    echo "存在しないテーブルからデータを取得しようとします...\n";
33    $pdo->query("SELECT * FROM non_existent_table");
34
35    // 上のquery()が成功した場合 (通常はありえない)
36    echo "このメッセージが表示されることはありません。\n";
37
38} catch (PDOException $e) {
39    // 5. PDOException をキャッチしてエラーを処理
40    // ERRMODE_EXCEPTION の設定により、データベースエラーがここに捕捉されます。
41    echo "データベースエラーが発生しました！\n";
42    echo "エラーメッセージ: " . $e->getMessage() . "\n";
43    echo "エラーコード: " . $e->getCode() . "\n";
44} catch (Exception $e) {
45    // その他の予期しない例外をキャッチ
46    echo "予期せぬエラーが発生しました！\n";
47    echo "エラーメッセージ: " . $e->getMessage() . "\n";
48}
49
50echo "スクリプトの実行が終了しました。\n";
51
52?>

PDO::ERRMODE_EXCEPTIONは、PHPのデータベース接続を扱うPDO（PHP Data Objects）において、データベース操作中にエラーが発生した場合の挙動を「例外として処理する」ように設定するための定数です。この定数自体は引数を持たず、内部的に整数値（int）を返します。

サンプルコードでは、まずPDOオブジェクトを生成し、SQLiteのインメモリデータベースに接続しています。接続後、$pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);という行で、エラーモードを明示的にPDO::ERRMODE_EXCEPTIONに設定しています。これにより、以降のデータベース操作でSQLエラーが発生すると、PDOExceptionという例外が自動的にスローされるようになります。

その後、存在しないテーブルに対してSELECTクエリを実行することで、意図的にデータベースエラーを発生させています。このエラーは、事前に設定したPDO::ERRMODE_EXCEPTIONによってPDOExceptionとして捕捉され、try-catchブロック内の処理でエラーメッセージやコードが表示されます。この設定を利用することで、データベースエラーの検出と処理を一元化し、プログラムの安定性を高めることができます。