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

Copy
1<?php
2
3/**
4 * このスクリプトは、PHPのTypeErrorクラスのコンストラクタ (__construct) の使用方法を示します。
5 * TypeErrorは、通常PHPエンジンが型エラーを検出したときに自動的にスローしますが、
6 * 必要に応じて手動でインスタンス化してスローすることも可能です。
7 */
8
9/**
10 * 引数が指定された数値型であることを確認します。
11 * 異なる型が渡された場合、TypeErrorをスローします。
12 *
13 * @param mixed $value 確認する値
14 * @param string $expectedType 期待する数値型 ('int', 'float', 'numeric' のいずれか)
15 * @throws TypeError 値が期待する型でない場合
16 */
17function validateNumericType(mixed $value, string $expectedType): void
18{
19    $isValid = false;
20    $errorMessage = '';
21
22    switch ($expectedType) {
23        case 'int':
24            $isValid = is_int($value);
25            $errorMessage = "期待される型は整数 (int) です。";
26            break;
27        case 'float':
28            $isValid = is_float($value);
29            $errorMessage = "期待される型は浮動小数点数 (float) です。";
30            break;
31        case 'numeric':
32            // is_numericは文字列形式の数値もtrueと判定します
33            $isValid = is_numeric($value);
34            $errorMessage = "期待される型は数値 (numeric) です。";
35            break;
36        default:
37            // このデモでは、定義済みの型以外のケースは考慮せず、エラーとする
38            $isValid = false;
39            $errorMessage = "不明な期待型が指定されました: {$expectedType}。";
40    }
41
42    if (!$isValid) {
43        // TypeErrorのコンストラクタ (__construct) を使用して新しいエラーインスタンスを作成し、スローします。
44        // 引数: string $message, int $code = 0, ?Throwable $previous = null
45        // ここではメッセージとカスタムコードを指定しています。
46        throw new TypeError(
47            $errorMessage . "渡された値の型は " . gettype($value) . " です。",
48            1001 // カスタムエラーコード
49        );
50    }
51
52    echo "値 '{$value}' (型: " . gettype($value) . ") は期待される型 '{$expectedType}' です。\n";
53}
54
55// --- TypeErrorの発生と捕捉の例 ---
56
57echo "--- 正常なケース (TypeErrorは発生しません) ---\n";
58try {
59    validateNumericType(123, 'int');
60    validateNumericType(3.14, 'float');
61    validateNumericType("456", 'numeric'); // "456"はis_numericでtrueになるため正常
62} catch (Throwable $e) {
63    // 正常なケースではこのブロックは実行されません
64    echo "予期せぬエラーが捕捉されました: " . $e->getMessage() . "\n";
65}
66
67echo "\n--- TypeErrorが発生するケース (メッセージとコードの指定) ---\n";
68try {
69    // 期待される型は 'int' だが、文字列 'hello' を渡すことでTypeErrorを意図的に発生させる
70    validateNumericType("hello", 'int');
71} catch (TypeError $e) {
72    // TypeErrorを捕捉し、コンストラクタで設定された情報を表示
73    echo "捕捉されたTypeError:\n";
74    echo "  メッセージ: " . $e->getMessage() . "\n"; // コンストラクタの第一引数で設定
75    echo "  コード: " . $e->getCode() . "\n";     // コンストラクタの第二引数で設定
76    echo "  ファイル: " . $e->getFile() . "\n";     // エラーが発生したファイル
77    echo "  行: " . $e->getLine() . "\n";        // エラーが発生した行
78    if ($e->getPrevious() !== null) {
79        echo "  以前の例外: " . $e->getPrevious()->getMessage() . "\n"; // コンストラクタの第三引数
80    }
81}
82
83echo "\n--- TypeErrorのコンストラクタに全ての引数を渡す例 (前の例外も指定) ---\n";
84try {
85    // 以前の例外 (Previous Throwable) を含めてTypeErrorをスローする例
86    // まず、何らかの理由で発生した元の例外をシミュレート
87    $originalError = new Exception("データ処理の初期段階で不明な問題が発生しました。", 9000);
88
89    // その元の例外を包含する形でTypeErrorをスロー
90    // ここでTypeErrorのコンストラクタの全ての引数を使用しています。
91    throw new TypeError(
92        "システムは無効なデータ型を検出したため、処理を続行できません。", // カスタムメッセージ
93        2002, // カスタムエラーコード
94        $originalError // 以前の例外として元のエラーを渡す
95    );
96} catch (TypeError $e) {
97    echo "捕捉されたTypeError (前の例外付き):\n";
98    echo "  メッセージ: " . $e->getMessage() . "\n";
99    echo "  コード: " . $e->getCode() . "\n";
100    if ($e->getPrevious() !== null) {
101        echo "  以前の例外メッセージ: " . $e->getPrevious()->getMessage() . "\n";
102        echo "  以前の例外コード: " . $e->getPrevious()->getCode() . "\n";
103        echo "  以前の例外クラス: " . get_class($e->getPrevious()) . "\n";
104    }
105}
106
107?>

