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

Copy
1<?php
2
3/**
4 * PHP 8 で導入された「コンストラクタプロモーション」を示すカスタムクラスの例です。
5 * 指定されたリファレンスの Random\BrokenRandomEngineError クラスのコンストラクタと
6 * 同じ引数シグネチャを持つことで、関連性を示します。
7 */
8class ExampleConstructorPromotion extends Exception
9{
10    /**
11     * コンストラクタ。
12     * 引数 ($message, $code, $previous) にアクセス修飾子 (public) を付けることで、
13     * PHP 8 のコンストラクタプロモーションを利用し、これらの引数を自動的に
14     * クラスのプロパティとして定義し、初期化します。
15     *
16     * @param string $message エラーメッセージの文字列（デフォルト値あり）
17     * @param int $code エラーコード（デフォルト値あり）
18     * @param ?Throwable $previous 前のエラーオブジェクト（オプション、デフォルト値あり）
19     */
20    public function __construct(
21        public string $message = 'Default constructor promotion message.',
22        public int $code = 0,
23        public ?Throwable $previous = null
24    ) {
25        // 親クラス (Exception) のコンストラクタを呼び出します。
26        // プロモートされた引数は、$this->message などとして既にプロパティとして利用可能です。
27        parent::__construct($this->message, $this->code, $this->previous);
28    }
29}
30
31// 単体で動作可能なサンプルとして、クラスのインスタンス化とプロパティへのアクセスを示します。
32try {
33    // 1. デフォルト値を使用してインスタンスを生成
34    $defaultError = new ExampleConstructorPromotion();
35    echo "--- デフォルト値の例 ---\n";
36    echo "Message: " . $defaultError->message . PHP_EOL;
37    echo "Code: " . $defaultError->code . PHP_EOL;
38    echo "Previous: " . ($defaultError->previous ? $defaultError->previous->getMessage() : 'None') . PHP_EOL;
39
40    echo "\n";
41
42    // 2. 引数を指定してインスタンスを生成（PHP 8の名前付き引数を使用）
43    $customError = new ExampleConstructorPromotion(
44        message: 'A specific error occurred during processing.',
45        code: 12345
46    );
47    echo "--- カスタム値の例 ---\n";
48    echo "Message: " . $customError->message . PHP_EOL;
49    echo "Code: " . $customError->code . PHP_EOL;
50    echo "Previous: " . ($customError->previous ? $customError->previous->getMessage() : 'None') . PHP_EOL;
51
52    echo "\n";
53
54    // 3. 以前の Throwable オブジェクトを伴ってインスタンスを生成
55    $previousException = new RuntimeException("Underlying database connection failed.");
56    $chainedError = new ExampleConstructorPromotion(
57        message: 'Failed to complete transaction.',
58        code: 5000,
59        previous: $previousException
60    );
61    echo "--- 以前の例外を伴う例 ---\n";
62    echo "Message: " . $chainedError->message . PHP_EOL;
63    echo "Code: " . $chainedError->code . PHP_EOL;
64    echo "Previous Message: " . $chainedError->previous->getMessage() . PHP_EOL; // 前の例外のメッセージにアクセス
65
66} catch (Throwable $e) {
67    // このサンプルでは ExampleConstructorPromotion が Exception を継承しているので、
68    // ここで捕獲されることは通常ありませんが、予期せぬエラー発生時の一般的な処理です。
69    echo "Caught an unexpected generic error: " . $e->getMessage() . PHP_EOL;
70}

このサンプルコードは、PHP 8で導入された「コンストラクタプロモーション」という機能を具体的に示しています。これは、クラスのコンストラクタの引数に public などのアクセス修飾子を付けることで、その引数を自動的にクラスのプロパティとして定義し、同時に初期化する便利な機能です。これにより、プロパティの宣言とコンストラクタでの初期化処理の記述を省略でき、コードがより簡潔になります。

紹介されたリファレンスの Random\BrokenRandomEngineError クラスのコンストラクタと同じ引数シグネチャを持つ ExampleConstructorPromotion クラスでは、$message（エラーメッセージの文字列）、$code（エラーコード）、$previous（原因となった別の例外オブジェクト、オプション）といった引数が public プロパティとして自動的に作成されます。これらの引数はオブジェクトの初期値を設定するために使用され、コンストラクタは新しいオブジェクトを初期化する特殊なメソッドのため、明示的な戻り値はありません。インスタンス生成後には、$defaultError->message のように直接プロパティにアクセスし、その値を利用できます。

