【PHP8.x】dom\domexception::getLine()メソッドの使い方

Copy
1<?php
2
3/**
4 * DOMDocument::loadXML メソッドで意図的に DOMException を発生させ、
5 * その例外から発生行番号を取得する例を示します。
6 *
7 * システムエンジニアを目指す初心者向けに、簡潔かつ分かりやすく記述されています。
8 */
9function demonstrateDomExceptionGetLine(): void
10{
11    // PHP の内部エラーハンドリングを有効にし、
12    // XML パースエラーを警告ではなく DOMException としてスローするように設定します。
13    // これを設定しない場合、DOMDocument::loadXML は警告を出し、false を返すだけになります。
14    libxml_use_internal_errors(true);
15
16    // 意図的に不正な XML 文字列を作成します。
17    // <item2> タグが閉じられていないため、XML として無効です。
18    $invalidXmlString = <<<XML
19    <root>
20        <item>Value 1</item>
21        <item2>Value 2</item2
22    </root>
23    XML;
24
25    try {
26        $dom = new DOMDocument();
27        // loadXML は不正な XML をパースしようとすると DOMException をスローします。
28        // このコードブロックにおける、DOMException がスローされる可能性がある行です。
29        $dom->loadXML($invalidXmlString); // <--- この行で DOMException が発生する可能性が高い
30
31        echo "XMLが正常にロードされました。\n"; // この行は実行されません
32    } catch (DOMException $e) {
33        // DOMException を捕捉します。
34        echo "DOMException が捕捉されました！\n";
35        echo "エラーメッセージ: " . $e->getMessage() . "\n";
36        // getLine() メソッドを使って、例外が発生したソースコードの行番号を取得します。
37        // これは、上記 $dom->loadXML(...) の呼び出しが行われているPHPファイルの行番号を示します。
38        echo "例外が発生したPHPファイルの行番号: " . $e->getLine() . "\n";
39    } finally {
40        // 処理の終了後、libxml のエラーハンドリング設定を元に戻すことが推奨されます。
41        libxml_use_internal_errors(false);
42    }
43
44    echo "\nスクリプトの実行を終了しました。\n";
45}
46
47// サンプル関数を実行します。
48demonstrateDomExceptionGetLine();

PHPのDOMExceptionクラスが持つgetLineメソッドは、XML処理などで発生したDOM関連のエラーが、PHPスクリプトのどの行で起きたかを正確に知るために使用されます。このメソッドは引数を必要とせず、例外が発生したPHPファイルの行番号を整数値（int）として返します。

提示されたサンプルコードでは、まずlibxml_use_internal_errors(true)を設定することで、通常は警告となる不正なXMLのパースエラーをDOMExceptionとして捕捉できるようにしています。意図的に閉じタグが欠けた不正なXML文字列を用意し、DOMDocument::loadXMLメソッドで読み込もうとすると、DOMExceptionがスローされます。

この例外はtry-catchブロックのcatch部分で捕捉され、その中で$e->getLine()を呼び出しています。これにより、DOMDocument::loadXMLが実行された、PHPスクリプト内の具体的な行番号が出力されます。システムエンジニアを目指す方にとって、エラーが発生した正確な位置を特定できるgetLineメソッドは、デバッグ作業を効率化し、問題解決の時間を短縮するための非常に重要なツールとなります。finallyブロックでは、エラーハンドリング設定を元に戻すことで、他の処理に影響を与えないように配慮しています。