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

Copy
1<?php
2
3// PHP 8 で導入された「コンストラクタプロパティ昇格 (Constructor Property Promotion)」の例です。
4// これは、コンストラクタの引数を直接クラスのプロパティとして定義・初期化する便利な機能です。
5// ClosedGeneratorException のコンストラクタ引数と同じシグネチャを持つカスタム例外クラスを定義し、
6// プロパティ昇格を使ってシンプルに初期化する方法を示します。
7
8/**
9 * ClosedGeneratorException のコンストラクタ引数シグネチャを模倣したカスタム例外クラス。
10 * PHP 8 のコンストラクタプロパティ昇格を利用して、プロパティの定義と初期化を簡略化しています。
11 */
12class MyCustomException extends Exception
13{
14    /**
15     * 新しいカスタム例外インスタンスを作成します。
16     *
17     * コンストラクタの引数に `public`, `protected`, `private` のアクセス修飾子を付けることで、
18     * 自動的にその名前と型のプロパティがクラスに定義され、引数の値で初期化されます。
19     * これがコンストラクタプロパティ昇格の主な特徴です。
20     *
21     * @param string $message 例外のメッセージ。
22     * @param int $code 例外コード。
23     * @param ?Throwable $previous 以前に発生した例外オブジェクト (例外チェイン用)。
24     */
25    public function __construct(
26        public string $message = '',
27        public int $code = 0,
28        public ?Throwable $previous = null
29    ) {
30        // 親クラス (Exception) のコンストラクタを呼び出す必要があります。
31        // プロパティ昇格によって $this->message, $this->code, $this->previous は既に初期化されています。
32        parent::__construct($this->message, $this->code, $this->previous);
33    }
34
35    /**
36     * カスタムエラーメッセージを生成するヘルパーメソッド。
37     */
38    public function getCustomFormattedMessage(): string
39    {
40        $formattedMessage = "カスタムエラー発生: " . $this->message;
41        if ($this->code !== 0) {
42            $formattedMessage .= " (コード: " . $this->code . ")";
43        }
44        if ($this->previous !== null) {
45            $formattedMessage .= " [以前の例外: " . get_class($this->previous) . " - " . $this->previous->getMessage() . "]";
46        }
47        return $formattedMessage;
48    }
49}
50
51// --- カスタム例外の使用例 ---
52
53echo "--- 基本的な例外の使用例 ---" . PHP_EOL;
54try {
55    // プロパティ昇格で定義されたMyCustomExceptionをスローします。
56    throw new MyCustomException("ファイルが見つかりませんでした", 404);
57} catch (MyCustomException $e) {
58    // 例外をキャッチし、プロパティに直接アクセスして情報を取得します。
59    echo "キャッチされた例外: " . get_class($e) . PHP_EOL;
60    echo "メッセージ (プロパティ): " . $e->message . PHP_EOL; // $e->message で直接アクセス
61    echo "コード (プロパティ): " . $e->code . PHP_EOL;       // $e->code で直接アクセス
62    echo "フォーマットされたメッセージ: " . $e->getCustomFormattedMessage() . PHP_EOL;
63    echo "標準のgetMessage(): " . $e->getMessage() . PHP_EOL;
64    echo "標準のgetCode(): " . $e->getCode() . PHP_EOL;
65}
66
67echo PHP_EOL . "--- 例外チェインの使用例 ---" . PHP_EOL;
68try {
69    // 内部で別の例外が発生し、それをMyCustomExceptionにラップします。
70    try {
71        // 意図的にエラーを発生させる
72        $result = 10 / 0; // DivisionByZeroError が発生
73    } catch (DivisionByZeroError $innerException) {
74        // 発生したエラーを$previous引数としてMyCustomExceptionに渡します。
75        throw new MyCustomException("計算処理中にエラーが発生しました", 500, $innerException);
76    }
77} catch (MyCustomException $e) {
78    echo "キャッチされた例外: " . get_class($e) . PHP_EOL;
79    echo "メッセージ: " . $e->message . PHP_EOL;
80    echo "コード: " . $e->code . PHP_EOL;
81    // 以前の例外 ($previousプロパティ) が存在するか確認し、情報を表示します。
82    if ($e->previous !== null) {
83        echo "以前の例外タイプ: " . get_class($e->previous) . PHP_EOL;
84        echo "以前の例外メッセージ: " . $e->previous->getMessage() . PHP_EOL;
85        echo "以前の例外コード: " . $e->previous->getCode() . PHP_EOL;
86    }
87    echo "フォーマットされたメッセージ: " . $e->getCustomFormattedMessage() . PHP_EOL;
88}
89