Copy
1<?php
2
3/**
4 * PHP 8で導入されたコンストラクタプロパティプロモーションを実演するためのカスタム例外クラス。
5 *
6 * このクラスは、Random\BrokenRandomEngineError のコンストラクタ引数シグネチャを模倣しつつ、
7 * PHP 8の新しい構文「コンストラクタプロパティプロモーション」を利用して、
8 * クラスのプロパティを簡潔に宣言・初期化する方法を示します。
9 *
10 * システムエンジニアを目指す初心者が、コンストラクタの書き方の進化を理解するのに役立ちます。
11 */
12class MyCustomRandomEngineException extends \Exception
13{
14    /**
15     * コンストラクタプロパティプロモーションの例。
16     *
17     * コンストラクタの引数にアクセス修飾子 (public, protected, private) を直接記述することで、
18     * 同名のクラスプロパティが自動的に宣言され、引数の値で初期化されます。
19     * これにより、冗長なプロパティ宣言とコンストラクタ内での代入を省略できます。
20     *
21     * @param string $message 例外メッセージ。publicプロパティとして宣言されます。
22     * @param int $code 例外コード。publicプロパティとして宣言されます。
23     * @param \Throwable|null $previous 前の例外（例外チェイン用）。publicプロパティとして宣言されます。
24     */
25    public function __construct(
26        public string $message = '',
27        public int $code = 0,
28        public ?\Throwable $previous = null
29    ) {
30        // 親クラスであるExceptionのコンストラクタを呼び出し、
31        // 例外としての基本的な振る舞いを初期化します。
32        // ここで渡す引数は、プロパティプロモーションによって設定される値と同一です。
33        parent::__construct($message, $code, $previous);
34    }
35
36    /**
37     * このカスタム例外のインスタンスが生成されたことを示すためのシンプルなメソッド。
38     * プロパティプロモーションによって定義されたプロパティにアクセスする方法も示します。
39     *
40     * @return string 例外の詳細情報。
41     */
42    public function getDebugInfo(): string
43    {
44        $info = "MyCustomRandomEngineException のインスタンスが生成されました。\n";
45        $info .= "  Message: '{$this->message}'\n";
46        $info .= "  Code: {$this->code}\n";
47        if ($this->previous !== null) {
48            $info .= "  Previous Exception: " . get_class($this->previous) . " ('{$this->previous->getMessage()}')\n";
49        } else {
50            $info .= "  Previous Exception: なし\n";
51        }
52        return $info;
53    }
54}
55
56// --- サンプルコードの実行部分 ---
57
58echo "--- コンストラクタプロパティプロモーションのデモンストレーション ---\n\n";
59
60// 1. 前の例外として利用する標準の例外を作成
61$previousError = new \RuntimeException("データベース接続に失敗しました。", 101);
62
63// 2. MyCustomRandomEngineException のインスタンスを生成
64//    コンストラクタプロパティプロモーションにより、
65//    $message, $code, $previous が自動的にクラスのpublicプロパティとして宣言・初期化されます。
66$myException = new MyCustomRandomEngineException(
67    "カスタム乱数エンジンが不安定な状態です。",
68    500,
69    $previousError
70);
71
72echo $myException->getDebugInfo();
73echo "\n";
74
75echo "--- インスタンスから直接プロパティにアクセス ---\n";
76// プロパティプロモーションによって public で宣言されたプロパティには、
77// インスタンスから直接アクセスできます。
78echo "例外メッセージ (直接アクセス): " . $myException->message . "\n";
79echo "例外コード (直接アクセス): " . $myException->code . "\n";
80if ($myException->previous !== null) {
81    echo "前の例外メッセージ (直接アクセス): " . $myException->previous->getMessage() . "\n";
82}
83echo "\n";
84
85// 3. 例外をスローし、try-catchブロックで捕捉する例
86try {
87    echo "--- 例外をスローしてみます ---\n";
88    throw $myException;
89} catch (MyCustomRandomEngineException $e) {
90    echo "--- MyCustomRandomEngineException を捕捉しました ---\n";
91    echo "捕捉された例外の型: " . get_class($e) . "\n";
92    echo "捕捉されたメッセージ (標準メソッド): " . $e->getMessage() . "\n";
93    echo "捕捉されたコード (標準メソッド): " . $e->getCode() . "\n";
94    if ($e->getPrevious() !== null) {
95        echo "捕捉された前の例外メッセージ (標準メソッド): " . $e->getPrevious()->getMessage() . "\n";
96    }
97    echo "\n";
98    // 捕捉後も、プロパティプロモーションで定義されたプロパティにアクセスできます。
99    echo "捕捉された例外のプロパティメッセージ (直接アクセス): " . $e->message . "\n";
100} catch (\Exception $e) {
101    echo "--- 予期せぬ標準例外を捕捉しました ---\n";
102    echo "メッセージ: " . $e->getMessage() . "\n";
103}
104
105echo "\n--- デモンストレーション終了 ---\n";
106?>

PHP 8で導入された「コンストラクタプロパティプロモーション」は、クラスのプロパティ宣言と初期化を簡潔に記述できる機能です。このサンプルコードは、MyCustomRandomEngineExceptionというカスタム例外クラスを通じて、この機能の利用方法を示しています。

このクラスの__constructメソッドは、PHPの標準クラスであるRandom\BrokenRandomEngineErrorのコンストラクタと同じ引数シグネチャを持ちます。注目すべきは、引数$message、$code、$previousの前にpublicというアクセス修飾子が付いている点です。これにより、これらの引数は自動的に同名のクラスプロパティとして宣言され、コンストラクタに渡された値で初期化されます。

具体的には、public string $message = ''と記述することで、MyCustomRandomEngineExceptionクラス内にpublic string $message;が自動的に定義され、インスタンス生成時に引数として渡された値が$this->messageに格納されます。同様に$codeと$previousも、それぞれpublic int $code;、public ?\Throwable $previous;として定義・初期化されます。これにより、従来のようにクラスの冒頭でプロパティを宣言し、コンストラクタ内で$this->message = $message;のように代入する手間が省け、コードがより簡潔になります。

__constructメソッドは、新しいオブジェクトを初期化するための特殊なメソッドであり、戻り値は持ちません。サンプルコードの実行部分では、この機能を使って生成された例外インスタンスから、プロパティに直接アクセスしたり、例外としてスロー・捕捉される動作を確認できます。