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

Copy
1<?php
2
3/**
4 * PHPのErrorオブジェクトからエラーコードを取得するサンプル関数。
5 *
6 * この関数は、意図的にPHPの内部エラーに相当するErrorオブジェクトをスローし、
7 * そのErrorオブジェクトが持つ`code`プロパティ（エラーコード）を捕捉して表示します。
8 * CodeIgniterのようなPHPフレームワークでは、アプリケーションの実行中に発生した
9 * エラーや例外を内部で捕捉し、このエラーコードを含む情報をログに記録したり、
10 * ユーザーへのエラーページ表示に利用したりします。
11 */
12function handlePhpErrorExample(): void
13{
14    try {
15        // 意図的にErrorオブジェクトをスローします。
16        // Errorクラスのコンストラクタは、第2引数でエラーコード (int) を受け取ります。
17        // このエラーコードは、Errorオブジェクトの `code` プロパティとしてアクセス可能です。
18        throw new Error("データ処理中に予期せぬ問題が発生しました。", 5001);
19
20        // 上の throw ステートメントが実行されるため、この行は到達しません。
21        echo "このメッセージは表示されません。" . PHP_EOL;
22
23    } catch (Error $e) {
24        // Errorクラス、またはその派生クラスの例外を捕捉します。
25        // $e->code は、Errorオブジェクトに設定されたエラーコード (int) を返します。
26        $errorCode = $e->getCode();
27        $errorMessage = $e->getMessage();
28        $errorFile = $e->getFile();
29        $errorLine = $e->getLine();
30
31        echo "--- PHP Error 捕捉 ---" . PHP_EOL;
32        echo "エラーコード (int): " . $errorCode . PHP_EOL;
33        echo "エラーメッセージ: " . $errorMessage . PHP_EOL;
34        echo "発生ファイル: " . $errorFile . PHP_EOL;
35        echo "発生行: " . $errorLine . PHP_EOL;
36        echo "----------------------" . PHP_EOL;
37
38        // CodeIgniterなどのフレームワークでは、ここで捕捉したエラー情報（特にerrorCode）を基に、
39        // 開発者向けのデバッグログの記録、ユーザーフレンドリーなエラーページの表示、
40        // あるいは特定のErrorCodeに応じたカスタム処理を実行します。
41    }
42}
43
44// サンプル関数を実行して、エラー捕捉の動作を確認します。
45handlePhpErrorExample();

PHP 8のErrorクラスが持つcodeプロパティは、プログラムの実行中に発生した内部エラーの種類を識別するための整数値（int）を保持します。このプロパティは引数を取りません。サンプルコードでは、try...catchブロックを使ってエラーを捕捉する仕組みを示しています。

throw new Error("メッセージ", 5001);のようにErrorオブジェクトを生成する際、第2引数でエラーコード（ここでは5001）を指定できます。このコードは、catch (Error $e)ブロックでエラーが捕捉された際に、$e->getCode()メソッドを通じて整数値として取得されます。この戻り値は常にint型で、エラーの種類を示す番号となります。

CodeIgniterのようなPHPフレームワークでは、このように捕捉したエラーのcodeプロパティ（またはgetCode()で取得した値）を非常に重要視します。たとえば、特定のコードに応じて開発者向けの詳しいデバッグログを出力したり、ユーザーには「予期せぬエラーが発生しました」といった一般的なメッセージとともに、システム内部でエラーコードを記録し、後の調査に役立てたりします。これにより、エラー発生時の適切なハンドリングと、問題解決の効率化が可能になります。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 整数を期待する関数。
7 *
8 * この関数は、PHPの型ヒントに従い、整数型の引数を期待します。
9 * 異なる型の値が渡された場合、TypeError（Errorを継承）が発生します。
10 *
11 * @param int $value 整数型の値
12 * @return int 入力された値
13 */
14function expectInt(int $value): int
15{
16    return $value;
17}
18
19// PHPのErrorクラスのcodeプロパティの動作を示すサンプルコードです。
20// Errorクラスは、PHPの内部的なエラー（TypeError、ParseErrorなど）や、
21// ユーザーが明示的にスローするエラーの基底クラスです。
22// codeプロパティは、エラーに紐付けられた整数値を保持します。
23
24// --- カスタムエラーの例 ---
25// ユーザーが意図的にErrorをスローし、任意のコードを設定するケース。
26$customErrorCode = 500;
27
28try {
29    // Errorクラスのコンストラクタの第2引数に、エラーコードを指定します。
30    throw new Error('カスタムエラーメッセージです。', $customErrorCode);
31} catch (Error $e) {
32    echo "--- カスタムエラー捕捉 ---\n";
33    echo "エラーメッセージ: " . $e->getMessage() . "\n";
34    // getCode()メソッドを通じて、Errorオブジェクトに設定されたコードを取得します。
35    echo "エラーコード: " . $e->getCode() . "\n";
36}
37
38echo "\n"; // 出力の視認性向上のための改行
39
40// --- 組み込みTypeErrorの例 ---
41// PHPの内部エラーであるTypeErrorが発生した場合のcodeプロパティの動作。
42// TypeErrorはErrorクラスを継承しています。
43try {
44    // int型を期待する関数に文字列を渡し、TypeErrorを発生させます。
45    expectInt('これは整数ではありません');
46} catch (Error $e) { // TypeErrorもError型として捕捉できます。
47    echo "--- 組み込みTypeError捕捉 ---\n";
48    echo "エラーメッセージ: " . $e->getMessage() . "\n";
49    // 組み込みのTypeErrorの場合、通常codeプロパティは0となります。
50    echo "エラーコード: " . $e->getCode() . "\n";
51}

Errorクラスのcodeプロパティは、PHPのエラーオブジェクトに紐づく整数値を保持します。このプロパティは、エラーの種類や発生原因を数値で識別するために利用されます。

codeプロパティは引数を持たず、エラーコードを示すint型の値を返します。通常はErrorオブジェクトのgetCode()メソッドを通じてこの値を取得します。

サンプルコードでは、まずカスタムエラーの例として、ユーザーが任意の整数値（例では500）をエラーコードとして設定し、Errorをスローしています。catchブロックでエラーを捕捉した後、$e->getCode()メソッドを用いて設定したエラーコードを取得・表示しています。

次に、PHPの内部で発生するTypeErrorの例を示します。TypeErrorはErrorクラスを継承しているため、同様にcatch (Error $e)で捕捉可能です。int型を期待する関数に文字列を渡すことでTypeErrorを発生させていますが、この場合、組み込みエラーのcodeプロパティは通常0となります。

このように、Errorクラスのcodeプロパティは、エラーの種類や詳細を数値で識別し、プログラムで適切にエラー処理を行うための重要な情報を提供します。