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

Copy
1<?php
2
3/**
4 * PHP 8 の constructor property promotion を使用したカスタム例外クラスの例です。
5 * DateMalformedIntervalStringException のコンストラクタ引数と類似の構造を持ち、
6 * 引数を直接クラスのプロパティとして宣言・初期化します。
7 */
8class MyCustomDateException extends Exception
9{
10    /**
11     * コンストラクタプロパティプロモーションにより、引数が自動的にクラスのプロパティとして定義されます。
12     * アクセス修飾子 (public, protected, private) を引数の前に記述することで機能します。
13     *
14     * @param string $message  例外メッセージ
15     * @param int $code        例外コード
16     * @param ?Throwable $previous 前の例外 (存在する場合)
17     */
18    public function __construct(
19        public string $message = "",
20        public int $code = 0,
21        public ?Throwable $previous = null
22    ) {
23        // 親クラスである Exception のコンストラクタを呼び出し、
24        // 例外の基本的な機能（メッセージ、コード、前の例外の設定）を委譲します。
25        parent::__construct($message, $code, $previous);
26    }
27
28    /**
29     * 例外に関する追加情報を取得するメソッド。
30     */
31    public function getDetailedInfo(): string
32    {
33        return "詳細情報: " . $this->message . " (Code: " . $this->code . ")";
34    }
35}
36
37// このカスタム例外クラスの使用例
38try {
39    // MyCustomDateException のインスタンスを生成し、スローします。
40    // コンストラクタ引数 ($message, $code) が自動的に public プロパティとして設定されます。
41    throw new MyCustomDateException("日付文字列の解析に失敗しました。", 1001);
42} catch (MyCustomDateException $e) {
43    echo "キャッチされた例外:" . PHP_EOL;
44    echo "メッセージ: " . $e->message . PHP_EOL; // public プロパティとして直接アクセス可能
45    echo "コード: " . $e->code . PHP_EOL;       // public プロパティとして直接アクセス可能
46    echo "ファイル: " . $e->getFile() . ", 行: " . $e->getLine() . PHP_EOL;
47    echo $e->getDetailedInfo() . PHP_EOL;
48}
49
50echo PHP_EOL;
51
52// 別の使用例 (前の例外を含む場合)
53try {
54    $previousError = new InvalidArgumentException("無効な入力データ。", 500);
55    throw new MyCustomDateException("処理中に予期せぬエラーが発生。", 1002, $previousError);
56} catch (MyCustomDateException $e) {
57    echo "別のキャッチされた例外:" . PHP_EOL;
58    echo "メッセージ: " . $e->message . PHP_EOL;
59    echo "コード: " . $e->code . PHP_EOL;
60    if ($e->previous !== null) {
61        echo "前の例外メッセージ: " . $e->previous->getMessage() . PHP_EOL;
62        echo "前の例外コード: " . $e->previous->getCode() . PHP_EOL;
63    }
64    echo $e->getDetailedInfo() . PHP_EOL;
65}

PHP 8のDateMalformedIntervalStringExceptionクラスの__constructメソッドは、日付や時刻に関連する形式不正のエラーが発生した際に、その詳細を格納した例外オブジェクトを生成します。引数としては、例外の理由を説明する文字列$message、エラーの種類を示す整数値$code、そしてこの例外が別の例外によって引き起こされた場合にその元の例外オブジェクト$previousを指定できます。これらはすべてオプションであり、省略可能です。コンストラクタであるため、このメソッド自体が値を戻すことはありません。

サンプルコードで示されているMyCustomDateExceptionは、PHP 8で導入された「コンストラクタプロパティプロモーション」を活用したカスタム例外の例です。この機能を利用すると、コンストラクタの引数にpublic、protected、またはprivateといったアクセス修飾子を記述するだけで、その引数が自動的に同名のクラスプロパティとして定義され、かつ初期化されます。これにより、プロパティの宣言とコンストラクタ内での明示的な代入が不要となり、コードがより簡潔になります。MyCustomDateExceptionでは、DateMalformedIntervalStringExceptionのコンストラクタと同様に、メッセージやコードなどを直接publicプロパティとして受け取り、利用できるようにしています。また、親クラスExceptionのコンストラクタを呼び出すことで、例外としての基本的な振る舞いを保証しています。