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

Copy
1<?php
2
3try {
4    // エラーメッセージとエラーコードを指定して、dom\domexception のインスタンスを生成し、スローします。
5    // ここで __construct('メッセージ', コード) が暗黙的に呼び出されます。
6    // DOM_NOT_FOUND_ERR は DOM 拡張機能で定義されている定数です (値は 8)。
7    throw new \dom\domexception('指定されたノードが見つかりませんでした。', DOM_NOT_FOUND_ERR);
8} catch (\dom\domexception $e) {
9    // スローされた例外 (dom\domexception) を捕捉します。
10    echo "DOMエラーを捕捉しました。\n";
11
12    // getMessage() メソッドで、コンストラクタの第1引数に渡したエラーメッセージを取得します。
13    echo "メッセージ: " . $e->getMessage() . "\n";
14
15    // getCode() メソッドで、コンストラクタの第2引数に渡したエラーコードを取得します。
16    echo "エラーコード: " . $e->getCode() . "\n";
17}
18
19?>

dom\domexception::__construct() は、DOM操作に関するエラー情報を格納する例外オブジェクトを生成するためのコンストラクタです。このメソッドは、new \dom\domexception() のようにクラスのインスタンスを作成する際に自動的に呼び出されます。

第1引数の $message には、エラーの内容を説明する文字列を指定します。設定したメッセージは、あとで getMessage() メソッドを使って取り出すことができます。

第2引数の $code には、エラーの種類を識別するための整数（エラーコード）を指定します。この値は getCode() メソッドで取得できます。

第3引数の $previous は、別の例外が原因でこの例外が発生した場合に、その元の例外を関連付けるために使用しますが、通常は省略可能です。

コンストラクタはインスタンスの初期化が目的であるため、特定の戻り値はありません。

サンプルコードでは、new を使ってエラーメッセージとエラーコード（DOM_NOT_FOUND_ERR）を持つ dom\domexception オブジェクトを生成し、throw で意図的に例外を発生させています。そして catch ブロックでその例外を捕捉し、getMessage() と getCode() を呼び出して、コンストラクタで設定した情報をコンソールに出力しています。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * DOM操作エラーを表すカスタム例外クラス。
7 *
8 * PHP 8.0で導入された「コンストラクタのプロパティ昇格 (Constructor Property Promotion)」
9 * の機能を利用して、エラーが発生したノードのパス情報を保持するプロパティを定義します。
10 */
11class CustomDomException extends DOMException
12{
13    /**
14     * 新しい CustomDomException インスタンスを生成します。
15     *
16     * @param string $message 例外メッセージ (親クラスから継承)
17     * @param int $code 例外コード (親クラスから継承)
18     * @param ?Throwable $previous 直前の例外
19     * @param ?string $nodePath エラーが発生したノードのパス (プロパティ昇格で定義)
20     */
21    public function __construct(
22        string $message = '',
23        int $code = 0,
24        ?Throwable $previous = null,
25        // コンストラクタの引数で public/protected/private を宣言すると、
26        // 同名のプロパティが自動的に定義され、値が代入されます。
27        // これが「コンストラクタのプロパティ昇格」です。
28        // readonly は PHP 8.1+ の機能で、一度初期化したら変更不可なプロパティを定義します。
29        public readonly ?string $nodePath = null
30    ) {
31        // 親クラスである DOMException のコンストラクタを呼び出します。
32        parent::__construct($message, $code, $previous);
33    }
34}
35
36// --- 実行コード ---
37
38try {
39    // 必須の 'title' ノードが見つからなかった状況をシミュレートします。
40    $requiredNodePath = '/book/title';
41    $isNodeFound = false; // ノードが見つからなかったと仮定
42
43    if (!$isNodeFound) {
44        // カスタム例外をスローします。
45        // コンストラクタの引数で、昇格されたプロパティ 'nodePath' に値を渡します。
46        throw new CustomDomException(
47            message: "Required node could not be found.",
48            code: 404,
49            nodePath: $requiredNodePath
50        );
51    }
52} catch (CustomDomException $e) {
53    // 捕捉した例外オブジェクトから情報を取得して表示します。
54    echo "エラーが発生しました。\n";
55    echo "メッセージ: " . $e->getMessage() . "\n";
56    echo "エラーコード: " . $e->getCode() . "\n";
57
58    // プロパティ昇格によって定義されたプロパティに直接アクセスできます。
59    if ($e->nodePath !== null) {
60        echo "対象ノードパス: " . $e->nodePath . "\n";
61    }
62}

DOMExceptionクラスのコンストラクタ__constructは、DOM操作に関するエラーを表す例外オブジェクトを生成する際に呼び出されます。引数には、エラー内容を示す文字列$message、エラー種別を識別する数値$code、そして例外が連鎖する場合に直前の例外オブジェクトを格納する$previousを指定します。このメソッドに戻り値はありません。

サンプルコードでは、DOMExceptionを継承したCustomDomExceptionという独自の例外クラスを定義しています。ここで特徴的なのは、PHP 8.0で導入された「コンストラクタのプロパティ昇格」という機能です。コンストラクタの引数でpublic readonly ?string $nodePathのようにアクセス修飾子を付けると、$nodePathという同名のプロパティが自動的にクラスに定義され、渡された値が初期値として代入されます。これにより、従来必要だったプロパティ宣言とコンストラクタ内での代入処理を省略でき、コードがより簡潔になります。

このサンプルでは、プロパティ昇格を利用して、エラーが発生したXML/HTMLノードのパス情報を例外オブジェクトに保持させています。try...catch構文で例外を捕捉した際に、$e->nodePathのように昇格させたプロパティに直接アクセスすることで、より詳細なエラー情報を取得できることを示しています。