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

Copy
1<?php
2
3/**
4 * Pharアーカイブの操作中にエラーが発生するシナリオをシミュレートする関数。
5 * 内部で発生した例外をラップしてPharExceptionをスローすることで、例外チェーンを生成します。
6 */
7function simulatePharOperationFailure(): void
8{
9    try {
10        // Pharアーカイブ処理中に発生する可能性のある、基となる例外をシミュレート
11        // 例: ファイルの読み込みエラー、権限の問題など
12        throw new \RuntimeException("基となるリソースの読み込みに失敗しました。", 100);
13    } catch (\RuntimeException $e) {
14        // 基となるRuntimeExceptionをPharExceptionでラップし、例外チェーンを作成
15        // 第3引数に元の例外を渡すことで、getPrevious()で後から取得できるようになります。
16        throw new \PharException("Pharアーカイブの操作中に予期せぬエラーが発生しました。", 200, $e);
17    }
18}
19
20// メインの実行ブロック
21try {
22    // シミュレート関数を呼び出し、PharExceptionを発生させる
23    simulatePharOperationFailure();
24} catch (\PharException $pharException) {
25    // PharExceptionをキャッチした場合の処理
26    echo "--- PharExceptionをキャッチしました ---\n";
27    echo "メッセージ: " . $pharException->getMessage() . "\n";
28    echo "コード: " . $pharException->getCode() . "\n";
29    echo "発生ファイル: " . $pharException->getFile() . " (行: " . $pharException->getLine() . ")\n\n";
30
31    // getPrevious() メソッドを使用して、例外チェーンの前の例外を取得
32    // 戻り値は Throwable または null になります。
33    $previousException = $pharException->getPrevious();
34
35    if ($previousException !== null) {
36        echo "--- 前の例外 (getPrevious() で取得) ---\n";
37        echo "タイプ: " . get_class($previousException) . "\n";
38        echo "メッセージ: " . $previousException->getMessage() . "\n";
39        echo "コード: " . $previousException->getCode() . "\n";
40        echo "発生ファイル: " . $previousException->getFile() . " (行: " . $previousException->getLine() . ")\n";
41    } else {
42        echo "前の例外は存在しません。\n";
43    }
44} catch (\Exception $e) {
45    // その他の予期せぬ例外をキャッチ
46    echo "--- 予期せぬエラーが発生しました ---\n";
47    echo "メッセージ: " . $e->getMessage() . "\n";
48}

PharException::getPrevious()メソッドは、PHPの例外処理における「例外チェーン」を扱うための重要な機能です。このメソッドは引数を一切取りません。戻り値は?Throwable型で、これは直前に発生し、現在の例外にラップされた例外オブジェクトを返します。もし前の例外が存在しない場合はnullを返します。

サンプルコードでは、まずsimulatePharOperationFailure関数が内部でRuntimeExceptionを発生させます。このRuntimeExceptionは、PharExceptionを新しく生成する際に第3引数として渡され、PharExceptionの内部に「ラップ」されます。この処理によって、RuntimeExceptionとそれをラップしたPharExceptionが紐付けられ、「例外チェーン」が形成されます。

メインの実行ブロックでPharExceptionをキャッチした後、getPrevious()メソッドを呼び出すことで、このラップされた元のRuntimeExceptionオブジェクトを取得しています。これにより、ユーザーはPharExceptionという具体的なエラーだけでなく、その根本的な原因となったRuntimeExceptionの詳細も確認できるようになります。このように、getPrevious()メソッドは、エラーの根本原因を特定し、デバッグを効率的に進めるために非常に役立ちます。