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

Copy
1<?php
2
3/**
4 * PDOのエラーモード設定とエラーハンドリングの例
5 *
6 * システムエンジニアを目指す初心者向けに、PDO::ERRMODE_SILENT と
7 * PDO::ERRMODE_EXCEPTION の動作の違いを示します。
8 *
9 * - PDO::ERRMODE_SILENT: エラー発生時に例外を投げず、手動でのエラーチェックが必要です。
10 * - PDO::ERRMODE_EXCEPTION: エラー発生時にPDOExceptionを投げ、try-catchで処理できます（推奨）。
11 */
12function demonstratePdoErrorModeComparison(): void
13{
14    // SQLite インメモリデータベースを使用し、ファイル作成なしで動作検証します。
15    // 実際のアプリケーションでは、適切なデータベース接続情報を設定してください。
16    $dsn = 'sqlite::memory:';
17    $username = null; // SQLiteインメモリでは通常不要
18    $password = null; // SQLiteインメモリでは通常不要
19
20    echo "--- PDO::ERRMODE_SILENT の動作例 ---\n";
21    try {
22        // PDO::ERRMODE_SILENT を設定した接続を確立します。
23        // このモードでは、データベースエラーが発生してもPDOExceptionは投げられません。
24        $pdoSilent = new PDO($dsn, $username, $password, [
25            PDO::ATTR_ERRMODE => PDO::ERRMODE_SILENT,
26            PDO::ATTR_DEFAULT_FETCH_MODE => PDO::FETCH_ASSOC,
27        ]);
28
29        echo "ERRMODE_SILENT: 存在しないテーブルへのクエリを試行...\n";
30        // 存在しないテーブルへのクエリを実行し、意図的にエラーを発生させます。
31        $stmtSilent = $pdoSilent->query("SELECT * FROM non_existent_table");
32
33        if ($stmtSilent === false) {
34            // ERRMODE_SILENT では、クエリが失敗した場合、query() メソッドは false を返します。
35            // エラーの詳細情報は errorInfo() メソッドで取得する必要があります。
36            $errorInfo = $pdoSilent->errorInfo();
37            echo "ERRMODE_SILENT: エラーを検出しました。\n";
38            echo "ERRMODE_SILENT: エラーコード (SQLSTATE): " . $pdoSilent->errorCode() . "\n";
39            echo "ERRMODE_SILENT: エラーメッセージ: " . $errorInfo[2] . "\n";
40            echo "ERRMODE_SILENT: このモードでは、エラー発生後に明示的に 'errorInfo()' などでエラーを確認する必要があります。\n";
41        } else {
42            echo "ERRMODE_SILENT: クエリ成功（このメッセージは通常表示されません）。\n";
43        }
44
45    } catch (PDOException $e) {
46        // ERRMODE_SILENT の場合、通常クエリ失敗ではここに到達しません。
47        // ここに到達するのは、データベース接続自体に問題があるなどの深刻なエラーの場合です。
48        echo "ERRMODE_SILENT: 予期せぬ接続エラーを捕捉しました: " . $e->getMessage() . "\n";
49    }
50
51    echo "\n--- PDO::ERRMODE_EXCEPTION の動作例 (推奨) ---\n";
52    try {
53        // PDO::ERRMODE_EXCEPTION を設定した接続を確立します。
54        // このモードでは、データベースエラーが発生するとPDOExceptionが投げられます。
55        $pdoException = new PDO($dsn, $username, $password, [
56            PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION, // エラー時にPDOExceptionを投げるモード
57            PDO::ATTR_DEFAULT_FETCH_MODE => PDO::FETCH_ASSOC,
58        ]);
59
60        echo "ERRMODE_EXCEPTION: 存在しないテーブルへのクエリを試行...\n";
61        // 存在しないテーブルへのクエリを実行します。この行でPDOExceptionがスローされます。
62        $pdoException->query("SELECT * FROM non_existent_table");
63        echo "ERRMODE_EXCEPTION: クエリ成功（このメッセージは通常表示されません）。\n";
64
65    } catch (PDOException $e) {
66        // ERRMODE_EXCEPTION の場合、クエリ失敗時にここでPDOExceptionが捕捉されます。
67        // エラー情報は例外オブジェクトから直接取得できます。
68        echo "ERRMODE_EXCEPTION: エラーを捕捉しました: " . $e->getMessage() . "\n";
69        echo "ERRMODE_EXCEPTION: エラーコード (SQLSTATE): " . $e->errorInfo[0] . "\n";
70        echo "ERRMODE_EXCEPTION: エラーメッセージ: " . $e->errorInfo[2] . "\n";
71        echo "ERRMODE_EXCEPTION: このモードは、エラー処理を一元化できるため、ほとんどのアプリケーションで推奨されます。\n";
72    }
73}
74
75// 関数を実行して、各エラーモードの動作を確認します。
76demonstratePdoErrorModeComparison();
77

