【PHP8.x】__constructメソッドの使い方

Copy
1<?php
2
3// PHP 8のコンストラクタプロパティプロモーションを活用したカスタム例外クラスです。
4// UnhandledMatchError::__construct が持つ引数パターン（$message, $code, $previous）を模倣し、
5// プロパティプロモーションによって簡潔に定義する方法を示します。
6class CustomAppException extends Exception
7{
8    /**
9     * カスタム例外のコンストラクタです。
10     *
11     * @param string $message 例外のメッセージ。`public`プロパティとして自動的に宣言され、初期化されます。
12     * @param int $code 例外のコード。`public`プロパティとして自動的に宣言され、初期化されます。
13     * @param Throwable|null $previous 前の例外（原因となった例外）。`public`プロパティとして自動的に宣言され、初期化されます。
14     *
15     * 【コンストラクタプロパティプロモーションの解説】
16     * PHP 8から導入されたこの機能により、コンストラクタの引数に直接、可視性 (public, protected, private) を付与することで、
17     * クラスのプロパティとして自動的に宣言され、引数の値で初期化されます。
18     * これにより、プロパティの宣言とコンストラクタ内での初期化という冗長なコードを省略でき、より簡潔なクラス定義が可能になります。
19     * 例えば、`public string $message`と書くだけで、`public string $message;`というプロパティ宣言と、
20     * `__construct`内で`$this->message = $message;`という初期化の両方が行われます。
21     */
22    public function __construct(
23        public string $message = "", // メッセージプロパティを宣言し、引数で初期化
24        public int $code = 0,       // コードプロパティを宣言し、引数で初期化
25        public ?Throwable $previous = null // 前の例外プロパティを宣言し、引数で初期化
26    ) {
27        // 親クラス（Exception）のコンストラクタも忘れずに呼び出します。
28        // プロパティプロモーションで宣言されたプロパティは、コンストラクタ本体が実行される前に初期化されるため、
29        // `$this->message`などの値を親コンストラクタに渡すことができます。
30        parent::__construct($this->message, $this->code, $this->previous);
31    }
32
33    /**
34     * 例外メッセージをより分かりやすい形式で返すカスタムメソッドです。
35     * プロパティプロモーションで定義された`$message`と`$code`プロパティを直接利用しています。
36     */
37    public function getFormattedErrorMessage(): string
38    {
39        return "アプリケーションエラー [コード: {$this->code}] {$this->message}";
40    }
41}
42
43/**
44 * プロパティプロモーションで定義されたカスタム例外の使用例を示す関数です。
45 *
46 * @param mixed $value 処理する値。nullの場合に例外をスローします。
47 */
48function processDataWithCustomException(mixed $value): void
49{
50    echo "--- データ処理の試行: " . (string)($value ?? 'NULL') . " ---" . PHP_EOL;
51    try {
52        if ($value === null) {
53            // CustomAppExceptionをスローします。
54            // UnhandledMatchError::__construct と同じ引数パターンでメッセージとコードを指定。
55            throw new CustomAppException("入力データが期待されたものではありません。", 2001);
56        }
57
58        // データが有効な場合の処理
59        echo "正常にデータを処理しました: " . $value . PHP_EOL;
60
61    } catch (CustomAppException $e) {
62        // CustomAppExceptionを捕捉し、プロパティにアクセスして情報を表示します。
63        echo "エラーを捕捉しました！" . PHP_EOL;
64
65        // プロパティプロモーションで宣言されたpublicプロパティに直接アクセスできます。
66        echo "  エラーメッセージ (プロパティ直接アクセス): " . $e->message . PHP_EOL;
67        echo "  エラーコード (プロパティ直接アクセス): " . $e->code . PHP_EOL;
68
69        // カスタムメソッドを使って、整形されたメッセージを取得することもできます。
70        echo "  整形済みエラー情報 (カスタムメソッド): " . $e->getFormattedErrorMessage() . PHP_EOL;
71
72        // 親クラス（Exception）から継承されたメソッドも利用可能です。
73        echo "  元のメッセージ (Exception::getMessage()経由): " . $e->getMessage() . PHP_EOL;
74        echo "  元のコード (Exception::getCode()経由): " . $e->getCode() . PHP_EOL;
75
76        if ($e->previous !== null) {
77            echo "  前の例外のメッセージ: " . $e->previous->getMessage() . PHP_EOL;
78        }
79    }
80    echo PHP_EOL; // 見やすくするための改行
81}
82
83// サンプルコードの実行
84echo "=== PHP 8 コンストラクタプロパティプロモーションのデモンストレーション ===" . PHP_EOL . PHP_EOL;
85
86// 正常なケース：例外はスローされません
87processDataWithCustomException("Hello PHP 8!");
88
89// エラーケース：CustomAppExceptionがスローされ、捕捉されます
90processDataWithCustomException(null);

このサンプルコードは、PHP 8から導入された「コンストラクタプロパティプロモーション」を活用し、カスタム例外クラスCustomAppExceptionを定義する例です。これはUnhandledMatchError::__constructが持つ引数パターン（メッセージ、コード、前の例外）を模倣しています。

コンストラクタプロパティプロモーションとは、コンストラクタの引数にpublicなどの可視性を直接付与することで、クラスのプロパティの宣言と、引数の値での初期化を同時に行う機能です。これにより、プロパティの定義とコンストラクタ内での代入が不要となり、コードがより簡潔になります。

