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

Copy
1<?php
2
3/**
4 * DateInvalidOperationException を継承した独自の例外クラス。
5 * PHP 8 のコンストラクタプロパティプロモーションを使用して、
6 * 例外発生時の追加情報を管理します。
7 */
8class MyDateValidationException extends DateInvalidOperationException
9{
10    /**
11     * コンストラクタプロパティプロモーションの例:
12     * コンストラクタの引数に可視性修飾子 (public, protected, private) を付けることで、
13     * その引数が自動的に同じ名前のプロパティとして定義され、初期化されます。
14     * PHP 8.1以降で利用可能な `readonly` 修飾子を付けることで、
15     * そのプロパティは一度設定されると再代入できなくなり、データの整合性を保証します。
16     *
17     * @param string $message 例外メッセージ
18     * @param int $code 例外コード
19     * @param ?Throwable $previous 前の例外 (存在する場合)
20     * @param public readonly string $invalidDateValue 不正な日付の値。この引数がプロパティとして自動生成されます。
21     */
22    public function __construct(
23        string $message = '',
24        int $code = 0,
25        ?Throwable $previous = null,
26        public readonly string $invalidDateValue = '' // ここがPHP 8のプロパティプロモーションの例
27    ) {
28        // 親クラス (DateInvalidOperationException) のコンストラクタを呼び出します。
29        // これにより、基本的な例外情報 ($message, $code, $previous) が設定されます。
30        parent::__construct($message, $code, $previous);
31    }
32}
33
34/**
35 * 日付文字列を処理する関数。
36 * 特定の条件で MyDateValidationException をスローします。
37 *
38 * @param string $dateString 処理する日付文字列
39 * @throws MyDateValidationException 日付の書式が不正な場合
40 */
41function processDate(string $dateString): void
42{
43    // 不適切な日付文字列の例
44    if ($dateString === 'invalid-date-format') {
45        // 独自の例外クラスをインスタンス化し、プロパティプロモーションで追加情報を渡します。
46        // MyDateValidationException の __construct が呼び出され、
47        // $dateString が $this->invalidDateValue プロパティとして設定されます。
48        throw new MyDateValidationException(
49            "日付の書式が不正です。", // $message
50            1001, // $code
51            null, // $previous (今回は前の例外なし)
52            $dateString // プロパティプロモーションにより $this->invalidDateValue に割り当てられる
53        );
54    }
55    // ここで、実際の日付処理ロジックが続くことを想定します。
56    echo "日付 '{$dateString}' は有効です。\n";
57}
58
59// 例外の利用例: try-catch ブロックで例外を捕捉します。
60try {
61    processDate('2023-10-26');          // 有効な日付の例
62    processDate('invalid-date-format'); // 不正な日付の例（ここで例外が発生し、以下の行は実行されません）
63    processDate('2024-01-01');          // この行は実行されません
64} catch (MyDateValidationException $e) {
65    // 独自の例外クラスを捕捉し、プロパティプロモーションで定義された追加情報にアクセスします。
66    echo "--- MyDateValidationException をキャッチしました ---\n";
67    echo "メッセージ: " . $e->getMessage() . "\n";
68    echo "不正な日付値: " . $e->invalidDateValue . "\n"; // プロパティプロモーションで定義されたプロパティに直接アクセス
69    echo "例外コード: " . $e->getCode() . "\n";
70} catch (DateInvalidOperationException $e) {
71    // MyDateValidationException 以外の DateInvalidOperationException を捕捉する場合
72    echo "--- 汎用的な DateInvalidOperationException をキャッチしました ---\n";
73    echo "メッセージ: " . $e->getMessage() . "\n";
74    echo "例外コード: " . $e->getCode() . "\n";
75} catch (Throwable $e) {
76    // 上記で捕捉されなかったその他の全ての例外を捕捉します。
77    echo "--- 予期せぬエラーをキャッチしました ---\n";
78    echo "エラーメッセージ: " . $e->getMessage() . "\n";
79    echo "ファイル: " . $e->getFile() . " 行: " . $e->getLine() . "\n";
80}
81

DateInvalidOperationExceptionは、PHPで日付に関する操作中に不正な処理があった場合に発生する例外クラスです。このクラスの__constructメソッドは、例外オブジェクトが生成される際に自動的に呼び出される特別な初期化メソッドです。

引数$messageには具体的なエラーメッセージを、$codeにはエラーを識別するための数値を、そして$previousにはこの例外が発生する前に発生した別の例外オブジェクト（連鎖例外）を渡すことができます。コンストラクタはオブジェクトを初期化する役割のため、戻り値はありません。

サンプルコードでは、DateInvalidOperationExceptionを継承した独自のMyDateValidationExceptionクラスを通じて、PHP 8で導入された「コンストラクタプロパティプロモーション」の活用例を示しています。これは、コンストラクタの引数にpublicやprivateなどの可視性修飾子を付けることで、その引数が自動的にクラスのプロパティとして定義され、初期化される便利な機能です。これにより、初期化のためのコードがより簡潔に記述できるようになります。さらに、PHP 8.1以降で利用可能なreadonly修飾子を併用することで、一度設定されたプロパティの値を後から変更できないようにし、データの整合性を高めることができます。

この例では、不正な日付値$invalidDateValueをプロパティプロモーションで例外オブジェクトに持たせています。関数内で日付の書式が不正な場合にMyDateValidationExceptionをスローすると、try-catchブロックでその例外を捕捉し、$e->invalidDateValueのように、例外オブジェクトから不正な日付の具体的な情報に直接アクセスできるようになります。これにより、エラー発生時の詳細な状況を簡単に把握し、適切なエラー処理を行うことが可能になります。