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

Copy
1<?php
2
3/**
4 * PHPの__LINE__マジック定数の使用例を示します。
5 * __LINE__は、この定数が記述された現在のファイルの行番号を返します。
6 * システムエンジニアにとって、デバッグやログ出力でコードの位置を特定する際に役立ちます。
7 */
8
9// __LINE__マジック定数は、そのコードが書かれた行の番号を示します。
10echo "この行は " . __LINE__ . " 行目です。\n";
11
12// 空行をいくつか挟むことで、行番号がどのように変化するかを確認できます。
13
14
15echo "現在の行は " . __LINE__ . " 行目です。\n";
16
17/**
18 * 関数内で__LINE__を使用する例。
19 */
20function displayCurrentLine()
21{
22    // 関数内であっても、__LINE__は常にその記述された行の番号を返します。
23    echo "関数内のこの行は " . __LINE__ . " 行目です。\n";
24}
25
26// 関数を呼び出し、内部の行番号出力を確認します。
27displayCurrentLine();
28
29echo "スクリプトの最後の出力行は " . __LINE__ . " 行目です。\n";
30
31?>

PHPの__LINE__は、プログラムの実行時に特別な意味を持つ「マジック定数」の一つです。この定数を使用すると、その__LINE__がコード内に記述された現在の行番号を整数（int）として取得できます。引数は必要ありません。

サンプルコードでは、まず「echo "この行は " . LINE . " 行目です。\n";」という記述により、この行自体の行番号が出力されます。その後、空行を挟んで再度__LINE__を使用すると、前の行とは異なる、その記述位置に応じた新しい行番号が正確に表示されることがわかります。

さらに、displayCurrentLine関数の内部で__LINE__を使用した場合も、関数が定義されているファイルの、その__LINE__が記述された行の番号を返します。つまり、__LINE__は常に、その記述された物理的なコードの位置を示します。

システムエンジニアにとって、この__LINE__はデバッグ作業やエラーログの出力において非常に有用です。どのコードの、どの行で問題が発生したか、または特定の処理が実行されたかといった情報を簡単に特定できるようになり、問題解決の効率向上に貢献します。

Copy
1<?php
2
3/**
4 * PHPの実行時エラーを捕捉し、エラー発生行番号を取得して出力するサンプル。
5 *
6 * CompileError (コンパイルエラー) はPHPスクリプトの実行開始前に発生するため、
7 * このtry-catchブロックで直接捕捉することはできません。
8 * この例では、一般的な実行時エラー（Throwableインターフェースを実装するError/Exception）を
9 * 捕捉し、その行番号（リファレンス情報の 'line' に相当）をgetLine()メソッドで取得し「送信」しています。
10 */
11function handleAndReportErrorLine(): void
12{
13    try {
14        // 意図的に実行時エラー (DivisionByZeroErrorはErrorクラスのサブクラス) を発生させます。
15        $numerator = 10;
16        $denominator = 0;
17        $result = $numerator / $denominator; // ここでエラーが発生します。
18        echo "計算結果: " . $result . "\n";
19    } catch (Throwable $e) {
20        // 捕捉したエラーオブジェクトから、エラーが発生した行番号を取得します。
21        // CompileErrorを含む全てのThrowable実装クラスはgetLine()メソッドを持ちます。
22        $errorLine = $e->getLine();
23
24        // 取得した行番号を「送信」（ここでは標準出力）します。
25        echo "エラーが発生しました。エラー発生行: " . $errorLine . " を出力します。\n";
26        // 実際のアプリケーションでは、この情報をログファイルに書き込んだり、
27        // 監視システムに通知したりするなどの「送信」処理が行われます。
28    }
29}
30
31// 関数を実行してエラーハンドリングの動作を確認します。
32handleAndReportErrorLine();

PHPのこのサンプルコードは、プログラム実行中に発生したエラーの「行番号」を取得し、その情報を活用する方法を示しています。リファレンス情報にあるCompileErrorクラスのlineプロパティは、コンパイル時に発生するエラーの行番号を指しますが、PHPの全てのエラー（ErrorやExceptionなど、Throwableインターフェースを実装するもの）は、エラーが発生したソースコード上の行番号情報を持っています。この行番号は、getLine()というメソッド（引数なし）を使って取得でき、整数の形で返されます。

サンプルコードでは、意図的に数値をゼロで割ることでDivisionByZeroErrorという実行時エラーを発生させています。try-catchブロックを用いることで、このエラーを捕捉し、エラーオブジェクトからgetLine()メソッドを呼び出してエラーが発生した行番号を取得しています。

取得した行番号は、echo文で画面に「送信」する形で出力しています。これは、エラー発生時にその場所を特定するための重要な情報であり、実際のシステム開発では、この行番号をログファイルに記録したり、監視システムに通知したりすることで、エラーの原因究明やデバッグ作業に役立てます。このように、エラーの行番号を把握し「送信」することは、安定したシステム運用に不可欠な処理です。