【PHP8.x】PDOException::getPrevious()メソッドの使い方

Copy
1<?php
2
3/**
4 * データベース接続処理中に発生した内部エラーをシミュレートし、
5 * そのエラーをPDOExceptionでラップしてスローする関数。
6 * PDOException::getPrevious() メソッドの動作を示すために使用します。
7 */
8function simulateDbConnectionErrorWithPreviousException(): void
9{
10    try {
11        // データベース接続設定の読み込み失敗など、低レベルなエラーを想定して
12        // 例外をスローします。
13        throw new Exception("データベース接続設定ファイルの読み込みに失敗しました。", 1001);
14
15    } catch (Exception $e) {
16        // 上記の低レベルな例外をキャッチし、より上位のPDOExceptionでラップして再スローします。
17        // ここでPDOExceptionの第3引数に$e（前の例外）を渡すのがポイントです。
18        throw new PDOException("データベースへの接続中にエラーが発生しました。", 0, $e);
19    }
20}
21
22// メインの処理
23try {
24    // データベース接続エラーをシミュレートする関数を呼び出します。
25    simulateDbConnectionErrorWithPreviousException();
26} catch (PDOException $e) {
27    // simulateDbConnectionErrorWithPreviousException() 関数からスローされた
28    // PDOException をキャッチします。
29    echo "PDOException が発生しました。\n";
30    echo "メッセージ: " . $e->getMessage() . "\n";
31    echo "コード: " . $e->getCode() . "\n";
32
33    // PDOException::getPrevious() メソッドを使用して、
34    // ラップされた（元の）前の例外を取得します。
35    $previous = $e->getPrevious();
36
37    if ($previous !== null) {
38        echo "\n前の例外 (Previous Exception) の情報:\n";
39        echo "タイプ: " . get_class($previous) . "\n";
40        echo "メッセージ: " . $previous->getMessage() . "\n";
41        echo "コード: " . $previous->getCode() . "\n";
42    } else {
43        echo "\n前の例外はありませんでした。\n";
44    }
45}

PHPのPDOException::getPrevious()メソッドは、例外が別の例外を内包（ラップ）している場合に、その内包されている元の例外オブジェクトを取得するために使用されます。これにより、エラーの根本原因を追跡しやすくなります。このメソッドは引数を一切持ちません。戻り値は?Throwable型で、前の例外が存在すればThrowableオブジェクトを返しますが、存在しない場合はnullを返します。

サンプルコードでは、simulateDbConnectionErrorWithPreviousException関数の中で、まず「データベース接続設定ファイルの読み込み失敗」という低レベルなExceptionを意図的に発生させています。この低レベルな例外をcatchブロックで捕捉した後、「データベースへの接続エラー」という、より上位のPDOExceptionを生成して再スローしています。このPDOExceptionを作成する際に、捕捉した元のExceptionを第3引数として渡すことで、二つの例外を連結（チェーン）させています。

メインのtry-catchブロックでは、この連結されたPDOExceptionをキャッチします。そして、$e->getPrevious()メソッドを呼び出すことで、PDOExceptionに内包されていた元の「データベース接続設定ファイルの読み込み失敗」のExceptionオブジェクトを取得しています。取得した$previousがnullではない場合、その元の例外のタイプ、メッセージ、コードを表示することで、上位の例外だけでなく、その原因となった下位の例外情報まで詳細に確認できることを示しています。これにより、問題解決のデバッグ作業が効率的になります。