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

Copy
1<?php
2
3// このコード例は、PHP 8で導入された「コンストラクタプロパティプロモーション」機能と、
4// 提供されたDateErrorクラスのコンストラクタ引数（メッセージ、コード、以前の例外）の情報を組み合わせています。
5// システムエンジニアを目指す初心者が、最新のPHPでのクラス定義と例外処理の基本を学ぶのに役立ちます。
6
7/**
8 * 日付処理に関連するカスタム例外クラス。
9 * PHP 8のコンストラクタプロパティプロモーションを使用して、
10 * 引数を短く、簡潔にクラスプロパティとして定義する方法を示します。
11 * Exceptionクラスを継承することで、標準的な例外処理メカニズムを利用できます。
12 */
13class DateProcessingException extends Exception
14{
15    /**
16     * DateProcessingException の新しいインスタンスを生成します。
17     *
18     * @param string $message 例外のメッセージ。
19     * @param int    $code    例外を識別するためのコード。
20     * @param ?Throwable $previous 連鎖例外として、以前のスロー可能なオブジェクト（ExceptionまたはError）。
21     *
22     * PHP 8のコンストラクタプロパティプロモーションにより、
23     * `public`, `protected`, `private` アクセス修飾子を引数に直接記述することで、
24     * その引数をクラスのプロパティとして自動的に定義し、初期化できます。
25     * これにより、冗長なプロパティ宣言と初期化コードを省略できます。
26     *
27     * 例: private string $message を記述することで、
28     *     - private $message; (プロパティ宣言)
29     *     - $this->message = $message; (コンストラクタでの初期化)
30     *   の2つの手順が自動的に行われます。
31     */
32    public function __construct(
33        private string $message = '',
34        private int $code = 0,
35        private ?Throwable $previous = null
36    ) {
37        // 基底クラス(Exception)のコンストラクタを呼び出します。
38        // これにより、例外メッセージ、コード、連鎖例外などの標準的な例外プロパティが初期化されます。
39        parent::__construct($message, $code, $previous);
40    }
41
42    // ここにこの例外クラス特有のメソッドを追加することもできますが、
43    // この例ではコンストラクタプロパティプロモーションに焦点を当てています。
44}
45
46// --- サンプルコードの使用例 ---
47
48// このカスタム例外を実際にスローし、捕捉する例を示します。
49try {
50    // 日付処理をシミュレートする関数
51    function processDate(string $dateInput): string
52    {
53        if (!strtotime($dateInput)) {
54            // 不正な日付形式の場合、連鎖例外を持つカスタム例外をスロー
55            $invalidArgument = new InvalidArgumentException("無効な日付形式: '{$dateInput}'", 1);
56            throw new DateProcessingException(
57                "日付の解析に失敗しました。",
58                100, // カスタムエラーコード
59                $invalidArgument // 以前のエラー（連鎖例外）
60            );
61        }
62        return "日付 '{$dateInput}' は正常に処理されました。";
63    }
64
65    echo processDate("2023-10-26") . "\n"; // 正常に処理されるケース
66    echo processDate("不正な日付") . "\n"; // 例外がスローされるケース
67
68} catch (DateProcessingException $e) {
69    // DateProcessingException を捕捉した場合
70    echo "---------- エラー発生 ----------\n";
71    echo "カスタムエラーメッセージ: " . $e->getMessage() . "\n";
72    echo "エラーコード: " . $e->getCode() . "\n";
73    echo "ファイル: " . $e->getFile() . " (行: " . $e->getLine() . ")\n";
74
75    // 連鎖例外が存在するかチェックし、存在すればその情報を表示
76    if ($e->getPrevious() !== null) {
77        echo "--- 以前のエラー情報 ---\n";
78        echo "タイプ: " . get_class($e->getPrevious()) . "\n";
79        echo "メッセージ: " . $e->getPrevious()->getMessage() . "\n";
80        echo "コード: " . $e->getPrevious()->getCode() . "\n";
81    }
82    echo "--------------------------\n";
83
84} catch (Exception $e) {
85    // その他の予期せぬ例外を捕捉した場合
86    echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
87}
88
89?>

このPHP 8のサンプルコードは、クラスのインスタンス化時に呼び出される特別なメソッドである__constructと、PHP 8で導入された「コンストラクタプロパティプロモーション」機能を用いて、カスタム例外クラスDateProcessingExceptionを定義しています。DateProcessingExceptionは、標準のExceptionクラスを継承しており、日付処理に関連するエラーを扱うためのものです。

__constructメソッドの引数には、string $message（例外メッセージ）、int $code（エラーコード）、?Throwable $previous（以前に発生した例外オブジェクト）が定義されています。PHP 8のコンストラクタプロパティプロモーションにより、これらの引数にprivateなどのアクセス修飾子を直接記述することで、自動的に同じ名前のクラスプロパティとして宣言され、コンストラクタ内で初期化されます。これにより、プロパティの宣言とコンストラクタ内での代入が不要になり、コードを非常に簡潔に記述できます。

parent::__construct($message, $code, $previous)の呼び出しは、基底クラスであるExceptionのコンストラクタを適切に初期化するために重要です。これにより、カスタム例外も標準的な例外処理メカニズムに沿って機能します。

