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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * DOMEntityReferenceのnodeTypeプロパティの使用例を示します。
7 *
8 * XMLドキュメント内にエンティティ参照 (&example;) を定義し、
9 * そのノードのnodeTypeプロパティの値を確認します。
10 */
11function demonstrateDomEntityReferenceNodeType(): void
12{
13    // DTDでエンティティ "example" を定義したXML文字列
14    // &example; がエンティティ参照です。
15    $xmlString = <<<XML
16<?xml version="1.0" encoding="UTF-8"?>
17<!DOCTYPE root [
18    <!ENTITY example "This is an entity content.">
19]>
20<root>
21    <p>Here is an entity reference: &example;</p>
22</root>
23XML;
24
25    // DOMDocumentオブジェクトを作成
26    $dom = new DOMDocument();
27
28    // エンティティ参照をノードとして保持するための設定 (重要)
29    // falseにしないと、エンティティ参照はその内容に置き換えられてしまいます。
30    $dom->substituteEntities = false;
31
32    // XML文字列を読み込む
33    $dom->loadXML($xmlString);
34
35    // <p>要素を取得
36    $pElement = $dom->getElementsByTagName('p')->item(0);
37
38    // <p>要素の子ノードを走査
39    foreach ($pElement->childNodes as $childNode) {
40        // ノードがエンティティ参照 (DOMEntityReference) かどうかを判定
41        if ($childNode instanceof DOMEntityReference) {
42            // DOMEntityReference の nodeType は常に 5 (XML_ENTITY_REF_NODE) です。
43            echo "Node Name: " . $childNode->nodeName . PHP_EOL;
44            echo "Node Type: " . $childNode->nodeType . PHP_EOL;
45
46            // nodeType の値を定数と比較して検証
47            if ($childNode->nodeType === XML_ENTITY_REF_NODE) {
48                echo "The nodeType matches XML_ENTITY_REF_NODE." . PHP_EOL;
49            }
50            break; // 目的のノードが見つかったのでループを抜ける
51        }
52    }
53}
54
55demonstrateDomEntityReferenceNodeType();
56

PHPのDOMEntityReferenceクラスが持つnodeTypeプロパティは、そのノードの種類を識別するための整数値を返します。DOMEntityReferenceオブジェクトの場合、このプロパティの値は常に5となります。この数値は、PHPにあらかじめ定義されている定数XML_ENTITY_REF_NODEと等価です。

サンプルコードは、XML文書内に含まれるエンティティ参照（&example;）のノードタイプを確認する例です。まず、エンティティを定義したXML文字列からDOMDocumentオブジェクトを生成します。ここで$dom->substituteEntities = false;と設定することが重要です。この設定により、エンティティ参照がテキストに置き換えられることなく、独立したノードとして扱えるようになります。次に、XMLを読み込み、特定の要素（この例では<p>タグ）の子ノードを順番に調べていきます。instanceof演算子を使って、ノードがDOMEntityReferenceであるかを判定し、該当すればnodeTypeプロパティの値を取得します。このプロパティは引数を取らず、ノードの種類を示す整数を戻り値として返します。このようにnodeTypeプロパティを使うことで、DOMツリーを処理する際にノードの種類を正確に判別することが可能です。