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

Copy
1<?php
2
3/**
4 * この関数は、リクエストボディの処理をシミュレートします。
5 * 実際には、PHP内部でRequestParseBodyExceptionが発生する状況を直接再現することは困難ですが、
6 * 例外処理の基本的な仕組みとgetCode()の使用方法を示します。
7 *
8 * RequestParseBodyExceptionはPHP内部の例外であり、ユーザーコードから直接インスタンス化できません。
9 * しかし、それはRuntimeExceptionを継承しており、getCode()メソッドも継承して使用します。
10 * そのため、RuntimeExceptionを捕捉する例を通してgetCode()の利用方法を説明します。
11 *
12 * @param string $requestBody 処理対象のリクエストボディデータ
13 * @throws RuntimeException データが空または不正な場合にスローされる例外
14 */
15function handleRequestBody(string $requestBody): void
16{
17    // リクエストボディが空の場合は処理できないと仮定し、例外をスローします。
18    // RequestParseBodyExceptionが内部で発生した場合、同様にgetCode()を通じて
19    // エラーコードを取得できることを念頭に置いてください。
20    if (empty($requestBody)) {
21        // 第2引数にエラーコードを指定してRuntimeExceptionをスローします。
22        // このコードは後でgetCode()で取得できます。
23        throw new RuntimeException("リクエストボディが空であるか、形式が不正です。", 4001);
24    }
25
26    echo "リクエストボディを正常に処理しました: " . $requestBody . "\n";
27}
28
29// 例外が発生する可能性のあるコードをtryブロック内に記述します。
30try {
31    echo "--- 正常なリクエストボディで処理を試行します ---\n";
32    handleRequestBody("username=john&password=doe"); // 正常に処理されるケース
33    echo "正常な処理が完了しました。\n\n";
34
35    echo "--- 空のリクエストボディで処理を試行します (例外発生) ---\n";
36    handleRequestBody(""); // 例外を発生させるケース
37    echo "この行は実行されません。\n"; // 例外が発生すると、この行はスキップされます
38} catch (RuntimeException $e) {
39    // RuntimeException (RequestParseBodyExceptionが継承するクラス) を捕捉します。
40    // RequestParseBodyExceptionが捕捉された場合も、同様にgetCode()でエラーコードを取得できます。
41    echo "\n--- 例外が発生しました！ ---\n";
42    echo "例外クラス: " . get_class($e) . "\n";
43    echo "エラーメッセージ: " . $e->getMessage() . "\n";
44    // ここでgetCode()メソッドを使用して、例外に設定されたエラーコードを取得します。
45    echo "エラーコード (getCode()から取得): " . $e->getCode() . "\n";
46    echo "ファイル: " . $e->getFile() . "\n";
47    echo "行: " . $e->getLine() . "\n";
48} catch (Throwable $e) {
49    // 上記で捕捉できなかった、その他の予期せぬエラーを捕捉します。
50    echo "\n--- 予期せぬエラーが発生しました！ ---\n";
51    echo "エラーメッセージ: " . $e->getMessage() . "\n";
52    echo "エラーコード (getCode()から取得): " . $e->getCode() . "\n";
53}

PHPのRequestParseBodyException::getCode()メソッドは、リクエストボディの解析に失敗した際に発生する例外から、そのエラーを示す数値コードを取得するために使用されます。このメソッドは引数を取らず、整数型（int）のエラーコードを返します。

RequestParseBodyExceptionはPHP内部で発生する例外であるため、サンプルコードでは、この例外が継承するRuntimeExceptionを用いてgetCode()の動作をシミュレートしています。これは、両クラスが同じgetCode()メソッドを持っているため、利用方法が共通であることを示すためです。

サンプルコードでは、handleRequestBody関数が空のリクエストボディを受け取った際に、RuntimeExceptionを発生させています。このとき、例外の第2引数としてエラーコード「4001」を設定しています。

try-catchブロックでは、発生した例外を捕捉し、$e->getCode()を呼び出すことで、この「4001」という数値コードを取得しています。これにより、プログラムは例外の種類を数値で判別し、エラーに応じた処理を柔軟に行うことができます。RequestParseBodyExceptionが実際に発生した場合も、同様にgetCode()を使用してエラーコードを取得し、問題の原因を特定することが可能です。