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

Copy
1<?php
2
3/**
4 * PHP 8 で導入されたコンストラクタプロモーションを利用したユーザープロフィールクラスの例です。
5 *
6 * コンストラクタプロモーションは、コンストラクタの引数にアクセス修飾子 (public, protected, private) を
7 * 付けることで、プロパティの定義と初期化を同時に行うことができる構文シュガーです。
8 * これにより、コードの記述量を減らし、簡潔にクラスを定義できます。
9 */
10class UserProfile
11{
12    /**
13     * コンストラクタでプロパティを定義・初期化します。
14     * 引数にアクセス修飾子を付けることで、クラスプロパティとして扱われます。
15     *
16     * @param string $name       ユーザーの名前 (publicプロパティ)
17     * @param string $email      ユーザーのメールアドレス (privateプロパティ)
18     * @param int    $age        ユーザーの年齢 (protectedプロパティ)
19     * @param bool   $isVerified ユーザーが認証済みか (privateプロパティ、デフォルト値あり)
20     *
21     * @throws ReflectionException プロフィールデータが無効な場合にスローされます。
22     *                             ReflectionExceptionは通常、リフレクションAPIの不適切な使用時にスローされますが、
23     *                             ここではリファレンス情報に合わせて、コンストラクタの引数バリデーション失敗の例として使用しています。
24     *                             (引数: string $message = '', int $code = 0, ?Throwable $previous = null)
25     */
26    public function __construct(
27        public string $name,
28        private string $email,
29        protected int $age,
30        private bool $isVerified = false
31    ) {
32        // コンストラクタプロモーションにより、$this->name, $this->email, $this->age, $this->isVerified が
33        // 自動的に定義され、引数の値で初期化されます。
34
35        // コンストラクタ内で、プロパティのバリデーションや追加のロジックを記述できます。
36        if (!filter_var($this->email, FILTER_VALIDATE_EMAIL)) {
37            throw new ReflectionException(
38                "無効なメールアドレス形式です: '{$this->email}'", // エラーメッセージ
39                1001 // エラーコード
40                // null // previous は指定しない場合、デフォルトで null となります
41            );
42        }
43
44        if ($this->age < 0 || $this->age > 150) {
45            throw new ReflectionException(
46                "年齢が無効です: '{$this->age}'",
47                1002
48            );
49        }
50    }
51
52    /**
53     * ユーザープロフィールの概要を返します。
54     * privateプロパティである$emailもクラス内部のメソッドからアクセス可能です。
55     *
56     * @return string プロフィール概要
57     */
58    public function getProfileSummary(): string
59    {
60        $status = $this->isVerified ? 'Verified' : 'Unverified';
61        return "Name: {$this->name}, Email: {$this->email}, Age: {$this->age}, Status: {$status}.";
62    }
63
64    /**
65     * ユーザーのメールアドレスを返します。
66     *
67     * @return string メールアドレス
68     */
69    public function getEmail(): string
70    {
71        return $this->email;
72    }
73}
74
75// --- サンプルコードの実行 ---
76
77echo "--- 正常なUserProfileインスタンスの作成例 ---" . PHP_EOL;
78try {
79    // 正常なデータでインスタンスを作成
80    $user1 = new UserProfile('Alice', 'alice@example.com', 30, true);
81    echo $user1->getProfileSummary() . PHP_EOL;
82    echo "AliceのEmail: " . $user1->getEmail() . PHP_EOL;
83    // publicプロパティは直接アクセス可能
84    echo "Aliceの名前 (publicプロパティ): " . $user1->name . PHP_EOL;
85} catch (ReflectionException $e) {
86    echo "エラー: " . $e->getMessage() . " (コード: " . $e->getCode() . ")" . PHP_EOL;
87}
88
89echo PHP_EOL . "--- 無効なメールアドレスで例外が発生する例 ---" . PHP_EOL;
90try {
91    // 無効なメールアドレスでインスタンスを作成
92    $user2 = new UserProfile('Bob', 'invalid-email', 25);
93    echo $user2->getProfileSummary() . PHP_EOL;
94} catch (ReflectionException $e) {
95    echo "エラー: " . $e->getMessage() . " (コード: " . $e->getCode() . ")" . PHP_EOL;
96}
97
98echo PHP_EOL . "--- 無効な年齢で例外が発生する例 ---" . PHP_EOL;
99try {
100    // 無効な年齢でインスタンスを作成
101    $user3 = new UserProfile('Charlie', 'charlie@example.com', 200);
102    echo $user3->getProfileSummary() . PHP_EOL;
103} catch (ReflectionException $e) {
104    echo "エラー: " . $e->getMessage() . " (コード: " . $e->getCode() . ")" . PHP_EOL;
105}
106
107?>