PDO::ERRMODE_SILENTは、PHPでデータベースを操作するPDOクラスに設定できるエラー処理モードの一つです。この定数自体に引数や戻り値はありません。

このモードを設定すると、SQLの実行中にデータベース関連のエラーが発生しても、PHPは自動的にPDOExceptionという例外をスローしません。代わりに、query()やexec()などのメソッドがエラー時にfalseを返すなどして、開発者が明示的に戻り値をチェックする必要があります。エラーの詳細を確認するには、別途PDO::errorInfo()メソッドを呼び出す必要があります。サンプルコードでは、存在しないテーブルへのクエリ時に例外が発生せず、query()がfalseを返すため、if ($stmtSilent === false)でエラーを検出し、$pdoSilent->errorInfo()で詳細を取得している様子が確認できます。

一方、PDO::ERRMODE_EXCEPTIONというモードでは、データベースエラーが発生すると自動的にPDOExceptionがスローされます。この例外をtry-catchブロックで捕捉することで、エラー処理を一元化し、エラーを見落とすことなく対応できます。サンプルコードでは、同じく存在しないテーブルへのクエリで即座にPDOExceptionがスローされ、catchブロックで処理されているのがわかります。

エラー処理を簡潔にし、エラーの見落としを防ぎやすいため、ほとんどのアプリケーションではPDO::ERRMODE_EXCEPTIONの使用が推奨されています。

