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

Copy
1<?php
2
3/**
4 * Dom\EntityReference の nodeType プロパティの使用例を示します。
5 *
6 * XML内のエンティティ参照ノードを取得し、そのノードタイプが
7 * XML_ENTITY_REF_NODE (値: 5) であることを確認します。
8 */
9function demonstrateEntityReferenceNodeType(): void
10{
11    // 内部エンティティ (&writer;) を含むXML文字列を定義します。
12    $xmlString = <<<XML
13    <?xml version="1.0" encoding="UTF-8"?>
14    <!DOCTYPE root [
15        <!ENTITY writer "John Doe">
16    ]>
17    <root>
18        <author>&writer;</author>
19    </root>
20    XML;
21
22    // DOMDocumentオブジェクトを作成します。
23    $dom = new DOMDocument();
24
25    // エンティティ参照をテキストノードに置換せず、
26    // Dom\EntityReference ノードとして保持するためのオプションです。
27    // これが false でないとエンティティ参照ノードを取得できません。
28    $dom->substituteEntities = false;
29
30    // XML文字列を読み込みます。
31    $dom->loadXML($xmlString);
32
33    // <author> タグの最初の子ノード (エンティティ参照ノード &writer;) を取得します。
34    $entityReferenceNode = $dom->getElementsByTagName('author')->item(0)->firstChild;
35
36    // 取得したノードが Dom\EntityReference のインスタンスであることを確認します。
37    if ($entityReferenceNode instanceof DOMEntityReference) {
38        // nodeType プロパティはノードの種類を整数で返します。
39        // Dom\EntityReference の場合、常に 5 (XML_ENTITY_REF_NODE) となります。
40        $nodeType = $entityReferenceNode->nodeType;
41
42        echo "ノード名: " . $entityReferenceNode->nodeName . PHP_EOL; // 出力例: writer
43        echo "ノードタイプ: " . $nodeType . PHP_EOL; // 出力例: 5
44
45        // 定数 XML_ENTITY_REF_NODE を使って型を比較します。
46        if ($nodeType === XML_ENTITY_REF_NODE) {
47            echo "このノードはエンティティ参照 (DOMEntityReference) です。" . PHP_EOL;
48        }
49    }
50}
51
52// 関数を実行します。
53demonstrateEntityReferenceNodeType();
54

このPHPサンプルコードは、XML文書を操作する際に、特定のノードの種類を識別する方法を示しています。具体的には、XML内の「エンティティ参照」ノードを取得し、その種類を nodeType プロパティを使って確認する例です。

nodeType プロパティは、DOMにおける各ノードがどのような種類（要素、テキスト、コメントなど）であるかを示す整数値を返します。このプロパティは引数を取らず、戻り値としてノードの種類に応じた整数が返ってきます。

コードでは、まず &writer; というエンティティ参照を含むXMLデータを用意します。DOMDocument を使ってこのXMLを読み込む際、エンティティ参照をそのままのノードとして扱うために、substituteEntities プロパティを false に設定しています。これにより、エンティティ参照が文字列に置き換えられるのを防ぎます。

次に、XMLデータからエンティティ参照ノードを取得し、その nodeType プロパティの値を出力します。Dom\EntityReference 型のノードの場合、nodeType は常に 5 という決まった値を返します。この値は、PHPの定義済み定数 XML_ENTITY_REF_NODE と一致するため、ノードの種類を確実に判別できます。このように nodeType を使うことで、ノードの種類に応じた適切な処理をプログラムで記述することが可能になります。

Copy
1<?php
2
3/**
4 * Dom\EntityReferenceのnodeTypeプロパティの例を示します。
5 *
6 * nodeTypeは、ノードの種類を識別するための整数値を返します。
7 * Dom\EntityReferenceの場合、この値は常に 5 (XML_ENTITY_REF_NODE) となります。
8 */
9function demonstrateEntityReferenceNodeType(): void
10{
11    // エンティティ参照(&writer;)を含むXML文字列を用意します。
12    // DTD内でエンティティ 'writer' を定義しています。
13    $xmlString = <<<XML
14<?xml version="1.0" encoding="UTF-8"?>
15<!DOCTYPE root [
16    <!ENTITY writer "Sample Author">
17]>
18<book>
19    <author>&writer;</author>
20</book>
21XML;
22
23    // DOMDocumentオブジェクトを生成します。
24    $dom = new DOMDocument();
25
26    // falseに設定すると、エンティティ参照(&writer;)がテキストに置換されず、
27    // DOMEntityReferenceノードとして扱われるようになります。これが重要です。
28    $dom->substituteEntities = false;
29
30    // XML文字列を読み込み、DOMツリーを構築します。
31    $dom->loadXML($xmlString);
32
33    // <author>要素を取得します。
34    $authorElement = $dom->getElementsByTagName('author')->item(0);
35
36    // <author>要素の最初の子ノード（&writer; に対応するエンティティ参照ノード）を取得します。
37    $entityRefNode = $authorElement->firstChild;
38
39    // 取得したノードが DOMEntityReference のインスタンスか確認します。
40    if ($entityRefNode instanceof DOMEntityReference) {
41        // nodeTypeプロパティの値を出力します。
42        // DOMEntityReferenceのnodeTypeは常に 5 を返します。
43        echo "Node Name: " . $entityRefNode->nodeName . PHP_EOL;
44        echo "Node Type: " . $entityRefNode->nodeType . PHP_EOL;
45
46        // 定数 XML_ENTITY_REF_NODE (値は5) と比較して、型が正しいことを確認します。
47        if ($entityRefNode->nodeType === XML_ENTITY_REF_NODE) {
48            echo "This node is an Entity Reference (XML_ENTITY_REF_NODE)." . PHP_EOL;
49        }
50    }
51}
52
53// 関数を実行して結果を表示します。
54demonstrateEntityReferenceNodeType();
55
56/*
57出力結果:
58Node Name: writer
59Node Type: 5
60This node is an Entity Reference (XML_ENTITY_REF_NODE).
61*/
62

Dom\EntityReferenceクラスのnodeTypeプロパティは、XMLドキュメント内のノードの種類を識別するための整数値を返します。このプロパティは引数を取らず、戻り値としてノードの種類を示すint型の整数を返します。Dom\EntityReference（エンティティ参照ノード）の場合、nodeTypeプロパティが返す値は常に5です。この5という数値は、PHPの定義済み定数XML_ENTITY_REF_NODEに対応しており、プログラムでノードがエンティティ参照であることを判定する際に利用できます。

サンプルコードでは、まずDTD（文書型定義）でエンティティ&writer;を定義したXML文字列を準備します。次にDOMDocumentオブジェクトを作成し、substituteEntitiesプロパティをfalseに設定します。この設定により、&writer;がテキストに置き換えられることなく、エンティティ参照ノードとして扱われるようになります。XMLを読み込んだ後、<author>要素の子ノードとしてエンティティ参照ノードを取得し、そのnodeTypeプロパティの値を出力しています。結果として5が表示され、このノードがエンティティ参照であることが確認できます。