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

Copy
1<?php
2
3class CustomDateMalformedStringException extends DateMalformedStringException {
4    // プロパティをコンストラクタで定義し、初期化する (Property Promotion)
5    public function __construct(
6        string $message = '',
7        int $code = 0,
8        ?Throwable $previous = null,
9        public string $customProperty = 'default_value'
10    ) {
11        // 親クラスのコンストラクタを呼び出す
12        parent::__construct($message, $code, $previous);
13    }
14
15    public function getCustomProperty(): string
16    {
17        return $this->customProperty;
18    }
19}
20
21// 例外を発生させる
22try {
23    throw new CustomDateMalformedStringException('Invalid date string', 100, null, 'custom_value');
24} catch (CustomDateMalformedStringException $e) {
25    echo "例外が発生しました: " . $e->getMessage() . "\n";
26    echo "コード: " . $e->getCode() . "\n";
27    echo "カスタムプロパティ: " . $e->getCustomProperty() . "\n";
28}
29

このサンプルコードは、PHP 8における DateMalformedStringException クラスのコンストラクタ __construct の使用例を示しています。DateMalformedStringException は、日付文字列の形式が正しくない場合に発生する例外クラスです。

この例では、DateMalformedStringException を継承した CustomDateMalformedStringException クラスを定義し、コンストラクタ内でプロパティプロモーションを利用しています。プロパティプロモーションとは、コンストラクタの引数としてプロパティを定義し、同時に初期化する機能です。public string $customProperty = 'default_value' がその例で、customProperty という文字列型のプロパティを定義し、デフォルト値として 'default_value' を設定しています。

__construct メソッドは、例外メッセージ $message (文字列)、例外コード $code (整数)、前の例外 $previous (Throwableオブジェクトまたはnull) を引数として受け取ります。これらの引数は、親クラスである DateMalformedStringException のコンストラクタに parent::__construct($message, $code, $previous) で渡されます。

getCustomProperty メソッドは、customProperty プロパティの値を返すシンプルなゲッターメソッドです。

サンプルコードの後半部分では、try-catch ブロックを使用して例外を捕捉し、例外メッセージ、例外コード、そしてカスタムプロパティの値を出力しています。throw new CustomDateMalformedStringException('Invalid date string', 100, null, 'custom_value') で例外を発生させていますが、この際に customProperty に 'custom_value' が設定されます。

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

このサンプルコードは、PHP 8のDateMalformedStringExceptionクラスを拡張し、独自の例外クラスCustomDateMalformedStringExceptionを作成する方法を示しています。

DateMalformedStringExceptionは、日付文字列の形式が不正な場合に発生する例外クラスです。このサンプルでは、CustomDateMalformedStringExceptionクラス内でコンストラクタ__constructを定義しています。

コンストラクタ__constructは、例外発生時のメッセージ $message（文字列）、エラーコード $code（整数）、そして前の例外 $previous（Throwableオブジェクトまたはnull）を引数として受け取ります。これらの引数は、例外に関する詳細な情報を提供するために使用されます。

コンストラクタ内では、parent::__construct($message, $code, $previous);という記述で、親クラスであるDateMalformedStringExceptionのコンストラクタを呼び出しています。これにより、親クラスの初期化処理を確実に実行し、例外オブジェクトの基本的な属性を設定します。

CustomDateMalformedStringExceptionクラスには、独自のメソッドcustomMethodも定義されています。これは、このカスタム例外クラスに特有の処理を追加するためのものです。

サンプルコードの後半部分では、try-catchブロックを使用して例外を処理しています。throw new CustomDateMalformedStringException("Invalid date format", 100);によって例外が発生すると、catchブロックが実行され、例外メッセージ、エラーコード、そしてcustomMethodの実行結果が表示されます。この例は、カスタム例外クラスの作成と使用方法を示す基本的なパターンです。