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

Copy
1<?php
2
3// DateMalformedPeriodStringException クラスは、日付/時刻の期間文字列の解析に失敗した場合にスローされる例外です。
4// __construct メソッドは、例外オブジェクトを構築するために使用されます。
5
6try {
7    // 例: 無効な期間文字列を DatePeriod に渡すと、例外がスローされる可能性があります。
8    $period = new DatePeriod('invalid period string', new DateTime(), new DateTime());
9} catch (DateMalformedPeriodStringException $e) {
10    // 例外をキャッチし、メッセージ、コード、前の例外を取得できます。
11    $message = $e->getMessage();
12    $code = $e->getCode();
13    $previous = $e->getPrevious();
14
15    // 新しい DateMalformedPeriodStringException を作成する例
16    $newException = new DateMalformedPeriodStringException(
17        "カスタムエラーメッセージ: " . $message,  // カスタムメッセージ
18        123,                                      // カスタムコード
19        $e                                         // 元の例外を前の例外として設定
20    );
21
22    echo "例外が発生しました: " . $newException->getMessage() . "\n";
23    echo "コード: " . $newException->getCode() . "\n";
24    if ($newException->getPrevious()) {
25        echo "前の例外: " . $newException->getPrevious()->getMessage() . "\n";
26    }
27
28}

DateMalformedPeriodStringExceptionクラスの__constructメソッドは、日付/時刻の期間文字列の解析に失敗した場合に発生する例外オブジェクトを初期化するために使用されます。この例外は、DatePeriodコンストラクタなどに無効な期間文字列が渡された場合にスローされます。

__constructメソッドは、以下の引数を持ちます。

• $message: 例外メッセージを表す文字列です。省略した場合、デフォルトのメッセージが設定されます。
• $code: 例外コードを表す整数値です。省略した場合、デフォルトで0が設定されます。
• $previous: 前の例外を表すThrowableオブジェクトです。例外が別の例外によって引き起こされた場合に、その原因となった例外を指定するために使用します。省略可能です。

__constructメソッドは戻り値を持ちません。

サンプルコードでは、try-catchブロックを使用して、DateMalformedPeriodStringExceptionを捕捉し、例外メッセージ、コード、および前の例外を取得しています。また、__constructメソッドを使用して、カスタムメッセージ、コード、および前の例外を設定した新しいDateMalformedPeriodStringExceptionオブジェクトを作成する例を示しています。これにより、例外発生時の詳細な情報を保持し、エラー処理をより柔軟に行うことができます。

Copy
1<?php
2
3class DateMalformedPeriodStringException extends Exception
4{
5    public function __construct(string $message = '', int $code = 0, ?Throwable $previous = null)
6    {
7        parent::__construct($message, $code, $previous);
8    }
9}
10
11// 使用例
12try {
13    throw new DateMalformedPeriodStringException('Invalid period string provided.', 100);
14} catch (DateMalformedPeriodStringException $e) {
15    echo "Caught exception: " . $e->getMessage() . "\n";
16    echo "Code: " . $e->getCode() . "\n";
17}

PHP 8 における DateMalformedPeriodStringException クラスのコンストラクタ __construct メソッドについて解説します。このコンストラクタは、無効な期間文字列が原因で発生した例外を扱うためのクラスを初期化する役割を持っています。

DateMalformedPeriodStringException は Exception クラスを継承しており、コンストラクタ __construct は親クラスのコンストラクタを拡張しています。主な役割は、例外発生時に必要な情報を設定することです。

引数は以下の3つです。

1. string $message = '': 例外メッセージを指定します。省略した場合、空文字列が設定されます。これは、例外の内容を説明するテキストです。
2. int $code = 0: 例外コードを指定します。省略した場合、0 が設定されます。これは、例外の種類を識別するための数値です。
3. ?Throwable $previous = null: 前の例外を指定します。省略した場合、null が設定されます。これは、例外が連鎖する場合に、原因となった例外を保持するために使用されます。PHP 7 以降で導入された Throwable インターフェースを実装したクラスのインスタンスを指定できます。

コンストラクタ内では、parent::__construct($message, $code, $previous) を呼び出すことで、親クラスである Exception クラスのコンストラクタを実行し、これらの情報を設定しています。戻り値はありません。

サンプルコードでは、DateMalformedPeriodStringException を try-catch ブロック内で使用しています。try ブロック内で例外が発生した場合、catch ブロックが実行され、例外メッセージとコードが表示されます。このように、DateMalformedPeriodStringException は、期間文字列の形式が正しくない場合に発生する例外を適切に処理するために使用されます。