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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 配列の範囲外アクセスエラーを捕捉し、
7 * 例外が発生した行番号を含むエラー情報を送信（ログ出力）します。
8 *
9 * OutOfBoundsException は、無効なキーやインデックスへのアクセス時にスローされます。
10 * 継承元の Exception クラスが持つ line プロパティ（getLine() メソッドで取得）には、
11 * 例外がスローされた行番号が格納されています。
12 */
13function sendErrorWithLineNumber(): void
14{
15    try {
16        // サンプルデータ配列
17        $data = ['A', 'B', 'C'];
18
19        // OutOfBoundsException を意図的に発生させる
20        // 配列の範囲外のインデックス（例: 3）にアクセスする
21        $value = $data[3];
22        echo $value;
23
24    } catch (OutOfBoundsException $e) {
25        // 例外を捕捉する
26
27        // Exceptionオブジェクトから例外が発生した行番号を取得
28        $errorLine = $e->getLine();
29
30        // 送信するエラー情報を組み立てる
31        $logMessage = sprintf(
32            "[Error] File: %s, Line: %d, Message: %s",
33            $e->getFile(),
34            $errorLine, // ここで取得した行番号を使用
35            $e->getMessage()
36        );
37
38        // エラー情報をサーバーのログファイルに「送信」（出力）する
39        // 実際の運用では、ここで外部の監視サービス等に通知する処理を実装します
40        error_log($logMessage);
41
42        // ユーザーには汎用的なメッセージを表示
43        echo "処理中にエラーが発生しました。詳細はログを確認してください。";
44    }
45}
46
47// 関数を実行
48sendErrorWithLineNumber();

このサンプルコードは、配列の範囲外にアクセスした際に発生する OutOfBoundsException というエラーを捕捉し、エラーが起きた行番号を含む詳細情報をログに送信（出力）する方法を示しています。

try ブロック内では、意図的に配列 $data の存在しないインデックス 3 にアクセスし、エラーを発生させます。このエラーが発生すると、catch ブロックが実行され、OutOfBoundsException の情報を持つオブジェクトが変数 $e に格納されます。

OutOfBoundsException は、親クラスである Exception クラスから line プロパティを継承しています。このプロパティにはエラーが発生したソースコードの行番号が格納されており、getLine() メソッドで値を取得できます。このメソッドは引数を取らず、戻り値として行番号を整数（int）で返します。

コードでは、この $e->getLine() で取得した行番号を、ファイル名（$e->getFile()）やエラーメッセージ（$e->getMessage()）と組み合わせ、sprintf 関数で整形されたログメッセージを作成します。最後に error_log() 関数を使い、このメッセージをサーバーのログファイルへ「送信」（記録）しています。これにより、開発者はエラーが発生した正確な場所を特定し、デバッグを効率的に進めることができます。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 配列の範囲外アクセスを試み、例外から行番号を連携して出力する
7 *
8 * @param array<int, string> $sampleArray
9 * @param int $outOfBoundsIndex
10 * @return void
11 */
12function displayErrorInfoWithLineNumber(array $sampleArray, int $outOfBoundsIndex): void
13{
14    try {
15        // 配列の範囲外のインデックスにアクセスし、意図的に例外を発生させる
16        echo $sampleArray[$outOfBoundsIndex];
17    } catch (OutOfBoundsException $e) {
18        // OutOfBoundsException を捕捉する
19
20        // getLine() メソッドで、例外が発生したソースコードの行番号を取得する
21        $line = $e->getLine();
22
23        // 取得した行番号(line)を他の情報と連携させ、分かりやすいエラーメッセージを生成する
24        $errorMessage = sprintf(
25            "エラー: 配列の範囲外にアクセスしました。\nファイル: %s\n発生行: %d\n",
26            $e->getFile(),
27            $line // 取得した行番号をメッセージに含める
28        );
29
30        // 生成したメッセージを出力する
31        echo $errorMessage;
32    }
33}
34
35// サンプルデータ
36$data = ['apple', 'banana', 'cherry'];
37
38// 存在しないインデックス 5 を指定して関数を呼び出す
39displayErrorInfoWithLineNumber($data, 5);
40
41?>

このPHPサンプルコードは、配列の範囲外にアクセスした際に発生する OutOfBoundsException という例外を捕捉し、エラーが発生したソースコードの行番号を取得して表示する例です。

displayErrorInfoWithLineNumber 関数は、配列と整数型のインデックスを引数として受け取ります。関数内の try ブロックでは、引数で受け取ったインデックスを使って配列にアクセスします。このとき、意図的に範囲外のインデックスを指定することで OutOfBoundsException を発生させています。

例外が発生すると、処理は catch ブロックに移ります。ここで、捕捉した例外オブジェクト $e の getLine() メソッドを呼び出します。このメソッドは引数を取らず、例外が発生したソースコードの行番号を整数(int)で返します。

このコードのポイントは、getLine() で取得した行番号を、getFile() で取得したファイル名といった他の情報と「連携」させている点です。sprintf() 関数を使い、これらの情報を組み合わせて具体的なエラーメッセージを生成し、出力します。これにより、開発者はエラーの原因となった箇所を正確かつ迅速に特定でき、デバッグ作業の効率が向上します。