PHP 8におけるTypeErrorクラスの__constructメソッドは、TypeErrorの新しいインスタンスを生成する際に使用されます。TypeErrorは通常、PHPエンジンが関数の引数型宣言や戻り値型宣言に違反する値が渡されたときに自動的にスローしますが、必要に応じて開発者が手動でインスタンスを作成し、スローすることも可能です。

このコンストラクタは、三つの引数を受け取ります。第一引数である$messageは、エラーの内容を詳細に記述する文字列で、省略可能です。第二引数の$codeは、エラーを識別するための整数値のカスタムコードで、これも省略可能です。第三引数の$previousは、このTypeErrorが別の例外の後に発生した場合、その元の例外（Throwableオブジェクト）を指定するために使用され、エラーの連鎖を追跡するのに役立ちます。この引数も省略可能で、デフォルトはnullです。

コンストラクタであるため、特定の戻り値はありません。サンプルコードでは、validateNumericType関数内で期待される型と異なる値が渡された場合に、new TypeError()としてエラーメッセージとカスタムコードを指定してTypeErrorを手動で生成し、スローしています。これにより、型エラーが発生した状況や原因をより詳細に開発者に伝えることができます。また、以前の例外を引数として渡すことで、複数の例外が連鎖して発生した場合のデバッグを容易にしています。

