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

Copy
1<?php
2
3/**
4 * DOMExceptionを継承し、PHP 8のコンストラクタプロパティプロモーションを利用したカスタム例外クラス。
5 * システムエンジニアを目指す初心者向けに、PHP 8で導入された便利な記法を示します。
6 */
7class MyCustomDOMException extends DOMException
8{
9    /**
10     * カスタムDOM例外のコンストラクタ。
11     *
12     * PHP 8のコンストラクタプロパティプロモーションにより、
13     * 引数にアクセス修飾子 (public, protected, private) を付けることで、
14     * その引数が自動的に同名のクラスプロパティとして定義され、値が初期化されます。
15     * これにより、クラスプロパティの宣言とコンストラクタでの代入を簡潔に記述できます。
16     *
17     * @param string $message 例外のメッセージ。デフォルトは空文字列。
18     * @param int $code 例外のコード。デフォルトは0。
19     * @param Throwable|null $previous 前の例外。ネストされた例外を扱う場合に指定。
20     */
21    public function __construct(
22        public string $message = '',
23        public int $code = 0,
24        public ?Throwable $previous = null
25    ) {
26        // 親クラス (DOMException) のコンストラクタを呼び出し、
27        // 例外の基本情報 (メッセージ、コード、前の例外) を設定します。
28        // プロパティプロモーションされた引数をそのまま渡します。
29        parent::__construct($message, $code, $previous);
30    }
31
32    /**
33     * 例外に関する追加情報を返すカスタムメソッド。
34     */
35    public function getCustomErrorInfo(): string
36    {
37        return "詳細情報: このDOM操作関連のエラーはコード {$this->code} で発生しました。";
38    }
39}
40
41// --- サンプルコードの実行部分 ---
42
43echo "--- 最初の例外捕捉 ---" . "\n";
44try {
45    // MyCustomDOMExceptionのインスタンスを作成し、スローします。
46    // コンストラクタ引数でメッセージとコードを指定。
47    throw new MyCustomDOMException("XMLファイルのパースに失敗しました。", 1001);
48
49} catch (MyCustomDOMException $e) {
50    // MyCustomDOMExceptionを捕捉した場合の処理
51    echo "捕捉されたカスタムDOM例外:\n";
52    echo "メッセージ: " . $e->getMessage() . "\n"; // 親クラスのメソッドでメッセージを取得
53    echo "コード: " . $e->getCode() . "\n";       // 親クラスのメソッドでコードを取得
54    
55    // PHP 8のプロパティプロモーションにより、引数にアクセス修飾子を付けた変数は
56    // クラスのプロパティとなるため、直接アクセスできます。
57    echo "プロパティ (message) から: " . $e->message . "\n";
58    echo "プロパティ (code) から: " . $e->code . "\n";
59
60    // カスタムメソッドの使用例
61    echo $e->getCustomErrorInfo() . "\n";
62}
63
64echo "\n";
65
66echo "--- 前の例外を伴う例外捕捉 ---" . "\n";
67try {
68    // 元となる例外 (前の例外) を作成します。
69    $originalError = new InvalidArgumentException("無効な引数が渡されました。");
70
71    // MyCustomDOMExceptionをスローし、メッセージ、コード、そして元の例外を渡します。
72    throw new MyCustomDOMException(
73        "DOMツリーの構築中に内部エラーが発生しました。",
74        1002,
75        $originalError
76    );
77
78} catch (MyCustomDOMException $e) {
79    echo "捕捉されたカスタムDOM例外 (前の例外あり):\n";
80    echo "メッセージ: " . $e->getMessage() . "\n";
81    echo "コード: " . $e->getCode() . "\n";
82
83    // 前の例外が存在する場合、その情報を表示
84    if ($e->getPrevious() !== null) {
85        echo "前の例外のクラス: " . get_class($e->getPrevious()) . "\n";
86        echo "前の例外のメッセージ: " . $e->getPrevious()->getMessage() . "\n";
87    }
88    
89    // プロパティプロモーションによって定義されたプロパティ (previous) からも
90    // 前の例外に直接アクセスできます。
91    if ($e->previous !== null) {
92        echo "プロパティ (previous) からの前の例外メッセージ: " . $e->previous->getMessage() . "\n";
93    }
94}
95
96?>

このPHPサンプルコードは、PHP 8で導入された「コンストラクタプロパティプロモーション」という記法を活用し、DOMExceptionを継承したカスタム例外クラスMyCustomDOMExceptionを定義しています。__constructメソッドは、クラスの新しいインスタンスが作成される際に自動的に呼び出される初期化処理です。PHP 8のこの新機能では、コンストラクタの引数にpublicなどのアクセス修飾子を付けることで、その引数が自動的に同名のクラスプロパティとして定義され、値が初期化されます。これにより、プロパティの宣言とコンストラクタでの代入を非常に簡潔に記述できるようになります。