PHPのClosedGeneratorExceptionは、閉じられたジェネレータオブジェクトに対して操作を行おうとした際に発生する内部例外クラスです。そのコンストラクタである__constructメソッドは、この例外のインスタンスを初期化するために用いられます。引数には、例外の詳細を伝える文字列型の$message、例外の種類を示す整数型の$code、そしてこの例外が発生する前の原因となった別の例外オブジェクトを渡すための?Throwable $previousを受け取ります。これらはすべて省略可能で、それぞれ空文字、0、nullがデフォルト値です。このメソッドは、インスタンスを生成するのみでvoidを返します。

提供されたサンプルコードでは、PHP 8で導入された「コンストラクタプロパティ昇格」という機能を利用して、ClosedGeneratorExceptionのコンストラクタシグネチャを模倣したカスタム例外クラスMyCustomExceptionを簡潔に定義しています。この機能は、コンストラクタの引数にpublicなどのアクセス修飾子を記述するだけで、クラスのプロパティを自動的に宣言し、その引数の値で初期化できるため、冗長なプロパティ定義と代入の記述を省略できます。

コードでは、MyCustomExceptionのインスタンスをthrowで発生させ、try-catchブロックで捕捉する一般的な例外処理のパターンを示しています。捕捉した例外オブジェクトの$messageや$codeといった情報は、プロパティとして直接アクセスできるため、例外の内容を簡単に取得・処理できます。また、$previous引数を利用した例外チェインの例も含まれており、複数の例外が連鎖して発生した場合の原因追跡に役立つ利用方法が示されています。

Copy
1<?php
2
3/**
4 * ClosedGeneratorException::__construct() のサンプルコード
5 *
6 * このコードは、ClosedGeneratorException クラスのコンストラクタの
7 * 使い方を実演します。この例外は通常、PHPエンジンによって、
8 * 閉じられた（または終了した）ジェネレータに対して操作が試みられたときに
9 * 自動的にスローされます。
10 *
11 * ここでは、コンストラクタの引数 ($message, $code, $previous) の使用方法を
12 * 示すために、例外を手動でインスタンス化してスローします。
13 */
14try {
15    // 1. 以前発生した例外を模擬するオブジェクトを作成します。
16    //    これは $previous 引数に渡すことができます。
17    $previousException = new \RuntimeException("データ処理中に問題が発生しました。", 500);
18
19    // 2. ClosedGeneratorException の新しいインスタンスを生成します。
20    //    コンストラクタの引数:
21    //    - $message: 例外に関する説明メッセージ。
22    //    - $code: 例外の数値コード。
23    //    - $previous: この例外の前に発生した例外。
24    $closedGeneratorException = new \ClosedGeneratorException(
25        "ジェネレータは既に閉じられているか、終了しています。", // カスタムメッセージ
26        1001,                                              // カスタムエラーコード
27        $previousException                                // 前の例外
28    );
29
30    // 3. 生成した例外をスローして、catch ブロックで捕捉されることを示します。
31    throw $closedGeneratorException;
32
33} catch (\ClosedGeneratorException $e) {
34    // 4. ClosedGeneratorException を捕捉し、その詳細を表示します。
35    echo "--- ClosedGeneratorException を捕捉しました ---\n";
36    echo "メッセージ: " . $e->getMessage() . "\n";
37    echo "コード: " . $e->getCode() . "\n";
38    echo "ファイル: " . $e->getFile() . " (行: " . $e->getLine() . ")\n";
39
40    // 5. 以前の例外が存在する場合、その情報を表示します。
41    if ($e->getPrevious() !== null) {
42        echo "\n--- 以前の例外情報 ---\n";
43        echo "タイプ: " . get_class($e->getPrevious()) . "\n";
44        echo "メッセージ: " . $e->getPrevious()->getMessage() . "\n";
45        echo "コード: " . $e->getPrevious()->getCode() . "\n";
46    }
47} catch (\Throwable $e) {
48    // 6. その他の予期せぬ例外を捕捉します。
49    echo "--- 予期せぬ例外を捕捉しました ---\n";
50    echo "タイプ: " . get_class($e) . "\n";
51    echo "メッセージ: " . $e->getMessage() . "\n";
52}
53

このサンプルコードは、PHPのClosedGeneratorExceptionクラスのコンストラクタである__constructメソッドの基本的な使い方を解説しています。ClosedGeneratorExceptionは、閉じられた（既に処理を終えた）ジェネレータに対して何らかの操作を試みた際に、通常PHPエンジンによって自動的に発生する例外です。

__constructメソッドは、新しい例外オブジェクトを初期化する際に使用します。引数として、例外に関する詳細な説明文を指定する$message（文字列、省略可能）、例外の種類を識別するための数値コードを指定する$code（整数、省略可能）、そしてこの例外が発生する前に起こった別の例外を渡す$previous（Throwableインターフェースを実装したオブジェクトまたはnull、省略可能）を受け取ります。このメソッドはオブジェクトの初期化を行うため、具体的な値を返しません（void）。

