【PHP8.x】Random\BrokenRandomEngineError::getCode()メソッドの使い方

Copy
1<?php
2
3/**
4 * Random\BrokenRandomEngineError は PHP 8.2 で導入されたエラーです。
5 * このサンプルコードは PHP 8.2 以降で動作します。
6 *
7 * このエラーは、Random\Randomizer が内部で使用する Random\Engine が
8 * 期待通りに動作しない、または壊れている場合にスローされます。
9 * getCode() メソッドは、エラーに関連付けられたコードを整数として返します。
10 * 組み込みの PHP エラーや例外の場合、通常は 0 を返します。
11 */
12
13/**
14 * Random\Engine インターフェースを実装し、意図的に壊れた状態をシミュレートするクラス。
15 * generate() メソッドが呼び出されると、常に例外をスローすることで、
16 * エンジンが期待通りに動作しない状況を作り出します。
17 */
18class BrokenEngine implements Random\Engine
19{
20    /**
21     * 擬似乱数を生成するメソッド。
22     * このエンジンは壊れているため、常に例外をスローし、
23     * Random\Randomizer が期待する文字列を返しません。
24     *
25     * @return string
26     * @throws Exception 意図的にエンジン故障をシミュレートするため
27     */
28    public function generate(): string
29    {
30        // 乱数バイト列の生成に失敗した状態をシミュレートするため、
31        // ここで例外をスローします。
32        // Randomizer は generate() が string を返さない場合に
33        // Random\BrokenRandomEngineError をスローします。
34        throw new Exception('Internal random engine malfunction: Failed to generate random bytes.');
35    }
36}
37
38/**
39 * Random\BrokenRandomEngineError を発生させ、捕捉し、
40 * その上で getCode() メソッドを使用してエラーコードを取得するデモンストレーション関数。
41 */
42function demonstrateBrokenRandomEngineErrorAndGetCode(): void
43{
44    echo "--- Random\\BrokenRandomEngineError::getCode() のデモンストレーション ---\n";
45
46    // 意図的に壊れたエンジンインスタンスを作成します。
47    $brokenEngine = new BrokenEngine();
48
49    try {
50        // 壊れたエンジンを持つ Randomizer インスタンスを作成します。
51        // Randomizer は内部でエンジンの generate() メソッドを呼び出す際に、
52        // エンジンが期待通りに動作しない（例: 例外をスローするなど）場合、
53        // Random\BrokenRandomEngineError をスローします。
54        $randomizer = new Random\Randomizer($brokenEngine);
55
56        echo "乱数生成を試行中... (この操作でエラーが発生するはずです)\n";
57
58        // 乱数を生成しようとすると、Randomizer が BrokenEngine の generate() メソッドを呼び出し、
59        // generate() が例外をスローするため、Random\BrokenRandomEngineError が発生します。
60        $randomizer->getInt(1, 100);
61
62        // 上記でエラーが発生するため、この行は実行されません。
63        echo "このメッセージは表示されません。\n";
64
65    } catch (Random\BrokenRandomEngineError $e) {
66        // Random\BrokenRandomEngineError を捕捉しました。
67        echo "Random\\BrokenRandomEngineError を捕捉しました！\n";
68        echo "エラーメッセージ: " . $e->getMessage() . "\n";
69        // getCode() メソッドを呼び出してエラーコードを取得します。
70        // 組み込みの PHP エラーの多くは、デフォルトで '0' を返します。
71        echo "エラーコード (getCode()): " . $e->getCode() . "\n";
72        echo "エラーが発生したファイル: " . $e->getFile() . "\n";
73        echo "エラーが発生した行: " . $e->getLine() . "\n";
74    } catch (Throwable $e) {
75        // その他の予期せぬエラーや例外を捕捉します。
76        echo "予期せぬエラーを捕捉しました！\n";
77        echo "エラータイプ: " . get_class($e) . "\n";
78        echo "エラーメッセージ: " . $e->getMessage() . "\n";
79        echo "エラーコード (getCode()): " . $e->getCode() . "\n";
80    }
81
82    echo "--- デモンストレーション終了 ---\n";
83}
84
85// デモンストレーション関数を実行します。
86demonstrateBrokenRandomEngineErrorAndGetCode();

Random\BrokenRandomEngineError::getCode()メソッドは、PHP 8.2以降で導入されたRandom\BrokenRandomEngineErrorクラスに属するメソッドです。このエラーは、Random\Randomizerが内部で使用するRandom\Engineインターフェースを実装したクラスが、期待通りに乱数バイト列を生成できない、または壊れている場合にスローされます。

getCode()メソッドは引数を一切受け取らず、エラーに関連付けられた整数値のコードを返します。PHPの組み込みエラーや例外の場合、このメソッドは通常「0」を返しますが、カスタム例外などでは開発者が任意のコードを設定することも可能です。

提供されたサンプルコードでは、Random\Engineを実装するBrokenEngineクラスを作成し、generate()メソッドが常に例外をスローするように意図的に設定しています。この壊れたエンジンをRandom\Randomizerに渡し、乱数生成を試みると、内部でエラーが検出されRandom\BrokenRandomEngineErrorが発生します。

try-catchブロックでこのエラーを捕捉した後、捕捉した例外インスタンスからgetCode()メソッドを呼び出すことで、エラーの数値コードを取得し表示しています。これにより、プログラムがエラーの種類を数値で識別する際に活用できます。このサンプルでは、BrokenRandomEngineErrorのgetCode()は「0」を返しています。