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

Copy
1<?php
2
3/**
4 * __LINE__ マジック定数の使用例を示すためのクラスです。
5 * __LINE__ は、この定数が記述されているファイル内の現在の行番号を返します。
6 */
7class LineNumberExample
8{
9    /**
10     * プログラムの異なる場所で現在の行番号を表示します。
11     *
12     * @return void
13     */
14    public function showLineInfo(): void
15    {
16        // この echo 文が記述されている行の番号が出力されます。
17        echo 'クラスメソッド内の行番号: ' . __LINE__ . PHP_EOL;
18
19        // 変数に代入する時点での行番号が格納されます。
20        $currentLine = __LINE__;
21        echo '変数代入後の行番号: ' . $currentLine . PHP_EOL;
22    }
23}
24
25// この echo 文が記述されている行の番号が出力されます。
26echo 'スクリプトのトップレベルでの行番号: ' . __LINE__ . PHP_EOL;
27
28// LineNumberExample クラスのインスタンスを生成します。
29$example = new LineNumberExample();
30
31// メソッドを呼び出します。メソッド内の __LINE__ が評価されます。
32$example->showLineInfo();
33
34// この echo 文が記述されている行の番号が出力されます。
35echo 'スクリプトの最後での行番号: ' . __LINE__ . PHP_EOL;
36

PHPの__LINE__は、コードが記述されているファイル内の現在の行番号を返す「マジック定数」です。マジック定数とは、使われる場所によってその値が変化する、あらかじめ定義された特別な定数のことです。

この定数は引数を取らず、戻り値として行番号を整数(int)型で返します。プログラムのデバッグ時に、コードのどの部分が実行されたかを正確に特定するのに役立ちます。

サンプルコードでは、__LINE__がスクリプト内の様々な場所で使われています。スクリプトの先頭、クラスのメソッド内、そしてスクリプトの末尾でecho文と共に使用することで、それぞれの__LINE__が記述された箇所の行番号が正確に出力されることがわかります。また、変数に__LINE__を代入すると、その代入が行われた行の番号が変数に格納され、後からその値を利用することもできます。このように__LINE__は、それが記述されたその場所の行番号を動的に取得するための便利な機能です。

Copy
1<?php
2
3/**
4 * RequestParseBodyException を捕捉し、エラーが発生した行番号を取得するサンプルコード
5 *
6 * この例外は、クライアントからサーバーへ "送信" されたリクエストボディの
7 * 解析に失敗した際にスローされます。
8 *
9 * 通常の try-catch では捕捉できない致命的なエラーとして扱われるため、
10 * register_shutdown_function() を使ってエラー情報を取得します。
11 */
12
13// スクリプトの実行が終了する際に呼び出される関数を登録します。
14// これにより、致命的なエラーが発生した場合でも情報を捕捉できます。
15register_shutdown_function(function () {
16    // 最後に発生したエラー情報を取得します。
17    $error = error_get_last();
18
19    // エラーが存在し、それが RequestParseBodyException に関連するものかを確認します。
20    if ($error && str_contains($error['message'], 'RequestParseBodyException')) {
21        // エラーメッセージから、プロパティ 'line' に相当する行番号を正規表現で抽出します。
22        // メッセージ例: "Request body parsing failed ... at line 5"
23        if (preg_match('/at line (\d+)/', $error['message'], $matches)) {
24            // 抽出した行番号 (プロパティ `line` の値に相当)
25            $line = (int)$matches[1];
26
27            // エラーレスポンスとして、エラーが発生した行番号とメッセージを出力します。
28            header('Content-Type: text/plain; charset=UTF-8', true, 500);
29            echo "リクエストボディの解析に失敗しました。\n";
30            echo "エラー発生行 (RequestParseBodyException->line): " . $line . "\n";
31            echo "エラー詳細: " . $error['message'] . "\n";
32            exit;
33        }
34    }
35});
36
37// このスクリプト自体には、エラーを発生させる処理はありません。
38// エラーは、このスクリプトが実行される前のリクエスト解析フェーズで発生します。
39// 以下のメッセージは、リクエストの解析が成功した場合にのみ表示されます。
40header('Content-Type: text/plain; charset=UTF-8');
41echo "リクエストボディの解析に成功しました。\n";
42
43/*
44--- このコードの動作を確認する方法 ---
45
461. このファイルをWebサーバーの公開ディレクトリに `test.php` として保存します。
472. ターミナルから以下のcurlコマンドを実行し、不正なPOSTリクエストを "送信" します。
48   (最後のバウンダリの末尾に '--' がなく、不正なデータ形式になっています)
49
50curl -X POST \
51  -H "Content-Type: multipart/form-data; boundary=boundary_string" \
52  --data-binary $'--boundary_string\r\nContent-Disposition: form-data; name="field1"\r\n\r\nvalue1\r\n--boundary_string\r\n' \
53  http://localhost/test.php
54
553. 実行結果として、上記で echo しているエラーメッセージと行番号が表示されます。
56*/

RequestParseBodyException->lineは、クライアントからサーバーへ送信されたHTTPリクエストボディの解析に失敗した際に、エラーが発生したリクエストボディ内の行番号を格納するプロパティです。この例外は、PHPスクリプトが本格的に実行される前の段階で発生することが多く、通常のtry-catch構文では捕捉できない致命的なエラーとして扱われます。

サンプルコードでは、この特性に対応するためにregister_shutdown_function関数を使用しています。この関数は、スクリプトの実行が終了する際に呼び出される処理を登録するもので、致命的なエラーが発生した後でもエラー情報を取得できます。登録された関数内でerror_get_lastを呼び出して最後に発生したエラー情報を取得し、そのエラーメッセージの文字列から正規表現を使って「at line X」という形式で記述された行番号を抽出します。この抽出された数値が、lineプロパティが示す値に相当します。

このプロパティは引数を取らず、戻り値としてエラーが発生した行番号を整数(int)で返します。これにより、開発者はクライアントから送信された不正な形式のデータについて、どの行で問題が起きているかを正確に特定できます。