Copy
1<?php
2
3/**
4 * PHP 8 の constructor property promotion (コンストラクタプロパティ昇格) 機能を使用して、
5 * エラークラスを定義するサンプルです。
6 *
7 * TypeError::__construct メソッドのリファレンス情報に示される引数 (メッセージ、コード、前のThrowable)
8 * と同じ構造を持つカスタムエラークラスを作成し、constructor property promotion の動作を示します。
9 *
10 * TypeError は PHP 組み込みの Error クラスの子孫であり、型の不一致があった場合にPHPエンジンが自動でスローします。
11 * このサンプルでは、TypeError と同様の引数を持つカスタムエラークラスを Error クラスを継承して作成します。
12 */
13class CustomTypeErrorExample extends Error
14{
15    /**
16     * コンストラクタプロパティ昇格を利用したコンストラクタ。
17     * 引数 ($message, $code, $previous) は、
18     * 自動的にクラスの public プロパティとして定義され、初期化されます。
19     *
20     * @param string $message エラーメッセージ。TypeError と同じデフォルト値を持つ。
21     * @param int $code エラーコード。TypeError と同じデフォルト値を持つ。
22     * @param ?Throwable $previous 前に発生した Throwable オブジェクト。TypeError と同じデフォルト値を持つ。
23     */
24    public function __construct(
25        public string $message = '',
26        public int $code = 0,
27        public ?Throwable $previous = null
28    ) {
29        // 親クラス (Error) のコンストラクタを呼び出します。
30        // プロパティは既に昇格され、初期化されているため、
31        // $this->message, $this->code, $this->previous を親に渡します。
32        parent::__construct($this->message, $this->code, $this->previous);
33    }
34
35    /**
36     * エラーの詳細情報を取得するヘルパーメソッド。
37     * 昇格されたプロパティに直接アクセスできます。
38     *
39     * @return string
40     */
41    public function getFullErrorInfo(): string
42    {
43        $info = "エラー: " . $this->message;
44        if ($this->code !== 0) {
45            $info .= " (コード: " . $this->code . ")";
46        }
47        if ($this->previous !== null) {
48            $info .= " [原因: " . $this->previous->getMessage() . "]";
49        }
50        return $info;
51    }
52}
53
54// --- サンプルコードの実行 ---
55
56echo "--- CustomTypeErrorExample の使用例 ---" . PHP_EOL;
57
58try {
59    // 引数を指定して CustomTypeErrorExample をインスタンス化し、スローする
60    throw new CustomTypeErrorExample("処理中に予期せぬエラーが発生しました。", 1001);
61} catch (CustomTypeErrorExample $e) {
62    echo $e->getFullErrorInfo() . PHP_EOL;
63    // 昇格されたプロパティに直接アクセスできることを示す
64    echo "メッセージ: " . $e->message . PHP_EOL;
65    echo "コード: " . $e->code . PHP_EOL;
66    echo "前のエラー: " . ($e->previous ? $e->previous->getMessage() : "なし") . PHP_EOL;
67}
68
69echo PHP_EOL;
70
71try {
72    // 別のエラーを原因として含める例
73    try {
74        // 内部で発生した例外
75        throw new RuntimeException("データベース接続に失敗しました。");
76    } catch (RuntimeException $innerException) {
77        // 内部エラーを previous として新しい CustomTypeErrorExample をスロー
78        throw new CustomTypeErrorExample("システム障害が発生しました。", 1002, $innerException);
79    }
80} catch (CustomTypeErrorExample $e) {
81    echo $e->getFullErrorInfo() . PHP_EOL;
82    // previous プロパティを通じて前の例外にアクセス
83    if ($e->previous instanceof Throwable) {
84        echo "前のエラータイプ: " . get_class($e->previous) . PHP_EOL;
85        echo "前のエラーメッセージ: " . $e->previous->getMessage() . PHP_EOL;
86    }
87}
88
89echo PHP_EOL;
90
91try {
92    // 引数なしで CustomTypeErrorExample をインスタンス化する例
93    // デフォルト値が適用される
94    throw new CustomTypeErrorExample();
95} catch (CustomTypeErrorExample $e) {
96    echo $e->getFullErrorInfo() . PHP_EOL;
97    echo "メッセージ: " . ($e->message === '' ? "(空)" : $e->message) . PHP_EOL;
98    echo "コード: " . $e->code . PHP_EOL;
99}

PHP 8で導入された「Constructor Property Promotion（コンストラクタプロパティ昇格）」機能は、コンストラクタの引数を宣言するだけで、同時にクラスのプロパティとして定義し、初期化できる便利な機能です。このサンプルコードでは、PHPに組み込まれているTypeErrorクラスのコンストラクタ（__construct）の引数構成を模倣し、カスタムエラークラスCustomTypeErrorExampleを定義しています。

CustomTypeErrorExampleクラスのコンストラクタは、$message（エラーメッセージ、文字列、デフォルトは空）、$code（エラーコード、整数、デフォルトは0）、$previous（前のThrowableオブジェクト、nullも可、デフォルトはnull）という引数を受け取ります。これらの引数は、コンストラクタプロパティ昇格により、自動的にpublicプロパティとしてクラス内に定義され、インスタンス作成時に値が初期化されます。コンストラクタ自体はインスタンスを初期化するものであり、戻り値はありません。コンストラクタ内では、親クラスであるErrorのコンストラクタをparent::__constructで呼び出し、エラーの基本的な情報処理を親に委ねています。

getFullErrorInfo()メソッドは、昇格されたこれらのプロパティに直接アクセスし、エラーの詳細情報を整形して返します。実行例では、CustomTypeErrorExampleのインスタンスをthrow文でスローし、try-catchブロックで捕捉することで、カスタムエラーの発生と処理の流れを示しています。引数を指定した場合や、別の例外を原因として含める場合、また引数を省略してデフォルト値を使用する場合など、様々なインスタンス化の方法と、昇格されたプロパティへのアクセス方法を確認できます。