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

Copy
1<?php
2
3// このコードは、PHP 8で導入された「Constructor Property Promotion」の機能と、
4// AssertionErrorのコンストラクタが受け取る引数を模倣したカスタム例外クラスの例を示します。
5// AssertionErrorはPHPの内部クラスであり、通常は開発者が直接インスタンス化することはありません。
6// そのため、ここでは同様の情報をPHP 8の新しい構文で表現するカスタムクラスを例示します。
7
8/**
9 * CustomAssertionFailedException クラス
10 *
11 * PHP 8のConstructor Property Promotion (コンストラクタプロパティ昇格) を利用して、
12 * コンストラクタ引数を簡潔にクラスプロパティとして定義し、初期化します。
13 * AssertionErrorのコンストラクタ引数と互換性のある構造です。
14 */
15class CustomAssertionFailedException extends Exception
16{
17    /**
18     * コンストラクタ
19     *
20     * @param string $message 例外のメッセージ
21     * @param int $code 例外のコード
22     * @param ?Throwable $previous 以前のThrowableオブジェクト (オプション)
23     *
24     * Constructor Property Promotion により、引数として宣言された $message, $code, $previous は、
25     * 自動的に同名の public プロパティとしてクラス内に定義され、初期化されます。
26     */
27    public function __construct(
28        public string $message = '',
29        public int $code = 0,
30        public ?Throwable $previous = null
31    ) {
32        // 親クラスである Exception のコンストラクタを呼び出し、
33        // 例外としての標準的な動作を保証します。
34        parent::__construct($message, $code, $previous);
35    }
36}
37
38// CustomAssertionFailedException の使用例
39try {
40    echo "--- CustomAssertionFailedException の使用例 ---\n";
41
42    // 1. メッセージのみを指定してインスタンスを作成
43    $exception1 = new CustomAssertionFailedException("カスタムアサーションが失敗しました！");
44    echo "例外メッセージ: " . $exception1->getMessage() . " (コード: " . $exception1->getCode() . ")\n";
45    echo "プロパティ (\$message): " . $exception1->message . "\n"; // プロモーションされたプロパティへのアクセス
46
47    echo "\n";
48
49    // 2. メッセージとコードを指定してインスタンスを作成
50    $exception2 = new CustomAssertionFailedException("データ検証に失敗しました。", 1001);
51    echo "例外メッセージ: " . $exception2->getMessage() . " (コード: " . $exception2->getCode() . ")\n";
52    echo "プロパティ (\$code): " . $exception2->code . "\n";
53
54    echo "\n";
55
56    // 3. 全ての引数を指定してインスタンスを作成 (前の例外を含む)
57    $previousException = new RuntimeException("前の処理で問題が発生しました。", 500);
58    $exception3 = new CustomAssertionFailedException(
59        "重要なビジネスロジックでアサーションが失敗。",
60        2002,
61        $previousException
62    );
63    echo "例外メッセージ: " . $exception3->getMessage() . " (コード: " . $exception3->getCode() . ")\n";
64    echo "前の例外: " . get_class($exception3->getPrevious()) . " (メッセージ: " . $exception3->getPrevious()->getMessage() . ")\n";
65    echo "プロパティ (\$previous): " . get_class($exception3->previous) . "\n";
66
67    echo "\n";
68
69    // 実際にスローしてキャッチする例
70    throw new CustomAssertionFailedException("致命的なエラーが発生しました！", 999);
71
72} catch (CustomAssertionFailedException $e) {
73    echo "捕捉されたカスタムアサーション例外: " . $e->getMessage() . " (コード: " . $e->getCode() . ")\n";
74    // スタックトレースは長くなるため、一部のみ表示
75    echo "スタックトレースの一部:\n" . implode("\n", array_slice(explode("\n", $e->getTraceAsString()), 0, 3)) . "\n";
76} catch (Throwable $e) {
77    echo "予期せぬ例外を捕捉しました: " . $e->getMessage() . "\n";
78}

このPHPコードは、PHP 8で導入された「Constructor Property Promotion（コンストラクタプロパティ昇格）」という機能を利用し、カスタム例外クラスCustomAssertionFailedExceptionを定義する例です。AssertionErrorはPHPの内部エラークラスであり、通常は開発者が直接インスタンス化しないため、そのコンストラクタ引数と同じ構造を持つカスタムクラスを使って説明しています。

CustomAssertionFailedExceptionクラスの__constructメソッドは、オブジェクトが新しく作られるときに自動的に呼び出される初期化のための特別なメソッドです。このメソッドは、$message（例外の具体的な内容を示す文字列）、$code（エラーを一意に識別する整数コード）、$previous（この例外が発生する前に発生した別の例外オブジェクト）の3つの引数を受け取ります。PHP 8のConstructor Property Promotionにより、これらの引数にpublicキーワードを付与することで、同名のクラスプロパティが自動的に宣言され、引数の値で初期化されます。これにより、冗長なプロパティ宣言と初期化のコードを簡潔に記述できます。

コンストラクタは新しいオブジェクトを初期化する役割を持つため、明示的な戻り値はありません。

