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

Copy
1<?php
2
3/**
4 * この関数は、整数の引数のみを受け入れ、その値を2倍にして文字列として返します。
5 * 不正な型の引数が渡された場合、TypeErrorが発生します。
6 *
7 * @param int $value 処理する整数値
8 * @return string 処理結果の文字列
9 */
10function processNumericValue(int $value): string
11{
12    return "Processed: " . ($value * 2);
13}
14
15try {
16    // ここで意図的にTypeErrorを発生させます。
17    // processNumericValue関数はintを期待していますが、ここでは文字列が渡されています。
18    processNumericValue("not_an_integer");
19} catch (TypeError $e) {
20    // TypeErrorが捕捉された場合の処理
21    echo "Caught a TypeError!\n";
22    echo "--------------------------\n";
23    echo "Error Message: " . $e->getMessage() . "\n";
24    echo "Error File: " . $e->getFile() . "\n";
25    // TypeErrorオブジェクトの'line'プロパティから、エラーが発生した行番号を取得します (PHP 8)。
26    echo "Error Line: " . $e->line . "\n";
27    echo "--------------------------\n";
28    echo "この行番号は、上記の 'processNumericValue(\"not_an_integer\");' が書かれている行を指します。\n";
29}
30
31// 別途、TypeErrorを発生させない呼び出し例
32echo "\n";
33echo "--- Correct usage ---\n";
34try {
35    echo processNumericValue(10) . "\n";
36} catch (TypeError $e) {
37    // このブロックは実行されないはず
38    echo "This should not be printed.\n";
39}
40
41?>

PHP 8では、関数の引数や戻り値に型を宣言する「型宣言」が強化され、これによりプログラムの堅牢性が向上しました。もし関数が期待する型と異なる値が渡された場合、PHPは「TypeError」というエラーを発生させます。

このサンプルコードでは、整数（int）の引数のみを受け入れるprocessNumericValue関数に対し、意図的に文字列を渡すことでTypeErrorを発生させています。try...catchブロックを使用してこのTypeErrorを捕捉し、エラー情報を表示しています。

TypeErrorオブジェクトのlineプロパティは、エラーが実際に発生した「ソースコードの行番号」を整数値（int）として提供します。このプロパティは引数を必要としません。サンプルコードでは、processNumericValue("not_an_integer");という不正な呼び出しが書かれている行の番号が$e->lineの値として取得され、出力されます。このようにlineプロパティを活用することで、プログラム実行中に予期せぬ型エラーが発生した場合でも、問題の発生源を迅速かつ正確に特定し、デバッグ作業を効率的に進めることが可能になります。

Copy
1<?php
2
3/**
4 * 整数2つを受け取り、その合計を返す関数。
5 * 引数の型がintでない場合、TypeErrorを発生させます。
6 *
7 * @param int $a 最初の数値
8 * @param int $b 2番目の数値
9 * @return int 合計値
10 */
11function addNumbers(int $a, int $b): int
12{
13    return $a + $b;
14}
15
16try {
17    // 意図的にTypeErrorを発生させる例。
18    // addNumbers関数はint型を期待していますが、第2引数に文字列を渡しています。
19    addNumbers(10, 'hello'); // この行でTypeErrorが発生します
20} catch (TypeError $e) {
21    // TypeErrorを捕捉し、エラー情報を取得します。
22
23    // エラーが発生したファイルのパスを取得
24    $filePath = $e->getFile();
25    // エラーが発生した行番号を取得
26    $lineNumber = $e->getLine();
27    // エラーメッセージを取得
28    $errorMessage = $e->getMessage();
29
30    // 取得したエラー情報を表示（「送信」の簡易的な表現として出力します）
31    // 実際には、これらの情報はログファイルに書き込まれたり、
32    // 監視システムに送信されたりすることが一般的です。
33    echo "--- エラー情報を検知しました ---\n";
34    echo "エラー種別: TypeError\n";
35    echo "ファイル: " . $filePath . "\n";
36    echo "行番号: " . $lineNumber . "\n"; // TypeErrorのlineプロパティ（getLine()メソッドで取得）
37    echo "メッセージ: " . $errorMessage . "\n";
38    echo "このエラー情報はシステム運用チームへ送信されました（仮）.\n";
39    echo "---------------------------------\n";
40}
41
42// エラーが捕捉された後も、プログラムは実行を続行します。
43echo "プログラムは正常に終了しました。\n";
44
45?>

このPHPサンプルコードは、引数の型が期待と異なる場合に発生する「TypeError」のエラーハンドリングと、エラーの詳細情報を取得する方法を、初心者にも分かりやすく示しています。addNumbers関数は二つの整数を受け取り、その合計を返すよう定義されていますが、tryブロック内で第二引数に整数ではなく文字列'hello'を渡すことで、意図的にTypeErrorを発生させています。

catch (TypeError $e)ブロックは、この型エラーを捕捉します。捕捉したエラーは$eというTypeErrorオブジェクトとして扱われ、ここからエラーに関する様々な情報を取得できます。特に$e->getLine()メソッドは、TypeErrorオブジェクトのlineプロパティの値を整数型で返し、エラーが実際に発生したコードの行番号を取得するために使用されます。この場合、addNumbers(10, 'hello');と記述された行の番号が取得されます。

取得されたファイルパス、行番号、エラーメッセージといった情報は、echo文で画面に出力されています。これはエラー情報を「送信」する簡易的な表現であり、実際のシステムではこれらの情報はログファイルに記録されたり、監視システムに通知されたりして、システム運用チームが迅速に問題箇所を特定し、対応するために活用されます。このように、エラー発生時の詳細情報を正確に取得し活用することは、堅牢なシステム構築において不可欠な要素です。