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

Copy
1<?php
2
3namespace App\Controllers;
4
5// CodeIgniterのベースコントローラーと、捕捉対象のTypeErrorクラスをインポートします。
6use CodeIgniter\Controller;
7use TypeError;
8
9/**
10 * CodeIgniterコントローラー内でTypeErrorのcodeプロパティを確認するサンプル。
11 *
12 * このファイルをCodeIgniter 4プロジェクトの `app/Controllers/` ディレクトリに
13 * `TypeErrorDemo.php` として保存し、ブラウザから該当URLにアクセスすると動作します。
14 * (例: http://your-site.local/typeerrordemo)
15 */
16class TypeErrorDemo extends Controller
17{
18    /**
19     * ユーザーIDに基づいてユーザー情報を処理するメソッド。
20     * PHPの型宣言により、引数 $userId は整数(int)である必要があります。
21     *
22     * @param int $userId ユーザーID
23     */
24    private function processUserId(int $userId): void
25    {
26        // 本来はこのIDを使ってデータベース検索などを行う
27        echo "ユーザーID: {$userId} の処理が正常に完了しました。";
28    }
29
30    /**
31     * エントリーポイントとなるメソッド。
32     * 意図的に型エラーを発生させ、TypeErrorを捕捉してcodeプロパティを表示します。
33     */
34    public function index(): void
35    {
36        try {
37            // 本来はint型であるべき引数に、意図的に文字列を渡します。
38            // これにより、processUserIdメソッドの呼び出し時にTypeErrorが発生します。
39            $this->processUserId('user-123');
40        } catch (TypeError $e) {
41            // 発生したTypeErrorをここで捕捉します。
42            // プレーンテキストとして出力するようヘッダーを設定します。
43            header('Content-Type: text/plain; charset=utf-8');
44            echo "アプリケーションで型エラーが発生しました。\n\n";
45
46            // $e->getCode() は TypeError オブジェクトの 'code' プロパティの値を取得します。
47            // PHPが内部的にスローする TypeError の場合、code は通常 0 となります。
48            $errorCode = $e->getCode();
49
50            echo "エラーコード: " . $errorCode . "\n";
51            echo "エラーメッセージ: " . $e->getMessage() . "\n";
52            echo "発生ファイル: " . $e->getFile() . "\n";
53            echo "発生行: " . $e->getLine() . "\n";
54        }
55    }
56}

このPHPサンプルコードは、WebアプリケーションフレームワークのCodeIgniter 4環境で、TypeError の code プロパティの動作を確認するものです。

コードには、引数として整数(int)型のみを受け入れるように型宣言された processUserId メソッドがあります。しかし、index メソッド内では、このメソッドにあえて文字列を渡すことで、意図的に TypeError というエラーを発生させています。

プログラムは try...catch ブロックを使い、発生した TypeError を捕捉します。捕捉されたエラーの情報は $e というオブジェクトに格納されます。$e->getCode() は、このエラーオブジェクトの code プロパティの値を取得するメソッドです。このメソッドに引数は必要なく、戻り値としてエラーコードを整数(int)で返します。

PHPの型チェック機能によって自動的に発生した TypeError の場合、code プロパティの値は通常 0 になります。このサンプルは、関数の引数に想定外の型のデータが渡された際に発生するエラーを捕捉し、その詳細情報としてエラーコードを取得する方法を具体的に示しています。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * TypeErrorのcodeプロパティの利用例を示すクラス.
7 *
8 * このコードはPHP_CodeSnifferが推奨するPSR-12コーディング規約に準拠しています。
9 * 型宣言を適切に行うことで、意図しない型のデータが渡された際にTypeErrorを発生させ、
10 * プログラムの堅牢性を高めることができます。
11 */
12final class TypeErrorHandler
13{
14    /**
15     * 意図的にTypeErrorを発生させ、その例外コードを捕捉して表示します。
16     */
17    public function execute(): void
18    {
19        try {
20            // PHP 8の厳格な型付けでは、int型が期待される場所に文字列を渡すと
21            // TypeErrorがスローされます。
22            $this->add(5, 'invalid_number');
23        } catch (TypeError $e) {
24            // 発生したTypeErrorを捕捉します。
25            echo 'エラーを捕捉しました。' . PHP_EOL;
26            echo 'メッセージ: ' . $e->getMessage() . PHP_EOL;
27
28            // $e->getCode() で例外コードを取得します。
29            // 例外がスローされる際にコードが指定されていない場合、通常は 0 となります。
30            $errorCode = $e->getCode();
31
32            echo '例外コード (code): ' . $errorCode . PHP_EOL;
33        }
34    }
35
36    /**
37     * 2つの数値を加算します。引数にはint型を期待します。
38     *
39     * @param int $a 1つ目の数値
40     * @param int $b 2つ目の数値
41     */
42    private function add(int $a, int $b): int
43    {
44        return $a + $b;
45    }
46}
47
48// クラスのインスタンスを生成し、メソッドを実行します。
49$handler = new TypeErrorHandler();
50$handler->execute();

