【PHP8.x】Dom\Entity::nodeTypeプロパティの使い方

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * DOMノードの nodeType プロパティの例を示すクラス
7 *
8 * このサンプルでは、DTD（文書型定義）で定義されたエンティティノード (DOMEntity) を含む
9 * XMLをパースし、その nodeType を確認します。他のノードタイプと比較することで、
10 * nodeType プロパティの役割を理解しやすくします。
11 */
12class DomNodeTypeExample
13{
14    /**
15     * サンプルコードを実行します。
16     */
17    public static function run(): void
18    {
19        // DTDでエンティティ '&myEntity;' を宣言したXML文字列を定義します。
20        $xmlString = <<<XML
21        <?xml version="1.0" encoding="UTF-8"?>
22        <!DOCTYPE document [
23            <!ENTITY myEntity "This is an example entity.">
24        ]>
25        <document>
26            <elementNode>Hello, World!</elementNode>
27        </document>
28        XML;
29
30        // DOMDocumentオブジェクトを作成します。
31        $doc = new \DOMDocument();
32
33        try {
34            // DTDを読み込むオプション(LIBXML_DTDLOAD)を有効にしてXMLを読み込みます。
35            // これにより、DTDで宣言されたエンティティが認識されます。
36            if (!$doc->loadXML($xmlString, LIBXML_DTDLOAD)) {
37                throw new \Exception('Failed to load XML string.');
38            }
39
40            // DocumentTypeノードからエンティティのリストを取得します。
41            // $doc->doctype は <DOCTYPE ... > 全体を表すノードです。
42            $entities = $doc->doctype->entities;
43
44            // 'myEntity' という名前のエンティティノード (Dom\Entity) を取得します。
45            $entityNode = $entities->getNamedItem('myEntity');
46
47            // Dom\Entity の nodeType を表示します。
48            // XML_ENTITY_NODE という定数で定義されており、その値は 6 です。
49            if ($entityNode instanceof \DOMEntity) {
50                printf(
51                    "Node Name: %s, Node Type: %d (XML_ENTITY_NODE)\n",
52                    $entityNode->nodeName, // "myEntity"
53                    $entityNode->nodeType  // 6
54                );
55            }
56
57            // 比較のために、他のノードのnodeTypeも表示します。
58            // 要素ノード (DOMElement) の nodeType は 1 (XML_ELEMENT_NODE) です。
59            $elementNode = $doc->getElementsByTagName('elementNode')->item(0);
60            if ($elementNode instanceof \DOMElement) {
61                printf(
62                    "Node Name: %s, Node Type: %d (XML_ELEMENT_NODE)\n",
63                    $elementNode->nodeName, // "elementNode"
64                    $elementNode->nodeType  // 1
65                );
66            }
67        } catch (\Exception $e) {
68            echo 'エラー: ' . $e->getMessage() . PHP_EOL;
69        }
70    }
71}
72
73// サンプルコードを実行
74DomNodeTypeExample::run();

PHPのDom\Entityクラスに所属するnodeTypeは、DOMツリーにおけるノードの種類を識別するための整数値を返す読み取り専用のプロパティです。ここでいうDom\Entityとは、XMLのDTD（文書型定義）で宣言されたエンティティを表すノードを指します。

このプロパティは引数を取らず、戻り値としてノードの種類を示す整数（int）を返します。Dom\Entityオブジェクトの場合、nodeTypeは常にPHPの定義済み定数XML_ENTITY_NODEが示す値、つまり6を返します。

サンプルコードでは、まずDTDでmyEntityという名前のエンティティを定義したXML文字列をDOMDocumentオブジェクトに読み込みます。次に、doctypeプロパティを通じてこのエンティティノードを取得し、そのnodeTypeプロパティの値が6であることを確認しています。さらに比較対象として、<elementNode>という要素ノードのnodeTypeも取得しており、こちらは1（XML_ELEMENT_NODE）が返されます。このようにnodeTypeプロパティを利用することで、プログラムはノードの種類を正確に判別し、種類に応じた処理を実装することが可能になります。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * Dom\EntityのnodeTypeプロパティの使用例を示します。
7 *
8 * DTD（文書型定義）に宣言されたエンティティを取得し、
9 * そのノードタイプが6 (XML_ENTITY_NODE) であることを確認します。
10 */
11function showEntityNodeTypeExample(): void
12{
13    // DTD内でエンティティを宣言したXML文字列を準備します。
14    // `<!ENTITY writer ...>` の部分がエンティティ宣言です。
15    $xmlString = <<<XML
16<?xml version="1.0" encoding="UTF-8"?>
17<!DOCTYPE memo [
18  <!ENTITY writer "Taro Yamada">
19  <!ENTITY company "Example Inc.">
20]>
21<memo>
22  <from>&writer;</from>
23  <to>Hanako Suzuki</to>
24  <footer>&company;</footer>
25</memo>
26XML;
27
28    // DOMドキュメントオブジェクトを生成し、XMLを読み込みます。
29    $dom = new \Dom\Document();
30    $dom->loadXML($xmlString);
31
32    // DocumentTypeノード（DTD全体を表すノード）を取得します。
33    $doctype = $dom->doctype;
34
35    // DocumentTypeノードが存在する場合のみ処理を実行します。
36    if ($doctype) {
37        echo "文書型定義 (DTD) 内のエンティティを検査します。\n\n";
38
39        // DocumentTypeが持つエンティティのリスト (Dom\NamedNodeMap) をループ処理します。
40        // リスト内の各要素は Dom\Entity オブジェクトです。
41        foreach ($doctype->entities as $entity) {
42            // $entity は Dom\Entity オブジェクトです。
43            echo "エンティティ名: " . $entity->nodeName . "\n";
44
45            // nodeTypeプロパティでノードの種類を整数で取得します。
46            // Dom\Entity の場合、この値は常に 6 となります。
47            // これはPHPの定義済み定数 XML_ENTITY_NODE の値と同じです。
48            echo "ノードタイプ: " . $entity->nodeType . " (定数: XML_ENTITY_NODE)\n";
49            echo "---\n";
50        }
51    } else {
52        echo "このXMLドキュメントに文書型定義(DTD)が見つかりません。\n";
53    }
54}
55
56// 関数を実行して結果を表示します。
57showEntityNodeTypeExample();

PHPのDom\Entityクラスが持つnodeTypeプロパティは、DOMツリー内のノードがどの種類に属するかを識別するための整数値を返します。Dom\Entityオブジェクトの場合、このプロパティは常に6という値を返します。この数値は、PHPの定義済み定数XML_ENTITY_NODEに相当し、そのノードがDTD（文書型定義）で宣言されたエンティティであることを示します。このプロパティは値を取得する機能のため、引数は必要ありません。戻り値はノードの種類を表す整数(int)です。

このサンプルコードは、まずDTD内で2つのエンティティ (writer, company) を宣言したXML文字列を準備します。次に、Dom\Documentクラスを用いてこのXMLを解析し、文書構造をオブジェクトとして扱えるようにします。コードは文書のDTD部分 (Dom\DocumentType) を取得し、その中に含まれるエンティティのリストを一つずつループ処理で取り出します。そして、各エンティティオブジェクトのnodeTypeプロパティにアクセスし、その値が6であることを確認・表示することで、XML文書内のエンティティがプログラム上で正しく認識されていることを示しています。