サンプルコードの使用例では、processDate関数内で無効な日付形式が検出された場合にDateProcessingExceptionをスローし、try-catchブロックでその例外を捕捉しています。捕捉された例外からgetMessage()、getCode()などのメソッドを使って詳細情報を取得し、連鎖例外も確認できることを示しています。__constructメソッド自体は、インスタンスを構築する役割のため、直接的な戻り値はありません。

Copy
1<?php
2
3/**
4 * DateError を継承するカスタムエラークラスを定義します。
5 * これは、特定の日付関連の条件で発生するエラーを表すことを想定しています。
6 */
7class MyCustomDateError extends DateError
8{
9    /**
10     * MyCustomDateError クラスのコンストラクタです。
11     *
12     * @param string          $message  エラーメッセージ。
13     * @param int             $code     エラーコード。
14     * @param ?Throwable|null $previous この例外の前の例外。
15     *
16     * キーワード: php construct parent
17     * コンストラクタ内で親クラス (DateError) のコンストラクタを呼び出すことで、
18     * エラーメッセージ、コード、前のエラー情報が適切に初期化されます。
19     */
20    public function __construct(
21        string $message = 'カスタム日付エラーが発生しました。',
22        int $code = 0,
23        ?Throwable $previous = null
24    ) {
25        // 親クラスである DateError のコンストラクタを呼び出します。
26        // これにより、このカスタムエラーが標準の DateError の機能を引き継ぎます。
27        parent::__construct($message, $code, $previous);
28    }
29
30    /**
31     * カスタムエラーに固有の追加情報を取得するメソッドの例です。
32     *
33     * @return string カスタムエラーメッセージ。
34     */
35    public function getCustomInfo(): string
36    {
37        return "詳細情報: エラーコード " . $this->getCode() . " に基づくカスタム処理。";
38    }
39}
40
41/**
42 * 日付文字列を処理する関数。
43 * 特定の条件で MyCustomDateError をスローします。
44 *
45 * @param string $dateString 処理する日付文字列。
46 * @throws MyCustomDateError 日付文字列が不正な場合にスローされます。
47 * @return void
48 */
49function processDateString(string $dateString): void
50{
51    if (empty($dateString)) {
52        // 引数に不備がある場合、MyCustomDateError をスローします。
53        // このエラーは上で定義したカスタムコンストラクタによって初期化されます。
54        throw new MyCustomDateError("日付文字列が空です。", 500);
55    }
56
57    // ここに実際の日付処理ロジックを記述します。
58    // 例: DateTimeImmutable::createFromFormat() など
59    echo "日付 '$dateString' を正常に処理しました。\n";
60}
61
62// --- サンプルコードの実行例 ---
63
64echo "--- 1. カスタムエラーを捕捉する例 ---\n";
65try {
66    // エラーが発生する条件で関数を呼び出します。
67    processDateString("");
68} catch (MyCustomDateError $e) {
69    // MyCustomDateError 型の例外を捕捉します。
70    echo "捕捉されたカスタム日付エラー:\n";
71    echo "メッセージ: " . $e->getMessage() . "\n";
72    echo "コード: " . $e->getCode() . "\n";
73    echo "ファイル: " . $e->getFile() . "\n";
74    echo "行: " . $e->getLine() . "\n";
75    echo "追加情報: " . $e->getCustomInfo() . "\n";
76} catch (Throwable $e) {
77    // その他の予期せぬエラーを捕捉します。
78    echo "捕捉された一般的なエラー: " . $e->getMessage() . "\n";
79}
80
81echo "\n--- 2. エラーが発生しない例 ---\n";
82try {
83    // 正常に処理される条件で関数を呼び出します。
84    processDateString("2023-10-26");
85} catch (MyCustomDateError $e) {
86    // このブロックは実行されません。
87    echo "捕捉されたカスタム日付エラー (予期せぬ発生): " . $e->getMessage() . "\n";
88}
89
90?>

DateErrorクラスは、PHPで日付や時刻の処理中に発生するエラーを示すための組み込みの例外クラスです。その__constructメソッドは、新しいDateErrorオブジェクトを生成し、初期化する際に使用されます。引数$messageは、エラーの内容を説明する文字列を指定し、省略した場合は空文字列がデフォルトとなります。$codeはエラーの種類を示す整数値で、デフォルトは0です。$previousは、このDateErrorが発生する前に捕捉された別のThrowable（例外やエラー）オブジェクトを指定することで、例外の連鎖を表現できます。これも省略可能です。このメソッドは、オブジェクトの初期化を行うため、特定の戻り値はありません。サンプルコードでは、DateErrorを継承して独自のカスタムエラークラスMyCustomDateErrorを定義しています。MyCustomDateErrorのコンストラクタ内でparent::__construct($message, $code, $previous);と記述することで、親クラスであるDateErrorのコンストラクタが呼び出されます。これにより、カスタムエラーが標準のDateErrorの持つ基本的なエラー情報（メッセージ、コード、前の例外）を適切に初期化し、それらの機能を継承して利用できるようになります。親クラスのコンストラクタを明示的に呼び出すことは、継承元の初期化ロジックを確実に実行するために不可欠なプラクティスです。