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

Copy
1<?php
2
3class DateRangeError extends Exception
4{
5    // プロパティをコンストラクタで定義し、同時に値を設定 (Property Promotion)
6    public function __construct(
7        public string $message = '',
8        public int $code = 0,
9        public ?Throwable $previous = null
10    ) {
11        parent::__construct($message, $code, $previous);
12    }
13
14    public function __toString(): string
15    {
16        return __CLASS__ . ": [{$this->code}]: {$this->message}\n";
17    }
18}
19
20// 例: DateRangeError オブジェクトの作成
21try {
22    throw new DateRangeError('Invalid date range.', 123);
23} catch (DateRangeError $e) {
24    echo $e; // DateRangeError: [123]: Invalid date range.
25}

PHP 8のDateRangeErrorクラスのコンストラクタ__constructメソッドについて解説します。このメソッドは、DateRangeErrorオブジェクトを新規作成する際に呼び出されます。

引数として、エラーメッセージ $message（文字列）、エラーコード $code（整数）、そして前の例外 $previous（Throwableオブジェクトまたはnull）を受け取ります。これらの引数は、エラーに関する情報をオブジェクトに格納するために使用されます。引数は省略可能で、デフォルト値としてそれぞれ空文字列、0、nullが設定されています。

サンプルコードでは、PHP 8で導入された「Property Promotion」という機能を使用しています。これは、コンストラクタの引数定義と同時に、クラスのプロパティを定義し、引数の値をそのプロパティに代入する shorthand 構文です。public string $message = ''のように、引数の前にpublicをつけることで、$messageという名前のpublicなプロパティがクラスに定義され、コンストラクタ呼び出し時に渡された値が自動的にこのプロパティに設定されます。

コンストラクタの内部では、親クラスであるExceptionのコンストラクタをparent::__construct($message, $code, $previous)で呼び出し、エラーメッセージ、エラーコード、前の例外を設定しています。

戻り値はありません。__constructはオブジェクトを初期化する特殊なメソッドであるため、値を返す必要はありません。サンプルコードでは、DateRangeErrorオブジェクトを作成し、例外をスローしています。そして、キャッチした例外オブジェクトの内容を出力することで、コンストラクタで設定されたメッセージとコードが確認できます。

Copy
1<?php
2
3class CustomDateRangeError extends DateRangeError
4{
5    public function __construct(string $message = '', int $code = 0, ?Throwable $previous = null)
6    {
7        // 親クラスのコンストラクタを呼び出す
8        parent::__construct($message, $code, $previous);
9    }
10
11    public function customMethod(): string
12    {
13        return "Custom error handling";
14    }
15}
16
17// 例外を発生させる
18try {
19    throw new CustomDateRangeError("Invalid date range.", 100);
20} catch (CustomDateRangeError $e) {
21    echo "Caught DateRangeError: " . $e->getMessage() . PHP_EOL;
22    echo "Error code: " . $e->getCode() . PHP_EOL;
23    echo (new CustomDateRangeError())->customMethod() . PHP_EOL;
24}
25
26?>

このサンプルコードは、PHP 8における DateRangeError クラスのコンストラクタ __construct の使い方を示しています。DateRangeError は、日付範囲に関するエラーを表す例外クラスです。

この例では、DateRangeError を継承した CustomDateRangeError クラスを定義しています。CustomDateRangeError クラスのコンストラクタ __construct は、親クラス（DateRangeError）のコンストラクタを parent::__construct($message, $code, $previous); で呼び出しています。

__construct メソッドは、例外メッセージ $message (文字列)、エラーコード $code (整数)、そして以前の例外 $previous (Throwableオブジェクト、nullも可) を引数として受け取ります。これらの引数は、例外に関する詳細情報を提供するために使用されます。$message はエラーの内容を説明し、$code はエラーを特定するための一意の番号、$previous はこの例外が発生する前にスローされた別の例外（存在する場合）への参照です。

try...catch ブロックの中で、CustomDateRangeError を throw して例外を発生させ、catch ブロックでそれを捕捉しています。捕捉された例外から、getMessage() メソッドでエラーメッセージを、getCode() メソッドでエラーコードを取得し、それぞれ表示しています。また、customMethod() を呼び出して、CustomDateRangeError クラスに定義されたカスタムメソッドの実行例を示しています。

このように、__construct を適切に使用することで、例外発生時に有用な情報を提供し、エラー処理をより効果的に行うことができます。