例えば、public string $message = ""と記述するだけで、$messageというpublicプロパティが自動的に作成され、引数として渡された値で初期化されます。同様に$code（整数型）と$previous（Throwableまたはnull）もプロパティとして定義され、初期値が設定されます。

コンストラクタ内では、parent::__construct($this->message, $this->code, $this->previous);を呼び出し、親クラスであるExceptionのコンストラクタを初期化しています。プロパティプロモーションで定義されたプロパティは、コンストラクタ本体が実行される前に初期化されるため、$this->を用いて親クラスに値を渡すことが可能です。

CustomAppExceptionがスローされ捕捉された際には、$e->messageや$e->codeのように、プロパティプロモーションで定義されたプロパティに直接アクセスできます。また、親クラスExceptionから継承したgetMessage()やgetCode()メソッドも利用可能で、さらにgetFormattedErrorMessage()のようなカスタムメソッドで整形されたエラー情報を取得することもできます。これにより、詳細かつ柔軟なエラーハンドリングが実現できます。

Copy
1<?php
2
3/**
4 * カスタムのマッチエラークラスの例。
5 * UnhandledMatchError を継承し、親のコンストラクタを呼び出す方法を示します。
6 *
7 * PHP 8 の UnhandledMatchError は、match 式で一致するアームがない場合にスローされます。
8 * この例では、同様の挙動を模倣するカスタムエラーを作成し、
9 * そのコンストラクタで親 (UnhandledMatchError) のコンストラクタを呼び出す方法を示します。
10 */
11class MyCustomMatchError extends UnhandledMatchError
12{
13    /**
14     * 新しい MyCustomMatchError インスタンスを作成します。
15     *
16     * @param string $message エラーメッセージ。
17     * @param int $code エラーコード。
18     * @param Throwable|null $previous 以前に発生したThrowableオブジェクト。
19     */
20    public function __construct(string $message = "", int $code = 0, ?Throwable $previous = null)
21    {
22        // 親クラス (UnhandledMatchError) のコンストラクタを呼び出します。
23        // これにより、メッセージ、コード、以前の例外が適切に設定されます。
24        // これは、カスタムエラーや例外クラスを作成する際の一般的なパターンです。
25        parent::__construct($message, $code, $previous);
26
27        // 必要に応じて、ここにカスタムの初期化ロジックを追加できます。
28        // 例: $this->additionalInfo = "カスタム情報";
29    }
30}
31
32// コードの動作を示すための例:
33function demonstrateCustomMatchError(int $value): void
34{
35    try {
36        // カスタムエラークラスのインスタンスを生成し、スローします。
37        // ここで MyCustomMatchError の __construct メソッドが呼び出され、
38        // その中で親クラス UnhandledMatchError の __construct が呼び出されます。
39        throw new MyCustomMatchError(
40            "処理できない値が見つかりました: " . $value,
41            $value // エラーコードとして値を設定
42        );
43    } catch (MyCustomMatchError $e) {
44        // MyCustomMatchError をキャッチし、メッセージとコードを表示します。
45        echo "MyCustomMatchError をキャッチしました:\n";
46        echo "メッセージ: " . $e->getMessage() . "\n";
47        echo "コード: " . $e->getCode() . "\n";
48    } catch (Throwable $e) {
49        // その他の予期しないエラー
50        echo "予期しないエラーをキャッチしました: " . $e->getMessage() . "\n";
51    }
52}
53
54// 関数を呼び出してカスタムエラーの例を実行
55demonstrateCustomMatchError(10);
56echo "\n";
57demonstrateCustomMatchError(25);
58

PHP 8 で導入されたUnhandledMatchErrorクラスの__constructメソッドは、このエラークラスの新しいインスタンスが作成される際に自動的に実行される初期化処理を担います。これは、match式で一致する条件がなかった場合に発生するエラーに対し、メッセージ、エラーコード、そして必要であれば前の例外（Throwable）を設定するのが主な役割です。引数には、エラーの内容を説明する$message（文字列、省略可）、エラーの種類を識別する$code（整数、省略可）、そしてエラーの連鎖を追跡するための$previous（以前発生した例外オブジェクト、省略可）を受け取ります。コンストラクタは新しいオブジェクトを初期化するだけで、特定の値を返しません。

提供されたサンプルコードでは、MyCustomMatchErrorという独自のカスタムエラークラスがUnhandledMatchErrorを継承しています。このカスタムクラスのコンストラクタ内では、parent::__construct($message, $code, $previous);という行があります。これは、親クラスであるUnhandledMatchErrorのコンストラクタを明示的に呼び出すことで、基本的なエラー情報の初期化を親クラスに任せるための重要な記述です。これにより、MyCustomMatchErrorが持つべきメッセージやコードが適切に設定され、親クラスの基本的なエラー処理機能が利用可能になります。カスタム例外やエラークラスを作成する際には、親クラスのコンストラクタを呼び出すことが一般的なパターンであり、基底クラスの設計意図を維持するために不可欠です。この例では、demonstrateCustomMatchError関数を通じて、カスタムエラーが実際にスローされ、親クラスから継承した機能を使ってメッセージとコードが表示される様子を示しています。