サンプルコードでは、まずRuntimeExceptionを模擬的に作成し、これを$previous引数に渡す準備をします。次に、ClosedGeneratorExceptionオブジェクトを手動でインスタンス化し、カスタムメッセージ、エラーコード、そして前の例外オブジェクトを__constructメソッドの引数として渡しています。その後、throw文でこの例外を意図的に発生させ、catchブロックで捕捉することで、設定したメッセージやコード、前の例外情報が適切に取得できることを実演しています。

Copy
1<?php
2
3// PHP 8では、ClosedGeneratorException は Exception を継承しています。
4// ここでは、ClosedGeneratorException をさらに継承するカスタム例外クラスを定義します。
5// これにより、キーワード「parent::__construct」の具体的な使用方法を示すことができます。
6class MyCustomGeneratorClosedException extends ClosedGeneratorException
7{
8    /**
9     * MyCustomGeneratorClosedException クラスのコンストラクタ。
10     * システムエンジニアの皆さん、コンストラクタはクラスがインスタンス化される際に
11     * 自動的に実行される特殊なメソッドで、初期化処理に使われます。
12     *
13     * @param string $message 例外に関する説明メッセージ
14     * @param int $code 例外のコード (通常は0だが、エラーの種類を区別するために使用)
15     * @param Throwable|null $previous この例外の前に発生した別の例外 (例外チェイン用)
16     */
17    public function __construct(string $message = '', int $code = 0, ?Throwable $previous = null)
18    {
19        // ここがキーワード「parent::__construct」の最も重要な部分です。
20        // 親クラス (この場合は ClosedGeneratorException) のコンストラクタを呼び出しています。
21        // これにより、親クラスの初期化ロジックが実行され、
22        // 例外メッセージやコードなどが正しく設定されます。
23        parent::__construct($message, $code, $previous);
24
25        // 必要であれば、このカスタム例外クラス固有の追加の初期化処理をここ記述できます。
26        // 例: error_log("カスタムジェネレータ例外が発生しました: " . $message);
27    }
28}
29
30// サンプルとして、簡単なジェネレータ関数を定義します。
31function myGenerator()
32{
33    yield '最初の要素';
34    yield '次の要素';
35}
36
37// ジェネレータをインスタンス化します。
38$gen = myGenerator();
39
40// ジェネレータを一度使い果たします。
41// これにより、ジェネレータは「閉じられた」状態になります。
42foreach ($gen as $item) {
43    echo "ジェネレータ出力: " . $item . "\n";
44}
45
46echo "ジェネレータは現在閉じられています。\n";
47
48try {
49    // 閉じられたジェネレータに対して何らかの操作（例えば値を送る）を試みると、
50    // 内部的に ClosedGeneratorException がスローされる可能性があります。
51    // ここでは、`parent::__construct` の使用例を示すために、
52    // 定義したカスタム例外を明示的にスローしてみます。
53    throw new MyCustomGeneratorClosedException(
54        "閉じられたジェネレータに対して操作を試みました。",
55        1001 // カスタムエラーコード
56    );
57
58} catch (MyCustomGeneratorClosedException $e) {
59    // 作成したカスタム例外がキャッチされます。
60    // ここで例外を処理し、エラーログの記録などを行います。
61    echo "キャッチされたカスタム例外: " . $e->getMessage() . "\n";
62    echo "例外コード: " . $e->getCode() . "\n";
63    echo "発生ファイル: " . $e->getFile() . " (行: " . $e->getLine() . ")\n";
64} catch (ClosedGeneratorException $e) {
65    // もしPHP内部で直接 ClosedGeneratorException がスローされた場合もキャッチできます。
66    echo "キャッチされた標準の ClosedGeneratorException: " . $e->getMessage() . "\n";
67} catch (Exception $e) {
68    // その他の一般的な例外をキャッチするフォールバック。
69    echo "キャッチされた一般的な例外: " . $e->getMessage() . "\n";
70}

PHPのClosedGeneratorExceptionクラスの__constructメソッドは、ジェネレータが閉じられた後に操作が試みられた際に発生する例外を初期化するための特別なメソッドです。このメソッドは、ClosedGeneratorExceptionのインスタンスが新しく作成される際に自動的に実行されます。

引数には、例外に関する詳細な説明文を設定するstring $message、エラーの種類を識別するための数値であるint $code、そしてこの例外の前に発生した別の例外を参照する?Throwable $previousを受け取ります。これらを通じて例外オブジェクトのメッセージやコード、例外の連鎖情報が初期化されます。このメソッドは初期化処理を行うため、特定の値を返さず、戻り値はvoidとなります。

