【PHP8.x】RuntimeException::lineプロパティの使い方

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * エラー発生時に、その行番号を含む情報をJSON形式で送信（出力）するクラス
7 */
8class ErrorReporter
9{
10    /**
11     * データ送信を試み、失敗した場合はエラー情報を送信（出力）する
12     *
13     * @param array $data 送信するデータ
14     * @return void
15     */
16    public function sendData(array $data): void
17    {
18        try {
19            // データが空かどうかをチェック
20            if (empty($data)) {
21                // 条件を満たさない場合、実行時例外をスローする
22                // この行の番号が記録される
23                throw new RuntimeException('送信データが空のため処理を中断しました。');
24            }
25
26            // 実際のデータ送信処理（このサンプルでは成功メッセージを出力）
27            echo "データは正常に送信されました。\n";
28
29        } catch (RuntimeException $e) {
30            // 例外をキャッチし、エラー情報を構築する
31            $errorDetails = [
32                'error' => 'データ送信に失敗しました。',
33                'message' => $e->getMessage(),
34                'file' => $e->getFile(),
35                'line' => $e->getLine(), // getLine()で例外が発生した行番号を取得
36            ];
37
38            // エラー情報をJSON形式で「送信」する（この例ではHTTPレスポンスとして出力）
39            // ログファイルや外部サービスに送信する処理に置き換えることも可能
40            header('Content-Type: application/json; charset=utf-8');
41            http_response_code(500); // サーバーエラーを示すステータスコード
42            echo json_encode($errorDetails, JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT);
43        }
44    }
45}
46
47// クラスのインスタンスを作成
48$reporter = new ErrorReporter();
49
50// 空のデータを渡して、意図的にエラーを発生させる
51$reporter->sendData([]);
52

このPHPサンプルコードは、例外が発生したコードの行番号を取得し、エラー情報として送信（出力）する方法を示しています。中心となるのは、RuntimeExceptionオブジェクトが持つgetLine()メソッドです。このメソッドは引数を取らず、例外がスローされた行番号を整数(int)で返します。

コードでは、sendDataメソッドに空の配列を渡すことで、意図的にthrow new RuntimeException()を実行させています。この処理はtry...catchブロックで囲まれており、発生した例外は$eという変数で捕捉されます。

catchブロック内では、$e->getLine()を呼び出すことで、例外がthrowされた具体的な行番号を取得しています。取得した行番号は、getMessage()で得られるエラーメッセージやgetFile()で得られるファイル名などの情報と共に連想配列にまとめられます。最後に、このエラー情報がjson_encode()によってJSON形式に変換され、HTTPレスポンスとして「送信」されます。このようにgetLine()を活用することで、開発者はエラーの発生箇所を正確に特定でき、迅速なデバッグに繋がります。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 外部データソースとの連携をシミュレートし、エラーを発生させるクラス
7 */
8class DataConnector
9{
10    /**
11     * データを取得するメソッド
12     * 連携に失敗した場合、RuntimeExceptionをスローします。
13     *
14     * @param bool $simulateFailure 意図的に失敗させる場合はtrue
15     * @return string 成功メッセージ
16     * @throws RuntimeException 連携に失敗した場合
17     */
18    public function fetchData(bool $simulateFailure): string
19    {
20        if ($simulateFailure) {
21            // 意図的に例外をスローします。
22            // この例外オブジェクトには、このコードが書かれている「行番号」が記録されます。
23            throw new RuntimeException('データソースへの接続に失敗しました。');
24        }
25
26        return 'データの取得に成功しました。';
27    }
28}
29
30/**
31 * データ連携処理を実行し、エラー発生時に行番号を含む詳細情報をログに出力するメイン処理
32 */
33function main(): void
34{
35    $connector = new DataConnector();
36
37    try {
38        // わざとエラーを発生させるために true を渡してメソッドを呼び出す
39        echo $connector->fetchData(true);
40    } catch (RuntimeException $e) {
41        // catchブロックで例外オブジェクトを捕捉します。
42        // getLine() メソッドを使い、例外がスローされた行番号を取得してエラー情報と連携させます。
43        $errorLine = $e->getLine();
44        $errorMessage = $e->getMessage();
45        $errorFile = $e->getFile();
46
47        // 取得した行番号(line)をエラーログに含めることで、問題箇所の特定が容易になります。
48        $logMessage = sprintf(
49            "[%s] ERROR: %s in %s on line %d" . PHP_EOL,
50            date('Y-m-d H:i:s'),
51            $errorMessage,
52            $errorFile,
53            $errorLine // getLine()で取得した行番号を連携
54        );
55
56        // 標準エラー出力にログを出力（実際のアプリケーションではファイル等に記録します）
57        error_log($logMessage);
58
59        echo "処理中にエラーが発生しました。詳細はログを確認してください。" . PHP_EOL;
60    }
61}
62
63// 処理を実行
64main();

PHPのRuntimeExceptionは、プログラム実行時に発生するエラーを表す例外クラスです。このクラスで利用できるgetLine()メソッドは、例外がスローされた（発生した）コードの行番号を整数(int)で返します。このメソッドに引数はありません。

サンプルコードは、外部システムとのデータ連携処理でエラーが発生した場合を想定しています。DataConnectorクラスのfetchDataメソッド内でthrow new RuntimeException(...)が実行されると、その瞬間のファイル名や行番号といった情報が自動的に記録された例外オブジェクトが生成されます。

try...catchブロックでは、この生成された例外オブジェクトを捕捉します。そして、$e->getLine()を呼び出すことで、エラーが発生した具体的な行番号を取得できます。サンプルコードでは、この行番号を$e->getMessage()で取得したエラーメッセージや$e->getFile()で取得したファイル名と連携させて、より詳細なログメッセージを作成しています。

このように、エラーメッセージに行番号を連携させることで、開発者は問題が発生したコードの箇所を迅速かつ正確に特定でき、デバッグ作業を効率的に進めることが可能になります。getLine()は、安定したシステム運用に欠かせないエラー追跡のための重要な機能です。