【PHP8.x】codeプロパティの使い方

Copy
1<?php
2
3/**
4 * CodeIgniterのコントローラーを模した、XML処理クラスのサンプルです。
5 * 意図的にDOM操作エラーを発生させ、DOMExceptionのcodeプロパティを取得します。
6 */
7class XmlProcessorController
8{
9    /**
10     * 不正なXMLデータを処理し、DOMExceptionを捕捉します。
11     */
12    public function processXml(): void
13    {
14        try {
15            // DOMDocumentオブジェクトを作成
16            $dom = new \DOMDocument('1.0', 'UTF-8');
17            $dom->loadXML('<root><item>Hello</item></root>');
18
19            // テキストノードを取得
20            $itemNode = $dom->getElementsByTagName('item')->item(0);
21            if ($itemNode === null || $itemNode->firstChild === null) {
22                throw new \Exception('指定されたノードが見つかりません。');
23            }
24            $textNode = $itemNode->firstChild;
25
26            // DOMExceptionを意図的に発生させる
27            // テキストノード(葉)に子要素を追加しようとするとエラーが発生する
28            $newElement = $dom->createElement('child');
29            $textNode->appendChild($newElement);
30
31            echo "XMLの処理が正常に完了しました。\n";
32        } catch (\DOMException $e) {
33            // DOMExceptionを捕捉し、エラー情報を表示する
34            echo "DOM操作中にエラーが発生しました。\n";
35
36            // codeプロパティからエラーコード(int)を取得する
37            $errorCode = $e->getCode();
38            echo "エラーコード: " . $errorCode . "\n";
39            echo "エラーメッセージ: " . $e->getMessage() . "\n";
40
41            // エラーコードに応じて処理を分岐する
42            switch ($errorCode) {
43                case DOM_HIERARCHY_REQUEST_ERR: // コード 3
44                    echo "エラー詳細: ノードを階層的に不正な場所に追加しようとしました。\n";
45                    break;
46                case DOM_NOT_FOUND_ERR: // コード 8
47                    echo "エラー詳細: 存在しないノードを参照しようとしました。\n";
48                    break;
49                default:
50                    echo "エラー詳細: その他のDOMエラーです。\n";
51                    break;
52            }
53        } catch (\Exception $e) {
54            // その他の例外を捕捉
55            echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
56        }
57    }
58}
59
60// クラスのインスタンスを作成し、メソッドを実行
61$controller = new XmlProcessorController();
62$controller->processXml();
63

DOMExceptionのcodeプロパティは、PHPでXMLやHTMLなどを操作（DOM操作）する際にエラーが発生したとき、そのエラーの種類を識別するための整数値（エラーコード）を取得するものです。このプロパティは引数なしでアクセスでき、戻り値としてエラーの種類に応じた整数(int)を返します。

サンプルコードは、CodeIgniterのコントローラーを模したクラスで、意図的にDOM操作のエラーを発生させています。tryブロック内で、テキストデータしか持てないテキストノードに、さらに子要素を追加しようとすることでDOMExceptionを発生させます。

処理がcatchブロックに移行すると、例外オブジェクト$eのgetCode()メソッド（内部的にはcodeプロパティにアクセス）を呼び出し、エラーコードを取得します。取得したコードをswitch文で評価し、DOM_HIERARCHY_REQUEST_ERR（コード値3）のようなPHPの定義済み定数と比較することで、エラーの原因を特定し、状況に応じた具体的なエラーメッセージの表示や代替処理を行うことができます。このようにcodeプロパティは、詳細なエラーハンドリングを実装する上で重要な役割を果たします。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * DOMExceptionのcodeプロパティの使用例を示すクラス
7 *
8 * このコードはPHP_CodeSnifferのPSR-12標準に準拠しています。
9 */
10class DomExceptionCodeExample
11{
12    /**
13     * DOM操作で意図的に例外を発生させ、エラーコードを捕捉して表示します。
14     *
15     * @return void
16     */
17    public function demonstrate(): void
18    {
19        try {
20            // DOMDocumentオブジェクトを作成
21            $dom = new \DOMDocument('1.0', 'UTF-8');
22
23            // 親要素と子要素を作成
24            $parentElement = $dom->createElement('parent');
25            $childElement = $dom->createElement('child');
26
27            // 存在しない参照ノードの前に要素を挿入しようとして、
28            // DOMException (NOT_FOUND_ERR) を意図的に発生させる
29            // 参照ノードが親要素に属していないため、例外がスローされます。
30            $parentElement->insertBefore($childElement, new \DOMText('参照ノード'));
31        } catch (\DOMException $e) {
32            // 捕捉したDOMExceptionからエラーコードとメッセージを取得して表示
33            echo 'DOM操作中にエラーが発生しました。' . PHP_EOL;
34            // $e->code は DOMException::NOT_FOUND_ERR (値は 8) を返します
35            echo 'エラーコード: ' . $e->getCode() . PHP_EOL;
36            echo 'メッセージ: ' . $e->getMessage() . PHP_EOL;
37        }
38    }
39}
40
41// クラスのインスタンスを作成し、メソッドを実行
42$example = new DomExceptionCodeExample();
43$example->demonstrate();

PHPのdom\domexceptionクラスのcodeプロパティは、DOM（Document Object Model）操作中に発生した例外の種類を示す整数値を取得するために使用されます。このプロパティは引数を取らず、エラーコードをint型で返します。

提供されたサンプルコードでは、DOMDocumentを使ってXMLのような構造を操作する際に、意図的にDOMExceptionを発生させています。具体的には、存在しない参照ノードの前に要素を挿入しようとすることで、「NOT_FOUND_ERR」（ノードが見つからないエラー）という種類の例外がスローされます。

try-catchブロックでこの\DOMExceptionを捕捉すると、捕捉した例外オブジェクト$eの$e->getCode()（または$e->code）を通じて、エラーの種類を示す数値を取得できます。この例では、NOT_FOUND_ERRに対応する整数値「8」が出力されます。このように、codeプロパティを利用することで、発生したDOMエラーが具体的にどのような原因によるものかをプログラムで判断し、適切なエラー処理を行うことが可能になります。また、このコードはPHP_CodeSnifferのPSR-12標準に準拠しており、コードの品質と可読性を保つ一例ともなっています。