このPHPサンプルコードは、PHP 8で導入された「コンストラクタプロモーション」と、エラー通知に利用されるReflectionExceptionの使用方法を示しています。コンストラクタプロモーションは、クラスのコンストラクタ引数にpublicやprivateといったアクセス修飾子を付けることで、プロパティの定義と初期化を同時に行える便利な機能です。これにより、記述量を減らし、クラスをより簡潔に定義できます。

UserProfileクラスのコンストラクタでは、nameやemailなどのプロパティがコンストラクタプロモーションにより自動的に定義され、引数の値で初期化されます。コンストラクタ内では、渡されたメールアドレスと年齢のバリデーション（入力値の検証）を行っています。もし値が無効な場合は、ReflectionExceptionをスローしてエラーを通知する仕組みです。

ReflectionExceptionのコンストラクタは、string $messageで具体的なエラー内容、int $codeでエラーを識別するための数値を指定できます。ここでは、通常リフレクションAPIの不適切な使用時にスローされるこの例外を、コンストラクタの引数バリデーション失敗の例として利用し、エラーの原因と種類を明確に伝えています。戻り値は特にありません。

コードの実行部分では、try-catchブロックを使用して、正常なデータでインスタンスを作成する例と、無効なデータでReflectionExceptionがスローされ、そのエラーメッセージとコードを捕捉して表示する例が示されており、例外処理の基本的な流れを理解することができます。

