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

Copy
1<?php
2
3/**
4 * PHP 8.0で導入された「コンストラクタプロパティのプロモーション」のサンプルです。
5 * この機能を使うと、コンストラクタの引数に可視性(public, protected, private)を
6 * 付けるだけで、プロパティの宣言とコンストラクタ内での代入を省略できます。
7 */
8class CustomDateException extends DateException
9{
10    /**
11     * コンストラクタ
12     *
13     * @param DateTimeImmutable $errorDate この例外が独自に持つ、エラーが発生した日時
14     * @param string $message 親クラスに渡す例外メッセージ
15     * @param int $code 親クラスに渡す例外コード
16     * @param ?Throwable $previous 親クラスに渡す、前に発生した例外
17     */
18    public function __construct(
19        // publicを付けることで、$errorDateプロパティが自動的に宣言され、
20        // インスタンス化の際に渡された値が代入されます。
21        public readonly DateTimeImmutable $errorDate,
22        string $message = '',
23        int $code = 0,
24        ?Throwable $previous = null
25    ) {
26        // 親クラス(DateException)のコンストラクタを呼び出します。
27        parent::__construct($message, $code, $previous);
28    }
29}
30
31try {
32    // 何らかの日付関連エラーが発生したと仮定し、カスタム例外をスローします。
33    throw new CustomDateException(
34        new DateTimeImmutable('now'), // プロモーションされたプロパティ用の引数
35        "無効な日付形式です。",
36        1001
37    );
38} catch (CustomDateException $e) {
39    // 捕捉した例外オブジェクトのプロパティとメソッドにアクセスします。
40    echo "エラーメッセージ: " . $e->getMessage() . PHP_EOL;
41    echo "エラーコード: " . $e->getCode() . PHP_EOL;
42    
43    // コンストラクタプロパティプロモーションで設定されたプロパティの値を出力します。
44    echo "エラー発生日時: " . $e->errorDate->format('Y-m-d H:i:s') . PHP_EOL;
45}

このPHPサンプルコードは、DateExceptionクラスを継承した独自の例外クラスCustomDateExceptionのコンストラクタ__constructを定義する例です。特に、PHP 8.0から導入された「コンストラクタプロパティのプロモーション」という機能を用いています。

この機能を使うと、コンストラクタの引数にpublic、protected、privateといった可視性修飾子を付けるだけで、プロパティの宣言とコンストラクタ内での代入処理を省略できます。サンプルコード内のpublic readonly DateTimeImmutable $errorDateがこれに該当し、$errorDateというプロパティが自動的に定義され、インスタンス生成時に渡された値が設定されます。

__constructメソッドは、newキーワードでクラスのインスタンスが生成される際に自動的に呼び出される特別なメソッドです。引数として、エラーが発生した日時を格納する$errorDate、例外メッセージの$message、例外コードの$code、そして先行する例外を表す$previousを受け取ります。このメソッドはインスタンスの初期化を目的とするため、戻り値はありません。

コンストラクタの内部では、parent::__construct()を呼び出すことで、親クラスであるDateExceptionのコンストラクタに必要な情報を渡し、初期化処理を行っています。これにより、継承元の機能も正しく利用できます。

Copy
1<?php
2
3// DateException はPHP 8で導入された日付/時刻関連のエラーを示す例外クラスです。
4// このMyCustomDateExceptionクラスは、DateExceptionを継承して独自のカスタム例外を定義する例です。
5class MyCustomDateException extends DateException
6{
7    /**
8     * MyCustomDateException のコンストラクタ。
9     * 親クラスである DateException のコンストラクタと同じ引数を持ちます。
10     *
11     * @param string $message 例外のメッセージ。
12     * @param int $code 例外のコード。
13     * @param Throwable|null $previous 前の例外。例外チェイニングに使用します。
14     */
15    public function __construct(string $message = '', int $code = 0, ?Throwable $previous = null)
16    {
17        // ここで親クラス (DateException) のコンストラクタを呼び出します。
18        // これにより、例外メッセージ、コード、前の例外といった基本的な情報が初期化されます。
19        // この 'parent::__construct()' の呼び出しが、「php construct parent」のキーワードに最も関連性の高い部分です。
20        parent::__construct($message, $code, $previous);
21
22        // 必要に応じて、MyCustomDateException固有の追加の初期化ロジックをここに追加できます。
23        // 例: カスタムログへの記録、特定のプロパティの設定など。
24    }
25}
26
27// --- サンプルコードの実行 ---
28
29try {
30    // 作成したカスタム例外 MyCustomDateException をスローします。
31    // コンストラクタにメッセージとコードを渡しています。
32    throw new MyCustomDateException("日付処理中にカスタムエラーが発生しました。", 12345);
33} catch (MyCustomDateException $e) {
34    // スローされた MyCustomDateException を捕捉します。
35    echo "カスタム例外を捕捉しました:\n";
36    echo "メッセージ: " . $e->getMessage() . "\n";
37    echo "コード: " . $e->getCode() . "\n";
38    // どのファイルと行で例外が発生したかも確認できます。
39    // echo "発生ファイル: " . $e->getFile() . " (行: " . $e->getLine() . ")\n";
40} catch (Throwable $e) {
41    // その他の予期せぬエラーも捕捉できますが、ここではカスタム例外に焦点を当てています。
42    echo "予期せぬエラーを捕捉しました: " . $e->getMessage() . "\n";
43}

DateException::__constructは、日付や時刻に関するエラー情報を保持するDateExceptionオブジェクトを生成し、初期化するためのコンストラクタです。

サンプルコードでは、PHP標準のDateExceptionを継承してMyCustomDateExceptionという独自の例外クラスを定義しています。このカスタム例外クラスのコンストラクタ内でparent::__construct()を呼び出している点が重要です。これは、親クラスであるDateExceptionのコンストラクタ機能を実行し、例外の基本的な情報を正しく設定するための記述です。

引数には、エラー内容を示す文字列$message、エラーを識別するための整数$code、そして、ある例外が原因で別の例外が発生した際に元の例外を保持するための$previous（例外チェイニング）を指定します。コンストラクタは、オブジェクトのインスタンス化時に初期化処理を行うための特別なメソッドであり、特定の値を返さないため戻り値はありません。

このサンプルは、独自の例外処理を実装する際に、親クラスの機能を適切に引き継いで利用する基本的な方法を示しています。