引数$messageは例外の具体的な内容を説明する文字列で、$codeは例外の種類を識別するための整数値です。$previousはオプションで、現在の例外が別の例外によって発生した場合に、その元の例外オブジェクト（Throwableインターフェースを実装するオブジェクト）を渡します。これにより、エラーの連鎖を追跡しやすくなります。これらの引数はparent::__constructを呼び出すことで、親クラスであるDOMExceptionの基本的な例外情報として設定されます。__constructメソッドはオブジェクトを初期化する役割を持つため、戻り値はありません。

実行部分では、MyCustomDOMExceptionがどのようにインスタンス化され、throw文でスローされ、catchブロックで捕捉されるかを示しています。捕捉された例外オブジェクトからは、getMessage()やgetCode()といった親クラスのメソッドに加え、プロパティプロモーションによって定義された$e->messageや$e->codeといったプロパティに直接アクセスできることが確認できます。また、$previousプロパティを利用して、元の例外情報を取得する方法も示されています。

Copy
1<?php
2
3// DOMExceptionを継承したカスタム例外クラスを定義します。
4// これにより、DOM関連のエラーをより具体的にハンドリングできます。
5class MyCustomDOMException extends DOMException
6{
7    /**
8     * MyCustomDOMException のコンストラクタ。
9     *
10     * @param string $message 例外メッセージ。
11     * @param int $code 例外コード。
12     * @param Throwable|null $previous 例外チェーンのための前の例外。
13     */
14    public function __construct(string $message = '', int $code = 0, ?Throwable $previous = null)
15    {
16        // 親クラスであるDOMExceptionのコンストラクタを呼び出します。
17        // これにより、DOMExceptionの基本的なプロパティ（メッセージ、コード、前の例外）が初期化されます。
18        // 'parent::__construct' は、継承元のクラスのコンストラクタを実行するために使用されます。
19        parent::__construct($message, $code, $previous);
20
21        // ここにカスタム例外に固有の初期化処理を追加することも可能です。
22        // 例: エラーログの記録など
23    }
24}
25
26// サンプルとして、このカスタム例外を使用する例を示します。
27try {
28    // 実際にはDOM操作の結果としてこの例外がスローされる状況を想定します。
29    // 例: 特定のDOM要素が見つからない、XMLのパースに失敗した、など。
30    $isDomOperationSuccessful = false;
31
32    if (!$isDomOperationSuccessful) {
33        // DOM操作が失敗した場合、MyCustomDOMExceptionをスローします。
34        // コンストラクタで指定したメッセージとコードが例外に格納されます。
35        throw new MyCustomDOMException("DOM要素の取得に失敗しました。", 1001);
36    }
37
38    echo "DOM操作は正常に完了しました。\n";
39
40} catch (MyCustomDOMException $e) {
41    // MyCustomDOMExceptionを捕捉し、エラー情報を表示します。
42    echo "--- カスタムDOMエラーが発生しました ---\n";
43    echo "メッセージ: " . $e->getMessage() . "\n";
44    echo "コード: " . $e->getCode() . "\n";
45    echo "ファイル: " . $e->getFile() . "\n";
46    echo "行: " . $e->getLine() . "\n";
47} catch (DOMException $e) {
48    // もしMyCustomDOMExceptionではない、一般的なDOMExceptionが発生した場合に捕捉します。
49    echo "--- 一般的なDOMエラーが発生しました ---\n";
50    echo "メッセージ: " . $e->getMessage() . "\n";
51    echo "コード: " . $e->getCode() . "\n";
52} catch (Throwable $e) {
53    // その他の全ての例外を捕捉します。
54    echo "--- 予期せぬエラーが発生しました ---\n";
55    echo "メッセージ: " . $e->getMessage() . "\n";
56}
57
58?>

PHPのDOMExceptionクラスは、XMLやHTMLなどのDOM（Document Object Model）操作中に発生する特定のエラーを表すための標準的な例外です。このDOMExceptionの__constructメソッドは、新しいDOMExceptionオブジェクトが作成される際に、その初期状態を設定するために使用されます。

提供されたサンプルコードでは、DOMExceptionを継承してMyCustomDOMExceptionという独自の例外クラスを定義し、そのコンストラクタ内で親クラスの__constructを呼び出す方法を示しています。

__constructメソッドは、以下の引数を受け取ります。$message（文字列）は、例外がなぜ発生したのかを説明する人間が読める形式のメッセージです。$code（整数）は、エラーの種類を識別するための固有の数値コードです。$previous（Throwableまたはnull）は、現在の例外が別の例外によって引き起こされた場合に、その前の例外オブジェクトを参照するために使用され、例外の連鎖を可能にします。

このメソッドは新しいオブジェクトを初期化する役割を持つため、特定の値を戻り値として返しません。サンプルコード中のparent::__construct($message, $code, $previous);という記述は、MyCustomDOMExceptionが継承しているDOMExceptionクラスのコンストラクタを明示的に呼び出し、メッセージやコード、前の例外といった基本的な例外情報を適切に初期化するために不可欠です。これにより、カスタム例外でも親クラスの持つ例外処理の仕組みを完全に利用できるようになります。続くtry-catchブロックでは、このカスタム例外を実際にスローし、捕捉する例を通じてその利用方法を示しています。