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

Copy
1<?php
2
3class CustomDateInvalidTimeZoneException extends DateInvalidTimeZoneException
4{
5    public string $customProperty;
6
7    /**
8     * CustomDateInvalidTimeZoneException コンストラクタ。
9     *
10     * @param string $message 例外メッセージ
11     * @param int $code 例外コード
12     * @param Throwable|null $previous 以前の例外 (null の場合もある)
13     * @param string $customProperty カスタムプロパティ
14     */
15    public function __construct(
16        string $message = '',
17        int $code = 0,
18        ?Throwable $previous = null,
19        string $customProperty = ''
20    ) {
21        // 親クラスのコンストラクタを呼び出す
22        parent::__construct($message, $code, $previous);
23
24        // プロパティプロモーションを利用せずにカスタムプロパティを設定
25        $this->customProperty = $customProperty;
26    }
27
28    public function getCustomProperty(): string
29    {
30        return $this->customProperty;
31    }
32}
33
34// 例外を発生させる例
35try {
36    throw new CustomDateInvalidTimeZoneException('Invalid timezone specified.', 100, null, 'custom_value');
37} catch (CustomDateInvalidTimeZoneException $e) {
38    echo 'Caught exception: ' . $e->getMessage() . PHP_EOL;
39    echo 'Custom property: ' . $e->getCustomProperty() . PHP_EOL;
40    echo 'Exception code: ' . $e->getCode() . PHP_EOL;
41}

DateInvalidTimeZoneExceptionクラスの__constructメソッドは、例外オブジェクトを初期化するためのコンストラクタです。このコンストラクタは、例外が発生した際に、その内容を詳細に記述するために使用されます。

引数には、string $message、int $code、?Throwable $previousがあります。$messageは例外の説明文を指定します。$codeは例外を識別するための数値コードです。$previousは、この例外が発生する前にスローされた別の例外オブジェクトへの参照です（存在しない場合はnull）。

サンプルコードでは、DateInvalidTimeZoneExceptionを継承したCustomDateInvalidTimeZoneExceptionクラスを作成し、コンストラクタをオーバーライドしています。オーバーライドしたコンストラクタでは、親クラスのコンストラクタをparent::__construct()で呼び出し、基本的な例外情報を設定しています。さらに、$customPropertyという独自のプロパティを追加し、コンストラクタ内でその値を設定しています。ここではプロパティプロモーションは利用していません。

try-catchブロックでは、CustomDateInvalidTimeZoneExceptionを発生させ、キャッチしています。キャッチした例外オブジェクトから、getMessage()で例外メッセージ、getCustomProperty()でカスタムプロパティの値、getCode()で例外コードを取得し、それぞれを出力しています。

この例から、__constructメソッドが例外オブジェクトの初期化に不可欠であり、カスタム例外クラスを作成する際に、親クラスのコンストラクタを適切に呼び出す必要があることが理解できます。

Copy
1<?php
2
3class CustomDateInvalidTimeZoneException extends DateInvalidTimeZoneException
4{
5    public function __construct(string $message = "", int $code = 0, ?Throwable $previous = null)
6    {
7        // 親クラスのコンストラクタを呼び出す
8        parent::__construct($message, $code, $previous);
9
10        // カスタム処理をここに記述する (例: ログ出力)
11        error_log("CustomDateInvalidTimeZoneException が発生しました: " . $message);
12    }
13}
14
15// 例外を発生させる例
16try {
17    $timezone = new DateTimeZone('Invalid/Timezone');
18} catch (DateInvalidTimeZoneException $e) {
19    // カスタム例外をキャッチする
20    $customException = new CustomDateInvalidTimeZoneException("タイムゾーンが無効です", 100, $e);
21    throw $customException;
22
23} catch (Exception $e) {
24    echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
25}

このサンプルコードは、PHP 8 における DateInvalidTimeZoneException クラスのコンストラクタ __construct の使い方を示しています。DateInvalidTimeZoneException は、無効なタイムゾーンが指定された場合に発生する例外クラスです。

この例では、DateInvalidTimeZoneException を継承した CustomDateInvalidTimeZoneException クラスを定義しています。__construct メソッドは、例外発生時に実行される初期化処理を定義します。

__construct メソッドは、以下の引数を受け取ります。

• $message: 例外メッセージを表す文字列です。省略した場合、空文字列が設定されます。
• $code: 例外コードを表す整数値です。省略した場合、0 が設定されます。
• $previous: 以前の例外を表す Throwable オブジェクトです。例外が連鎖している場合に、前の例外を保持するために使用されます。省略可能です。

parent::__construct($message, $code, $previous); の部分は、親クラス (この場合は DateInvalidTimeZoneException) のコンストラクタを呼び出し、基本的な例外の初期化処理を行います。これは、継承したクラスで例外を適切に動作させるために重要です。

コンストラクタ内では、親クラスの初期化処理に加えて、カスタム処理（例: ログ出力）を追加できます。サンプルコードでは、error_log 関数を使って、例外発生時のメッセージをログに出力しています。

サンプルコード後半では、DateTimeZone クラスのコンストラクタに無効なタイムゾーンを指定することで DateInvalidTimeZoneException を発生させ、CustomDateInvalidTimeZoneException でキャッチして再スローしています。これにより、特定の例外に対してカスタムな処理を適用できます。