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

Copy
1<?php
2
3/**
4 * LogicExceptionのgetLine()メソッドの使用例を示します。
5 *
6 * この関数は、意図的に例外を発生させ、catchブロックでその例外オブジェクトから
7 * エラーが発生した行番号を取得して表示します。
8 */
9function demonstrateExceptionGetLine(): void
10{
11    try {
12        // プログラムのロジック上、発生すべきではないエラーを意図的にスローします。
13        // getLine() は、この throw new LogicException(...) が書かれている行の
14        // 行番号を返します。
15        throw new LogicException('不正な操作が検出されました。');
16
17        // 例外がスローされたため、この行は実行されません。
18        echo 'この処理は実行されません。';
19    } catch (LogicException $e) {
20        // catchブロックでスローされたLogicExceptionオブジェクトを捕捉します。
21
22        // getLine()メソッドを呼び出して、例外が発生した行番号を取得します。
23        $line = $e->getLine();
24
25        // 取得したエラーメッセージと行番号を出力します。
26        echo "エラーメッセージ: " . $e->getMessage() . "\n";
27        echo "エラーが発生した行番号: " . $line . "\n";
28        echo "エラーが発生したファイル: " . $e->getFile() . "\n";
29    } finally {
30        // finallyブロックは、例外の有無にかかわらず必ず実行されます。
31        echo "処理が完了しました。\n";
32    }
33}
34
35// 関数を実行して結果を確認します。
36demonstrateExceptionGetLine();

LogicExceptionクラスのgetLine()メソッドは、プログラムの実行中に例外がスロー（発生）されたソースコードの行番号を取得するために使用します。このメソッドは引数を取らず、戻り値として行番号を整数(int)で返します。

サンプルコードでは、まずtryブロックの中でthrow new LogicException(...)という記述により、意図的に例外を発生させています。getLine()メソッドが返すのは、まさにこのthrowが書かれた行の番号です。

次に、catchブロックで発生したLogicExceptionオブジェクトを$eという変数で捕捉します。そして、$e->getLine()を呼び出すことで、例外が発生した具体的な行番号を取得し、変数$lineに代入しています。

最後に、取得した行番号をgetMessage()で得られるエラーメッセージやgetFile()で得られるファイル名と共に出力しています。これにより、どのファイルの何行目で、どのようなエラーが起きたのかを正確に把握でき、プログラムのデバッグ作業を効率的に進めることができます。