PHP 8におけるTypeErrorは、厳格な型付けが有効なコードで、関数やメソッドが期待する型と異なる値が渡された際に発生する重要なエラーです。例えば、数値を受け取る関数に誤って文字列を渡した場合などがこれに該当します。

TypeErrorクラスのcodeプロパティは、このエラー発生時に、その例外に付随する特定のコードを取得するために使用されます。このプロパティは引数を一切取らず、戻り値としてint型の整数を返します。PHPの組み込み例外の場合、通常、例外発生時に明示的なコードが指定されていないため、このプロパティは0を返します。

サンプルコードでは、declare(strict_types=1);によって厳格な型チェックが有効になっており、addメソッドがint型を期待する引数に文字列'invalid_number'を渡すことで、意図的にTypeErrorを発生させています。try-catchブロックでこのエラーを捕捉し、$e->getCode()を呼び出すことで、発生したTypeErrorのコードを取得して表示しています。この例では、PHPの組み込みエラーであるため、codeプロパティは0を返します。このように、codeプロパティはエラーの種類を特定し、よりきめ細やかなエラーハンドリングを行う際に役立ちます。

Copy
1<?php
2
3/**
4 * 指定された文字列を表示する関数。
5 * 引数にstring型以外の値が渡されるとTypeErrorを発生させます。
6 *
7 * @param string $input 表示する文字列
8 * @return void
9 */
10function displayString(string $input): void
11{
12    echo "受け取った文字列: " . $input . "\n";
13}
14
15/**
16 * TypeErrorのcodeプロパティの使用方法を示す関数。
17 * displayString関数に不適切な型の引数を渡すことでTypeErrorを意図的に発生させ、
18 * そのエラーを捕捉して、TypeErrorオブジェクトからcodeプロパティの値を取得・表示します。
19 *
20 * @return void
21 */
22function demonstrateTypeErrorGetCode(): void
23{
24    echo "--- TypeErrorのcodeプロパティのデモンストレーション ---\n\n";
25
26    try {
27        echo "string型を期待する関数にint型を渡して、TypeErrorを発生させます。\n";
28        // PHP 8では、引数の型ヒント違反はTypeErrorをスローします。
29        // displayString関数はstring型を期待しますが、int型 (123) を渡すことでTypeErrorを発生させます。
30        displayString(123); // ここでTypeErrorが発生します
31
32    } catch (TypeError $e) {
33        // TypeErrorを捕捉します。
34        echo "TypeErrorを捕捉しました！\n";
35        echo "エラーメッセージ: " . $e->getMessage() . "\n";
36        // TypeErrorオブジェクトのcodeプロパティは、エラーコードをint型で返します。
37        // TypeErrorの場合、通常はPHP内部で設定されるため、デフォルト値の0が返されることが多いです。
38        echo "エラーコード (TypeError::code): " . $e->getCode() . " (int型)\n";
39        echo "発生ファイル: " . $e->getFile() . "\n";
40        echo "発生行: " . $e->getLine() . "\n";
41    } catch (Throwable $e) {
42        // TypeError以外の予期せぬ例外も捕捉できるようにします。
43        echo "予期せぬ例外を捕捉しました！\n";
44        echo "エラーメッセージ: " . $e->getMessage() . "\n";
45        echo "エラーコード: " . $e->getCode() . "\n";
46    }
47
48    echo "\n--- デモンストレーションが完了しました ---\n";
49}
50
51// TypeErrorのcodeプロパティの使用方法を示す関数を実行します。
52demonstrateTypeErrorGetCode();
53
54?>

TypeError::codeプロパティは、PHP 8において、期待される型と異なる値が渡された際に発生するTypeErrorオブジェクトが持つエラーコードを取得するために使用されます。このプロパティは引数を必要とせず、エラーコードを整数型（int）で返します。

サンプルコードでは、まずstring型の引数のみを受け付けるdisplayString関数を定義しています。次に、demonstrateTypeErrorGetCode関数内で、このdisplayString関数に意図的に整数型（123）の引数を渡すことでTypeErrorを発生させています。PHPでは、関数が型ヒントで指定した型と異なる型の引数が渡されると、このTypeErrorがスローされます。

try-catchブロックを用いることで、発生したTypeErrorを安全に捕捉しています。捕捉したTypeErrorオブジェクトからは、getMessage()メソッドでエラーの詳細メッセージを、そしてgetCode()メソッドでこのcodeプロパティの値、つまりエラーコードを取得し表示しています。TypeErrorのcodeプロパティは、PHP内部のエラーコードを表しますが、通常は0を返すことが多いのが特徴です。これにより、プログラム実行中の型エラーの詳細な情報を確認し、適切なエラーハンドリングを行うことが可能になります。