Copy
1<?php
2
3/**
4 * PHP 8以降で導入されたコンストラクタプロパティプロモーションを使用するカスタム例外クラス。
5 * ReflectionException を継承することで、リフレクション操作に関連する特定の例外であることを示します。
6 */
7class MyCustomReflectionException extends ReflectionException
8{
9    /**
10     * コンストラクタプロパティプロモーションの例。
11     * コンストラクタの引数にアクセス修飾子（public, protected, private）を付けることで、
12     * 自動的にその名前のプロパティが作成され、引数の値で初期化されます。
13     *
14     * @param string $message 例外メッセージ。親クラス（ReflectionException）に渡されます。
15     * @param int $code 例外コード。親クラスに渡されます。
16     * @param ?Throwable $previous 以前の例外。親クラスに渡されます。
17     * @param string $extraInfo このカスタム例外に固有の追加情報。プロパティとして自動的に定義されます。
18     */
19    public function __construct(
20        string $message = '',
21        int $code = 0,
22        ?Throwable $previous = null,
23        // PHP 8のコンストラクタプロパティプロモーションを利用。
24        // 引数にアクセス修飾子を付けることで、自動的に同名のプロパティが作成されます。
25        public string $extraInfo = '詳細情報なし'
26    ) {
27        // 親クラスである ReflectionException のコンストラクタを呼び出し、
28        // 例外の基本的なメッセージ、コード、前の例外を設定します。
29        parent::__construct($message, $code, $previous);
30    }
31
32    /**
33     * カスタムプロパティ extraInfo のゲッターメソッド。
34     * プロパティに直接アクセスすることも可能ですが、ゲッターを提供することも一般的です。
35     *
36     * @return string 追加情報
37     */
38    public function getExtraInfo(): string
39    {
40        return $this->extraInfo;
41    }
42}
43
44/**
45 * MyCustomReflectionException をスローして捕捉するデモンストレーション関数。
46 * 単体で動作可能なコードとして、例外の発生と処理の例を示します。
47 */
48function demonstrateCustomReflectionException(): void
49{
50    echo "--- カスタムReflection例外のデモンストレーション ---\n\n";
51
52    try {
53        // MyCustomReflectionException をスローします。
54        // ここで渡される引数は、コンストラクタプロパティプロモーションによってプロパティとしても設定されます。
55        throw new MyCustomReflectionException(
56            "クラスが見つかりませんでした", // $message
57            1001,                         // $code
58            null,                         // $previous
59            "指定されたクラス名 'NonExistentClass' が無効です。" // $extraInfo (プロパティプロモーション)
60        );
61    } catch (MyCustomReflectionException $e) {
62        // カスタムReflection例外を捕捉します。
63        echo "MyCustomReflectionException を捕捉しました:\n";
64        echo "  メッセージ: " . $e->getMessage() . "\n"; // 親クラスから継承されたメッセージ
65        echo "  コード: " . $e->getCode() . "\n";       // 親クラスから継承されたコード
66        // コンストラクタプロパティプロモーションによって作成されたプロパティに直接アクセスします。
67        echo "  追加情報 (プロパティ): " . $e->extraInfo . "\n";
68        // または、カスタム定義したゲッターメソッドを介してアクセスします。
69        echo "  追加情報 (getter): " . $e->getExtraInfo() . "\n\n";
70    } catch (Throwable $e) {
71        // その他の予期せぬ例外を捕捉する一般的なパターン。
72        // この例では MyCustomReflectionException が捕捉されるため、ここには到達しません。
73        echo "予期せぬ例外を捕捉しました:\n";
74        echo "  メッセージ: " . $e->getMessage() . "\n";
75        echo "  コード: " . $e->getCode() . "\n\n";
76    }
77
78    echo "--- デモンストレーション終了 ---\n";
79}
80
81// デモンストレーション関数を実行します。
82demonstrateCustomReflectionException();

PHPのReflectionExceptionクラスは、リフレクション操作に関する問題が発生した際に利用される例外クラスです。そのコンストラクタ__constructは、例外オブジェクトを生成する際に、エラーメッセージ、コード、そして前の例外を設定するために使われます。

PHP 8以降で導入された「コンストラクタプロパティプロモーション」は、コンストラクタの引数にpublicなどのアクセス修飾子を付けることで、その引数と同じ名前のプロパティを自動的に作成し、引数の値で初期化する便利な機能です。これにより、クラス定義がより簡潔になります。

サンプルコードでは、MyCustomReflectionExceptionクラスがReflectionExceptionを継承しています。このカスタム例外のコンストラクタでは、public string $extraInfoという引数にプロパティプロモーションを適用しています。これにより、$extraInfoが自動的にクラスのプロパティとなり、例外生成時に渡された追加情報を保持します。

引数$messageはエラー内容を示す文字列、$codeはエラー種別の数値、$previousは現在の例外より前に発生した例外オブジェクトを親クラスのコンストラクタに渡し、基本的な例外情報を設定します。$extraInfoはこのカスタム例外に固有の追加情報を渡すために使われます。コンストラクタはオブジェクトを初期化するメソッドのため、明示的な戻り値はありません。

デモンストレーション関数では、このカスタム例外をスローし、try-catchブロックで捕捉しています。捕捉した例外オブジェクト$eから、getMessage()などで基本情報にアクセスできるほか、プロパティプロモーションで定義された$e->extraInfoプロパティを通してカスタムの追加情報を直接取得できることを示しています。