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

Copy
1<?php
2
3/**
4 * DateObjectErrorのコンストラクタを模倣し、
5 * キーワード「コンストラクタプロパティプロモーション」を説明するためのクラスです。
6 */
7class CustomDateError
8{
9    // PHP 8.0 で導入された「コンストラクタプロパティプロモーション」を使用します。
10    // コンストラクタの引数に `public` などの可視性修飾子を付けることで、
11    // 同名のプロパティ宣言と、コンストラクタ内での値の代入を自動的に行います。
12    // これにより、冗長な記述を省略できます。
13    //
14    // PHP 8.1 からは `readonly` も併用でき、一度設定した値を変更不可にできます。
15    public function __construct(
16        public readonly string $message = '',
17        public readonly int $code = 0,
18        // nullable な型も同様にプロモーションできます。
19        public readonly ?Throwable $previous = null
20    ) {
21        // プロパティへの代入は自動で行われるため、コンストラクタの本体は空のままで問題ありません。
22    }
23}
24
25// クラスのインスタンスを作成します。
26// コンストラクタに渡した引数が、そのまま同名の public プロパティに設定されます。
27$error = new CustomDateError('日付の形式が不正です。', 101);
28
29// プロモーションによって自動的に作成されたプロパティにアクセスし、値を表示します。
30echo 'Message: ' . $error->message . PHP_EOL;
31echo 'Code: ' . $error->code . PHP_EOL;
32echo 'Previous: ' . ($error->previous === null ? 'null' : 'Not null') . PHP_EOL;
33
34// readonly プロパティのため、再代入しようとするとエラーが発生します。
35// $error->message = '新しいメッセージ'; // Fatal error: Uncaught Error: Cannot modify readonly property
36
37?>

DateObjectErrorクラスの__constructメソッドは、新しいエラーオブジェクトを生成する際に自動的に呼び出されるコンストラクタです。このメソッドは、エラーメッセージを指定する文字列の$message、エラーの種類を識別するための整数の$code、そしてエラーの原因となった直前の例外を格納する$previousという3つの引数を取ります。これらの引数にはデフォルト値が設定されているため、必要に応じて省略できます。コンストラクタのため、特定の戻り値はありません。

サンプルコードでは、この仕組みを模倣し、PHP 8.0から導入された「コンストラクタプロパティプロモーション」という機能を説明しています。これは、コンストラクタの引数にpublicなどのアクセス修飾子を付けることで、同名のプロパティ宣言と、引数の値をプロパティへ代入する処理を自動的に行う機能です。これにより、従来はクラス内に記述する必要があったプロパティ宣言と代入文を省略でき、コードが非常に簡潔になります。

さらに、PHP 8.1からはreadonly修飾子も併用できます。サンプルコードのようにpublic readonlyと記述すると、プロパティは公開されますが、一度初期化された後は値を変更できなくなり、より安全なプログラムを作成できます。

Copy
1<?php
2
3/**
4 * カスタム日付エラークラス
5 * 
6 * PHPの組み込みクラス DateObjectError を継承しています。
7 */
8class InvalidDateFormatError extends DateObjectError
9{
10    /**
11     * コンストラクタ
12     * 
13     * 受け取った日付フォーマット文字列を元にエラーメッセージを生成し、
14     * parent::__construct() を呼び出して、親クラス（DateObjectError）の
15     * コンストラクタに処理を委譲します。
16     * これにより、例外の基本的な情報（メッセージやコード）が正しく設定されます。
17     * 
18     * @param string $invalidFormat 無効な日付フォーマット
19     * @param int $code エラーコード (オプション)
20     * @param ?Throwable $previous 前の例外 (オプション)
21     */
22    public function __construct(string $invalidFormat, int $code = 0, ?Throwable $previous = null)
23    {
24        // 親クラスに渡すためのエラーメッセージを組み立てる
25        $message = "指定された日付フォーマット '{$invalidFormat}' は無効です。";
26
27        // 親クラスのコンストラクタを呼び出す
28        parent::__construct($message, $code, $previous);
29    }
30}
31
32// --- サンプルコードの実行部分 ---
33try {
34    $userInputFormat = 'Y/m/d H:i:s:u:v'; // 不正なフォーマットの例
35
36    // ここでフォーマットの検証を行い、問題があればカスタム例外をスローする想定
37    if (str_contains($userInputFormat, ':v')) { // 簡易的なチェック
38        throw new InvalidDateFormatError($userInputFormat, 1001);
39    }
40
41    echo "日付フォーマットは正常です。";
42
43} catch (InvalidDateFormatError $e) {
44    // スローされたカスタム例外をキャッチする
45    echo "エラーが発生しました。\n";
46    echo "エラーコード: " . $e->getCode() . "\n";
47    echo "メッセージ: " . $e->getMessage() . "\n";
48}

PHPのDateObjectErrorは、日付や時刻の操作において問題が発生した際に使用される、標準的なエラー（例外）クラスです。このクラスの__constructメソッドは、新しいDateObjectErrorオブジェクトが作成されるときに自動的に実行される特別なメソッドで、エラーの初期設定を行います。

このコンストラクタは、エラーの内容を説明する$message（文字列）、エラーの種類を識別する$code（整数）、そしてエラーの連鎖を示す先行の例外オブジェクト$previous（Throwable型、またはnull）を引数として受け取ります。これらの情報により、エラー発生時に詳細な状況を把握し、適切な処理を行うことが可能になります。このメソッドは、初期化を行うため、値を返しません。

サンプルコードでは、DateObjectErrorを継承してInvalidDateFormatErrorという独自の例外クラスを定義しています。このカスタム例外のコンストラクタ内でparent::__constructを呼び出すことにより、親クラスであるDateObjectErrorのコンストラクタに、組み立てたエラーメッセージやコードを渡して処理を委ねています。これにより、カスタムエラーもPHP標準のエラーと同じく、メッセージやコードといった基本的な情報が正しく設定され、try-catchブロックで一貫したエラーハンドリングが行えるようになります。これは、プログラムの信頼性を高める上で非常に重要なパターンです。