【PHP8.x】getLineメソッドの使い方

Copy
1<?php
2
3/**
4 * RequestParseBodyException を捕捉し、発生行番号を取得するサンプルコード
5 *
6 * このスクリプト単体で実行しても、RequestParseBodyException は発生しません。
7 * この例外は、PHPがHTTPリクエストのボディ部（例: POSTデータ）の解析に失敗した際に、
8 * PHPエンジンによって内部的にスローされるためです。
9 *
10 * このコードは、もしサーバーが不正な形式のリクエストを受け取り、
11 * PHPエンジンが RequestParseBodyException をスローした場合に、
12 * それを `catch` して `getLine()` メソッドで情報を取得する方法を示します。
13 */
14function processRequest(): void
15{
16    try {
17        // PHPはスクリプト実行前にリクエストボディを自動的にパースします。
18        // パースに失敗すると、この try ブロックに到達する前に
19        // RequestParseBodyException がスローされます。
20        //
21        // そのため、このブロック内のコードが例外を発生させるわけではありません。
22        // ここでは、パースが成功したと仮定した処理を記述します。
23        echo "リクエストのパースは正常に行われました。" . PHP_EOL;
24        // var_dump($_POST);
25
26    } catch (RequestParseBodyException $e) {
27        // 不正なリクエストボディにより例外が発生した場合、ここで捕捉します。
28        header("HTTP/1.1 400 Bad Request");
29        echo "エラー: リクエストボディの解析に失敗しました。" . PHP_EOL;
30        echo "メッセージ: " . htmlspecialchars($e->getMessage()) . PHP_EOL;
31
32        // getLine() で例外が発生した行番号を取得します。
33        // RequestParseBodyException のようなPHPエンジン内部で発生する例外の場合、
34        // 特定のスクリプト上の行を指さないため、通常は 0 が返されます。
35        $errorLine = $e->getLine();
36
37        echo "発生行番号: " . $errorLine . PHP_EOL;
38        echo "発生ファイル: " . $e->getFile() . PHP_EOL;
39    }
40}
41
42// グローバルスコープで try-catch を設定して、例外を捕捉します。
43// （processRequest 関数を呼び出す前に例外が発生する可能性があるため）
44processRequest();
45

このサンプルコードは、PHPがHTTPリクエストのボディ解析に失敗した際に発生するRequestParseBodyExceptionを捕捉し、その情報を取り扱う方法を示しています。RequestParseBodyExceptionは、不正なリクエストが送られてきた場合に、PHPエンジン内部で自動的にスローされる特別な例外です。そのため、通常のコードのように意図的にこの例外を発生させることは困難であり、スクリプトが実行される前に発生する可能性があります。

getLine()メソッドは、例外が発生したソースコードの行番号を取得するために使われます。引数はなく、戻り値として行番号を整数（int型）で返します。しかし、RequestParseBodyExceptionのようなPHPエンジン内部で発生する例外の場合、特定のスクリプト上の行番号を指すわけではないため、このメソッドは多くの場合「0」を返します。

サンプルコードでは、try-catchブロックを使ってこの例外を安全に捕捉し、getLine()メソッドで得られる行番号や、getMessage()、getFile()などの情報を利用して、エラーの状況を把握し、適切に処理するための情報を取得する方法を示しています。これにより、サーバーが不正なリクエストを受け取った際のエラーハンドリングの参考にすることができます。