Copy
1<?php
2
3/**
4 * PDO::ERRMODE_SILENT の使用方法を実演します。
5 *
6 * ERRMODE_SILENT モードでは、データベースエラーが発生しても PDO は例外をスローしたり、
7 * PHP のエラーを出力したりしません。その代わりに、各データベース操作の後に
8 * PDO::errorCode() と PDO::errorInfo() を使って明示的にエラーをチェックする必要があります。
9 *
10 * このモードはエラーハンドリングを完全に制御できる利点がありますが、
11 * 開発者は戻り値やエラーコードを注意深くチェックする義務があります。
12 *
13 * システムエンジニアを目指す初心者の方へ:
14 * このコードは、PHP が自動的にエラーを報告しない場合に、どのように手動で
15 * データベースのエラーを検出・処理するかを示しています。
16 * 実際には ERRMODE_EXCEPTION (例外をスローするモード) が推奨されることが多いですが、
17 * ERRMODE_SILENT の動作を理解することも重要です。
18 */
19function demonstratePdoErrModeSilent(): void
20{
21    // SQLite のインメモリデータベースに接続するためのDSN (Data Source Name)
22    // 実際のアプリケーションではファイルパスやネットワークアドレスを指定します。
23    $dsn = 'sqlite::memory:';
24    $user = null; // SQLiteインメモリでは不要
25    $password = null; // SQLiteインメモリでは不要
26
27    try {
28        // データベースへのPDO接続を確立
29        $pdo = new PDO($dsn, $user, $password);
30
31        // --- エラーモードを PDO::ERRMODE_SILENT に設定 ---
32        // これがこのデモンストレーションの核心です。
33        // これにより、データベースエラーが発生してもPDOは例外をスローしません。
34        $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_SILENT);
35        echo "PDO エラーモードを ERRMODE_SILENT に設定しました。\n";
36
37        // --- 成功する操作の例 ---
38        echo "\n成功する操作 (テーブル作成) を試行します:\n";
39        $createTableSql = 'CREATE TABLE users (id INTEGER PRIMARY KEY, name TEXT)';
40        // exec() は成功した場合は影響を受けた行数を返し、失敗した場合は false を返します。
41        $result = $pdo->exec($createTableSql);
42
43        if ($result === false) {
44            // ERRMODE_SILENT では、失敗した場合に false が返されるため、明示的にチェックします。
45            $errorCode = $pdo->errorCode();
46            $errorInfo = $pdo->errorInfo(); // エラー情報の配列を取得
47            echo "テーブル作成中にエラーが発生しました (通常は発生しません):\n";
48            echo "エラーコード: " . $errorCode . ", エラーメッセージ: " . $errorInfo[2] . "\n";
49        } else {
50            echo "テーブル 'users' を正常に作成しました。\n";
51        }
52
53        // --- 失敗する操作の例 ---
54        echo "\n失敗する操作 (存在しないテーブルへの INSERT) を試行します:\n";
55        $failingSql = 'INSERT INTO non_existent_table (id, name) VALUES (1, "Alice")';
56        $result = $pdo->exec($failingSql);
57
58        // ERRMODE_SILENT では、この失敗によって例外はスローされません。
59        // $result が false になるので、それを確認してエラーを処理します。
60        if ($result === false) {
61            $errorCode = $pdo->errorCode();
62            $errorInfo = $pdo->errorInfo();
63
64            echo "操作は期待通りに失敗しました (ERRMODE_SILENT が処理しました):\n";
65            echo "エラーコード: " . $errorCode . "\n";
66            echo "エラーメッセージ: " . $errorInfo[2] . "\n"; // エラーメッセージは配列の3番目 (インデックス2)
67        } else {
68            echo "失敗するはずの操作が予期せず成功しました。\n";
69        }
70
71        // --- 別の成功する操作の例 (既存のテーブルへの INSERT) ---
72        echo "\n別の成功する操作 (テーブル 'users' への INSERT) を試行します:\n";
73        $insertSql = 'INSERT INTO users (name) VALUES ("Bob")';
74        $result = $pdo->exec($insertSql);
75
76        if ($result === false) {
77            $errorCode = $pdo->errorCode();
78            $errorInfo = $pdo->errorInfo();
79            echo "ユーザー挿入中にエラーが発生しました:\n";
80            echo "エラーコード: " . $errorCode . ", エラーメッセージ: " . $errorInfo[2] . "\n";
81        } else {
82            echo "ユーザー 'Bob' を正常に挿入しました。影響を受けた行数: " . $result . "\n";
83        }
84
85    } catch (PDOException $e) {
86        // ERRMODE_SILENT はクエリのエラーに対して例外をスローしませんが、
87        // データベース接続自体が失敗した場合は PDOException がスローされます。
88        echo "データベース接続エラー: " . $e->getMessage() . "\n";
89    } catch (Exception $e) {
90        // 予期せぬその他の例外をキャッチします。
91        echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
92    }
93}
94
95// デモンストレーション関数を実行
96demonstratePdoErrModeSilent();

PHPのPDO::ERRMODE_SILENTは、データベース操作中に発生するエラーの処理方法を定義するための定数です。この定数自体に引数や戻り値はありません。PDOオブジェクトのsetAttributeメソッドを通じて設定することで、データベースエラーが発生した場合の挙動を制御します。

このモードを設定すると、SQLの実行中にエラーが発生してもPDOは例外（PDOException）をスローせず、またPHPのエラーも出力しません。その代わりに、エラーが発生したデータベース操作メソッド（例: exec(), query()など）は、通常falseを返します。システムエンジニアを目指す初心者の方は、このfalseという戻り値を明示的にチェックし、エラーが発生したかどうかを判断する必要があります。エラーの詳細な情報は、PDO::errorCode()メソッド（SQLSTATEエラーコードを文字列で返します）やPDO::errorInfo()メソッド（詳細なエラー情報を配列で返します）を呼び出すことで取得できます。

サンプルコードでは、存在しないテーブルへの挿入を試みる失敗する操作を通じて、ERRMODE_SILENTが設定されている場合に例外がスローされず、exec()がfalseを返すこと、そしてerrorCode()とerrorInfo()を使ってエラーの内容を正確に捕捉し表示する方法が具体的に示されています。このモードはエラーハンドリングの自由度が高い反面、開発者がエラーチェックを徹底する責任があるため、多くのアプリケーションでは、エラー時に例外を自動的にスローするPDO::ERRMODE_EXCEPTIONの利用が推奨されることが多いです。しかし、どのような状況でエラーがどのように報告されるかを理解することは、データベースアプリケーション開発において非常に重要です。