サンプルコードでは、CustomAssertionFailedExceptionを様々な引数でインスタンス化し、getMessage()やgetCode()などの親クラスExceptionのメソッドで情報にアクセスできること、またプロモーションされたプロパティに直接アクセスできることを示しています。さらに、try-catchブロックを使って実際に例外をスローし、それを捕捉して処理する基本的な流れも確認できます。これは、システム内で問題が発生した際に、その詳細を整理して伝えるための重要な仕組みです。

Copy
1<?php
2
3// プログラミング言語リファレンス情報:
4// - 言語: PHP
5// - バージョン: 8
6// - 大分類: extension
7// - 小分類: method
8// - 所属クラス: AssertionError
9// - 名前: __construct
10// - 引数: string $message = '', int $code = 0, ?Throwable $previous = null
11// - 戻り値: 戻り値なし
12//
13// キーワード: php construct parent
14
15/**
16 * 独自のカスタムエラークラス
17 * AssertionErrorはPHPの組み込みエラークラスで、`Error`を継承しています。
18 * この`AssertionError`クラスは`final`であるため、直接継承することはできません。
19 * しかし、そのコンストラクタは親クラスである`Error`のコンストラクタを呼び出しています。
20 *
21 * この`MyCustomError`クラスは、`Error`クラスを継承することで、
22 * `AssertionError`が内部的に行っている「`parent::__construct`」の動作を
23 * 具体的に理解するためのデモンストレーションです。
24 */
25class MyCustomError extends Error
26{
27    /**
28     * コンストラクタ
29     *
30     * @param string $message エラーメッセージ
31     * @param int $code エラーコード
32     * @param Throwable|null $previous 前のエラー（スタックトレース用）
33     */
34    public function __construct(string $message = '', int $code = 0, ?Throwable $previous = null)
35    {
36        // ここで親クラス（ここではPHPのErrorクラス）のコンストラクタを呼び出します。
37        // これにより、Errorクラスの基本的なプロパティ（メッセージ、コード、前の例外）が初期化されます。
38        // AssertionErrorのコンストラクタも、同様に`Error::__construct`を呼び出して初期化を行います。
39        parent::__construct($message, $code, $previous);
40
41        // ここにMyCustomError独自の追加の初期化ロジックがあれば記述できます。
42        // （AssertionErrorのコンストラクタには、親のコンストラクタ呼び出し以外の特別なロジックはほとんどありません。）
43    }
44}
45
46// --- 動作確認 ---
47
48// 1. カスタムエラーの利用例（「parent::__construct」の仕組みを示す）
49echo "--- カスタムエラーのデモンストレーション ---\n";
50try {
51    throw new MyCustomError("カスタムエラーが発生しました。", 100);
52} catch (MyCustomError $e) {
53    echo "捕捉したカスタムエラー: " . $e->getMessage() . " (コード: " . $e->getCode() . ")\n";
54}
55
56echo "\n--- AssertionErrorのコンストラクタの利用例 ---\n";
57// 2. AssertionErrorのコンストラクタを直接呼び出す例
58//    (通常はassert()関数の失敗時にPHPエンジンが自動でスローします。
59//     開発者が手動でインスタンス化することは稀です。)
60try {
61    // AssertionErrorのコンストラクタもMyCustomErrorと同様に、
62    // 引数としてメッセージ、コード、前の例外を受け取ります。
63    // そして内部でErrorクラスのコンストラクタを呼び出して初期化を行います。
64    throw new AssertionError(
65        "これは手動でスローされたAssertionErrorです。",
66        200,
67        new Exception("前の処理での問題") // 前の例外を渡すことも可能
68    );
69} catch (AssertionError $e) {
70    echo "捕捉したAssertionError: " . $e->getMessage() . " (コード: " . $e->getCode() . ")\n";
71    if ($e->getPrevious()) {
72        echo "前の例外: " . $e->getPrevious()->getMessage() . "\n";
73    }
74}
75

PHP 8のAssertionErrorクラスは、プログラムが期待する条件が満たされなかった際（アサーション失敗時）に発生するエラーを表すクラスです。このクラスの__constructメソッドは、AssertionErrorの新しいインスタンスを生成する際に、そのエラーに関する情報を初期設定するために使用されます。

引数には、エラーの詳細を説明する文字列$message、エラーの種類を数値で示す$code、そしてこのエラーが発生する前に起きた別の例外を表すThrowableオブジェクト$previousを指定できます。これらはすべてオプションであり、指定しない場合はデフォルト値が適用されます。コンストラクタは新しいオブジェクトを初期化する役割を持つため、特定の値を返すことはありません。

AssertionErrorクラスのコンストラクタは、内部でその親クラスであるErrorクラスのコンストラクタを呼び出しています。これは、エラーメッセージやコードといった基本的なプロパティを初期化するためです。サンプルコードのMyCustomErrorクラスは、Errorクラスを継承し、parent::__constructを呼び出すことで、この初期化の仕組みを具体的に示しています。通常、AssertionErrorは開発者が直接インスタンス化するよりも、assert()関数の失敗によってPHPエンジンが自動的にスローすることが多いです。