サンプルコードのように、ClosedGeneratorExceptionを継承して独自のカスタム例外クラスを作る場合、カスタム例外クラスのコンストラクタ内でparent::__construct($message, $code, $previous);と記述することが非常に重要です。この記述により、継承元のClosedGeneratorExceptionが持つ基本的な初期化ロジックが呼び出され、親クラスで定義された例外の振る舞いやプロパティが正しく設定されます。parent::__constructの呼び出しは、継承されたクラスの整合性を保ち、カスタム例外が標準的な例外と同様に機能するために不可欠な処理です。

Copy
1<?php
2
3// ClosedGeneratorException は PHP の組み込み例外クラスです。
4// 通常、閉じられたジェネレータに対して操作を行った際にPHPエンジンによってスローされます。
5// このサンプルコードでは、コンストラクタの引数の使い方を明示的に示すため、
6// 意図的に ClosedGeneratorException を作成し、スローしています。
7
8/**
9 * 前の例外として使用するカスタム例外クラス。
10 * PHPの組み込み例外（例: RuntimeException）を継承して定義します。
11 */
12class CustomContextException extends RuntimeException {}
13
14/**
15 * ClosedGeneratorException のコンストラクタ使用方法を示す関数。
16 * システムエンジニアを目指す初心者向けに、例外の作成と捕捉の基本を示します。
17 */
18function demonstrateClosedGeneratorExceptionConstruction(): void
19{
20    echo "--- ClosedGeneratorException コンストラクタ使用例 ---\n";
21
22    try {
23        // まず、前の例外として使用する例外のインスタンスを作成します。
24        // これは、より低レベルで発生した問題を表現するのに役立ちます。
25        $previousException = new CustomContextException(
26            'ジェネレータの内部処理で予期せぬエラーが発生しました。',
27            500 // 前の例外の特定コード
28        );
29
30        // 新しい ClosedGeneratorException インスタンスを作成し、スローします。
31        // __construct メソッドの全ての引数（$message, $code, $previous）を指定しています。
32        // $message: 例外に関する具体的な説明メッセージ。
33        // $code: 例外を識別するための数値コード。
34        // $previous: この例外を引き起こす原因となった前の例外オブジェクト（オプション）。
35        throw new ClosedGeneratorException(
36            '閉じられたジェネレータに対して不正な操作が試行されました。', // 例外のメッセージ
37            1001,                                                    // 例外のコード
38            $previousException                                       // 前の例外オブジェクト
39        );
40
41    } catch (ClosedGeneratorException $e) {
42        // ClosedGeneratorException が捕捉された場合の処理。
43        // 例外オブジェクトからメッセージやコードなどの情報を取得できます。
44        echo "ClosedGeneratorException を捕捉しました。\n";
45        echo "  メッセージ: " . $e->getMessage() . "\n";
46        echo "  コード: " . $e->getCode() . "\n";
47
48        // 前の例外が存在するかどうかを確認し、存在すればその情報を表示します。
49        if ($e->getPrevious() !== null) {
50            echo "  前の例外情報:\n";
51            echo "    クラス: " . get_class($e->getPrevious()) . "\n";
52            echo "    メッセージ: " . $e->getPrevious()->getMessage() . "\n";
53            echo "    コード: " . $e->getPrevious()->getCode() . "\n";
54        } else {
55            echo "  前の例外は設定されていません。\n";
56        }
57    }
58
59    echo "--- デモンストレーション終了 ---\n";
60}
61
62// 上記のデモンストレーション関数を実行します。
63demonstrateClosedGeneratorExceptionConstruction();
64

ClosedGeneratorExceptionは、PHPでジェネレータが既に閉じられている状態で操作が行われた際に発生する組み込みの例外クラスです。ここで紹介する__constructメソッドは、このClosedGeneratorExceptionの新しいインスタンスを作成し、初期化するために使用されます。

引数$messageには、例外の詳細な説明を文字列で指定します。これは何が問題だったのかを具体的に伝える情報となります。$codeには、例外を識別するための数値コードを設定でき、システム内で特定の例外を区別するのに役立ちます。最後の引数$previousはオプションで、現在の例外が別の例外によって引き起こされた場合、その元の例外オブジェクトを渡すことで、問題の根本原因をたどることが可能になります。

この__constructメソッドの戻り値はvoidです。これは、メソッドが特定の値を返さず、オブジェクトの初期化という目的のみを果たすことを意味します。サンプルコードでは、これらの引数全てを用いてClosedGeneratorExceptionを明示的に作成し、それをtry-catchブロックで捕捉することで、例外が持つメッセージ、コード、そして前の例外情報を取得する方法を示しています。これにより、例外発生時の情報の伝達と処理の基本を理解することができます。