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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 意図的に例外を発生させ、その行番号を取得するサンプルクラス。
7 */
8class ExceptionLineReporter
9{
10    /**
11     * ファイル処理をシミュレートし、エラーを発生させます。
12     *
13     * @param string $filename 処理対象のファイル名
14     * @throws RuntimeException ファイルが存在しない場合にスローされます
15     */
16    public function process(string $filename): void
17    {
18        // ファイルが存在しないという状況を仮定します
19        $fileExists = false;
20
21        if (!$fileExists) {
22            // 例外をスローします。getLine()はこの行の番号を返します。
23            throw new RuntimeException("ファイル '{$filename}' の処理に失敗しました。");
24        }
25
26        // 成功した場合の処理（このコードは実行されません）
27        echo "ファイル '{$filename}' の処理が完了しました。\n";
28    }
29}
30
31// メインの実行ブロック
32try {
33    $reporter = new ExceptionLineReporter();
34    // 存在しないファイルを指定して、意図的に例外を発生させる
35    $reporter->process('dummy_data.csv');
36} catch (RuntimeException $e) {
37    // catchブロックで例外を捕捉します
38    echo "エラーを捕捉しました。\n";
39
40    // getLine()メソッドを使い、例外がスローされた行番号を取得して表示します
41    echo "例外が発生した行番号: " . $e->getLine() . "\n";
42    echo "メッセージ: " . $e->getMessage() . "\n";
43}

RuntimeExceptionクラスのgetLine()メソッドは、プログラムの実行中に例外がスロー（発生）されたソースコードの行番号を取得するためのものです。このメソッドは、PHPの基本的な例外クラスであるExceptionから継承されているため、RuntimeExceptionだけでなく多くの例外クラスで使用できます。

このメソッドに引数は必要ありません。戻り値として、例外がthrowされた箇所の行番号を整数(int)で返します。

サンプルコードでは、processメソッドの中で意図的にRuntimeExceptionをthrowしています。メインの実行ブロックではtryの中でこのメソッドを呼び出し、発生した例外をcatchで捕捉しています。catchブロック内で、捕捉した例外オブジェクト（変数$e）に対して$e->getLine()を実行すると、throw new RuntimeException(...)と書かれた行の番号が取得できます。この番号を出力することで、エラーの発生源を正確に知ることができます。

このようにgetLine()は、エラーが発生した場所を特定する上で非常に重要な役割を果たし、プログラムの問題解決（デバッグ）を効率的に進めるために役立ちます。