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

Copy
1<?php
2
3/**
4 * データの長さを検証し、例外発生時に行番号を含むエラー情報を送信（ログ出力）する関数
5 *
6 * この関数は、入力データの長さが指定された最小要件を満たしているかを確認します。
7 * 要件を満たさない場合、LengthExceptionをスローします。
8 * catchブロックで例外を捕捉し、エラーメッセージ、ファイル名、そして例外が
9 * スローされた「行番号」を取得して、エラーログに送信（出力）します。
10 *
11 * @param string $data 検証するデータ
12 * @param int $minLength 許容される最小長
13 * @return void
14 */
15function sendDataWithLengthValidation(string $data, int $minLength): void
16{
17    try {
18        // データの長さをチェック
19        if (mb_strlen($data) < $minLength) {
20            // 長さが足りない場合、LengthExceptionをスローする
21            // この行の番号が $e->getLine() で取得される
22            throw new LengthException("データは{$minLength}文字以上でなければなりません。");
23        }
24
25        // 正常な場合の処理
26        echo "データ「{$data}」は正常に送信されました。" . PHP_EOL;
27
28    } catch (LengthException $e) {
29        // LengthExceptionをキャッチ
30        // エラー情報を整形
31        $errorReport = sprintf(
32            "[エラーレポート送信] メッセージ: %s (ファイル: %s, 行番号: %d)",
33            $e->getMessage(), // エラーメッセージを取得
34            $e->getFile(),    // ファイル名を取得
35            $e->getLine()     // 例外が発生した行番号(line)を取得
36        );
37
38        // 整形したエラーレポートを送信（ここではエラーログへの出力をシミュレート）
39        error_log($errorReport);
40        echo $errorReport . PHP_EOL;
41    }
42}
43
44// --- 関数の実行例 ---
45
46// 正常に処理されるケース (長さが8文字以上)
47sendDataWithLengthValidation('password123', 8);
48
49// LengthExceptionが発生するケース (長さが8文字未満)
50sendDataWithLengthValidation('short', 8);
51
52?>

このPHPサンプルコードは、入力されたデータの長さが規定の条件を満たさない場合に LengthException という例外を発生させ、エラー情報を送信（ログ出力）する例です。

sendDataWithLengthValidation関数は、tryブロック内で文字列の長さを検証します。長さが指定された最小文字数に満たない場合、throw new LengthException(...) によって意図的に例外がスローされます。

catchブロックでは、スローされたLengthExceptionオブジェクトを $e という変数で受け取ります。このオブジェクトが持つgetLine()メソッドを呼び出すことで、例外が throw されたソースコード上の「行番号」を整数(int)として取得できます。このgetLine()メソッドに引数はなく、戻り値として行番号を返します。

コード内では、このgetLine()で取得した行番号を、getMessage()で得られるエラーメッセージやgetFile()で得られるファイル名と組み合わせて、詳細なエラーレポートを作成しています。最終的に、error_log関数を使ってこのレポートをエラーログに送信（出力）します。これにより、開発者はエラーが発生した正確な場所を迅速に特定でき、デバッグ作業を効率的に進めることが可能になります。

Copy
1<?php
2
3/**
4 * LengthException の line プロパティの利用例。
5 *
6 * この関数は、入力された文字列の長さを検証します。
7 * 長さが期待値と異なる場合に LengthException をスローし、
8 * catch ブロックでその例外を捕捉します。
9 * 捕捉した例外オブジェクトから getLine() メソッドを使って、
10 * 例外がスローされた行番号を取得し、エラー情報と連携させて出力します。
11 */
12function checkCodeLength(): void
13{
14    try {
15        // 検証するデータ
16        $userCode = "ABC";
17        $requiredLength = 5;
18
19        // 文字列の長さをチェック
20        if (strlen($userCode) !== $requiredLength) {
21            // 長さが期待値と異なる場合、LengthExceptionをスローする。
22            // この例外がスローされた行の情報が、例外オブジェクトの
23            // line プロパティに自動的に格納される。
24            throw new LengthException("ユーザーコードは{$requiredLength}文字である必要があります。");
25        }
26
27        echo "ユーザーコードは正常です。" . PHP_EOL;
28
29    } catch (LengthException $e) {
30        // LengthExceptionを捕捉する
31        // getLine() メソッドで例外発生元の行番号を取得し、エラーログと連携させる
32        $errorLine = $e->getLine();
33
34        // 取得した行番号を含むエラー情報を整形して出力
35        $logMessage = sprintf(
36            "[ERROR] File: %s, Line: %d, Message: %s",
37            $e->getFile(),
38            $errorLine, // line プロパティと連携
39            $e->getMessage()
40        );
41        echo $logMessage . PHP_EOL;
42    }
43}
44
45// 関数を実行
46checkCodeLength();

PHPのLengthExceptionは、値の長さが不正な場合に発生するエラー（例外）を表すクラスです。このクラスが持つlineプロパティは、その例外がコードの何行目で発生したかを示す行番号を自動的に記録します。この行番号は、通常getLine()メソッドを使って取得します。

このサンプルコードは、指定された文字列の長さを検証する関数です。tryブロックの中で、文字列の長さが期待する値と異なる場合にthrow new LengthException()によって意図的に例外を発生させています。例外がスローされた瞬間、PHPはその行番号を例外オブジェクトのlineプロパティに格納します。

続くcatchブロックで、発生したLengthExceptionオブジェクトを$eという変数で捕捉します。そして、$e->getLine()メソッドを呼び出すことで、lineプロパティに格納された行番号を取得できます。このgetLine()メソッドに引数はなく、戻り値として例外が発生した行番号を整数(int)で返します。

最後に、取得した行番号を、getFile()で得られるファイル名やgetMessage()で得られるエラーメッセージと連携させ、一つのログメッセージとして整形して出力しています。このようにlineプロパティを利用することで、エラー発生箇所を正確に特定し、迅速なデバッグに繋げることができます。