【PHP8.x】getPreviousメソッドの使い方

Copy
1<?php
2
3/**
4 * この関数は、内部的な処理の失敗を模倣し、RuntimeExceptionをスローします。
5 * これは後でDOMExceptionにラップされる、元の例外となります。
6 */
7function performInternalOperation(): void
8{
9    // 実際には、ファイルの読み込み失敗やデータベース接続エラーなど、
10    // DOMとは直接関係ないが、DOM操作に影響を与える可能性のあるエラーを想定します。
11    throw new RuntimeException("設定ファイルの読み込みに失敗しました。");
12}
13
14/**
15 * この関数は、DOM操作を実行しようとしますが、内部エラーをDOMExceptionとして再スローします。
16 * 元の例外はDOMExceptionの「前の例外」として設定されます。
17 */
18function performDomOperationSafely(): void
19{
20    try {
21        // DOM操作の一部として実行される内部処理を呼び出す
22        // ここで失敗するとRuntimeExceptionがスローされます。
23        performInternalOperation();
24
25        // 実際のDOM操作の例（ここでは実行されません）:
26        // $dom = new DOMDocument();
27        // $dom->loadXML('<invalid xml>'); // これ自体がDOMExceptionをスローする可能性もあります
28
29    } catch (RuntimeException $e) {
30        // 内部で発生したRuntimeExceptionをキャッチし、
31        // それを「前の例外」としてDOMExceptionにラップして再スローします。
32        // DOMExceptionのコンストラクタは (string $message, int $code, ?Throwable $previous = null)
33        throw new DOMException(
34            "DOM操作中に内部エラーが発生しました。",
35            1001, // カスタムエラーコード
36            $e     // ここで前の例外を渡します
37        );
38    }
39}
40
41// メインの実行ブロック
42try {
43    // DOM操作を試みます
44    performDomOperationSafely();
45} catch (DOMException $e) {
46    // DOMExceptionをキャッチした場合
47    echo "--- DOMExceptionをキャッチしました ---\n";
48    echo "メッセージ: " . $e->getMessage() . "\n";
49    echo "コード: " . $e->getCode() . "\n";
50    echo "ファイル: " . $e->getFile() . " (行: " . $e->getLine() . ")\n";
51
52    // getPrevious() メソッドを使用して、このDOMExceptionがラップしている
53    // 前の例外（元の例外）を取得します。
54    $previousException = $e->getPrevious();
55
56    if ($previousException !== null) {
57        echo "\n--- 前の例外 (getPrevious() で取得) ---\n";
58        echo "タイプ: " . get_class($previousException) . "\n";
59        echo "メッセージ: " . $previousException->getMessage() . "\n";
60        echo "ファイル: " . $previousException->getFile() . " (行: " . $previousException->getLine() . ")\n";
61    } else {
62        echo "\nこのDOMExceptionには前の例外がありませんでした。\n";
63    }
64} catch (Throwable $e) {
65    // DOMException以外の予期せぬ例外をキャッチ
66    echo "予期せぬ例外をキャッチしました: " . $e->getMessage() . "\n";
67}
68

DOMException::getPrevious()メソッドは、PHPの例外処理において、関連する例外の原因を追跡するために使用されるメソッドです。PHPでは、ある例外が発生したときに、その例外を捕捉し、それを原因として新しい例外を再スローする「例外のチェイン（連結）」という仕組みがあります。例えば、データベースエラーが原因でDOM操作が失敗した場合、データベースエラーをDOMExceptionの中に含めてスローすることができます。

このメソッドは引数をとりません。戻り値は「前の例外」を表すThrowableオブジェクト、または前の例外が存在しない場合はnullです。DOMExceptionのコンストラクタの第3引数にThrowableオブジェクトを渡すことで、前の例外を設定できます。getPrevious()メソッドは、このように連結された例外のうち、現在の例外の「前の例外」（つまり、この例外を引き起こした元の例外）を取得するために使用されます。

提供されたサンプルコードでは、まずperformInternalOperation関数がRuntimeExceptionをスローし、これが「元の例外」となります。次に、performDomOperationSafely関数がこのRuntimeExceptionをキャッチし、それを新しいDOMExceptionにラップして再スローしています。この際、DOMExceptionのコンストラクタにRuntimeExceptionを渡すことで、両者が連結されます。メインのtry-catchブロックでDOMExceptionをキャッチした後、getPrevious()メソッドを呼び出すことで、DOM操作の失敗の根源となった元のRuntimeExceptionの情報を取得し、表示しています。これにより、複雑なシステムでもエラーの根本原因を効率的に特定することが可能になります。