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

Copy
1<?php
2
3/**
4 * XMLドキュメント内のエンティティ定義を取得し、その名前を表示するサンプルコード。
5 *
6 * DTD（Document Type Definition）で定義されたエンティティノード (Dom\Entity) を
7 * DOMDocument を使って抽出し、nodeName プロパティでエンティティ名を取得します。
8 */
9function displayEntityNodeNames(): void
10{
11    // DTD内で 'writer' と 'company' という2つのエンティティを定義したXML文字列
12    $xmlString = <<<XML
13    <?xml version="1.0" encoding="UTF-8"?>
14    <!DOCTYPE note [
15      <!ENTITY writer "Taro Yamada">
16      <!ENTITY company "Example Inc.">
17    ]>
18    <note>
19      <from>&writer;</from>
20      <corp>&company;</corp>
21    </note>
22    XML;
23
24    // DOMDocumentオブジェクトをインスタンス化
25    $dom = new DOMDocument();
26
27    // XML文字列を読み込み、パースする
28    $dom->loadXML($xmlString);
29
30    // DTDを表す DocumentType ノードを取得
31    $doctype = $dom->doctype;
32
33    // DocumentType ノードが存在し、エンティティのリストを持っているか確認
34    if ($doctype && $doctype->entities) {
35        echo "DTDで定義されているエンティティ名一覧:" . PHP_EOL;
36
37        // エンティティのリスト (DOMNamedNodeMap) をループ処理
38        // 各要素は Dom\Entity オブジェクト
39        foreach ($doctype->entities as $entity) {
40            // Dom\Entity オブジェクトの nodeName プロパティはエンティティ名を返す
41            // この例では 'writer' と 'company' が出力される
42            echo "- " . $entity->nodeName . PHP_EOL;
43        }
44    }
45}
46
47// 関数を実行
48displayEntityNodeNames();
49

このPHPサンプルコードは、XMLドキュメント内に含まれるDTD（Document Type Definition）で定義されたエンティティの名前を取得し、画面に表示するものです。Dom\Entityは、DTD内で<!ENTITY ...>構文によって定義された一つのエンティティを表すオブジェクトです。

nodeNameは、このDom\Entityオブジェクトが持つプロパティ（値を保持する変数のようなもの）です。このプロパティにアクセスすると、そのエンティティの名前を文字列として取得できます。nodeNameプロパティは引数を取らず、参照すると戻り値としてエンティティ名（サンプルコードでは "writer" や "company"）を返します。

コードの処理の流れとして、まずDOMDocumentクラスでDTDを含むXMLデータを読み込みます。次に、doctypeプロパティを通じてDTDの情報にアクセスし、さらにその中のentitiesプロパティから定義済みの全エンティティのリストを取得します。最後に、foreachループでリスト内の各エンティティオブジェクトを取り出し、それぞれのnodeNameプロパティを参照することでエンティティ名を取得して出力しています。