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

Copy
1<?php
2
3/**
4 * DOMEntityReferenceのnodeNameプロパティの使用例を示します。
5 * XMLドキュメント内のエンティティ参照ノードの名前を取得します。
6 */
7function demonstrateEntityReferenceNodeName(): void
8{
9    // DTDでカスタムエンティティ '&example_entity;' を定義したXML文字列。
10    // エンティティ参照ノードを作成するために必要です。
11    $xmlString = <<<XML
12<?xml version="1.0" encoding="UTF-8"?>
13<!DOCTYPE root [
14  <!ENTITY example_entity "これはカスタムエンティティのテキストです。">
15]>
16<root>
17  <message>テキストとエンティティ参照 &example_entity; を含みます。</message>
18</root>
19XML;
20
21    // DOMDocument オブジェクトを作成します。
22    $dom = new DOMDocument();
23
24    // XML文字列を読み込みます。
25    // PHP 8と近年のXMLパーサは、エンティティ参照を
26    // DOMEntityReferenceオブジェクトとして扱います。
27    $dom->loadXML($xmlString);
28
29    // <message> タグを持つ要素を取得します。
30    $messageElement = $dom->getElementsByTagName('message')->item(0);
31
32    // <message> 要素の子ノードを順番に調べます。
33    foreach ($messageElement->childNodes as $childNode) {
34        // ノードがエンティティ参照 (DOMEntityReference) かどうかを確認します。
35        if ($childNode instanceof DOMEntityReference) {
36            // nodeName プロパティはエンティティの名前 ('&' と ';' を除く) を返します。
37            // この例では "example_entity" という文字列が取得できます。
38            echo 'Node Type: ' . get_class($childNode) . PHP_EOL;
39            echo 'nodeName: ' . $childNode->nodeName . PHP_EOL;
40        }
41    }
42}
43
44// 関数を実行します。
45demonstrateEntityReferenceNodeName();

このサンプルコードは、PHPのDOMEntityReferenceクラスが持つnodeNameプロパティの使用方法を示しています。このプロパティは、XMLドキュメント内のエンティティ参照ノードの名前を文字列として取得する役割を持ちます。

コードでは、まずDTD（文書型定義）を用いて&example_entity;というカスタムエンティティを定義したXML文字列を用意します。次に、DOMDocumentオブジェクトでこのXMLを読み込むと、&example_entity;の部分がDOMEntityReferenceオブジェクトとして解釈されます。

その後、特定の要素（この例では<message>）の子ノードを順番に調べ、ノードの種類がDOMEntityReferenceであるかをinstanceof演算子で確認します。該当するノードが見つかった場合、そのnodeNameプロパティにアクセスしています。

nodeNameプロパティは引数を取らず、戻り値としてエンティティの名前、つまり&と;を取り除いた部分（この例ではexample_entity）を文字列で返します。この機能により、XML文書内でどのエンティティが参照されているかをプログラムで簡単に識別できます。