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

Copy
1<?php
2
3/**
4 * Dom\EntityReference (DOMEntityReference) の childNodes プロパティの使用例を示します。
5 *
6 * XMLドキュメント内のエンティティ参照（例: &my_entity;）は、ノードとして扱われます。
7 * この childNodes プロパティは、そのエンティティが持つ子ノードのリストを返します。
8 * 通常、エンティティがテキストに展開される場合、子ノードは単一のテキストノードになります。
9 */
10function demonstrateEntityReferenceChildNodes(): void
11{
12    // 1. DTD（文書型定義）でエンティティを定義したXML文字列を用意します。
13    // <

PHPのDom\EntityReferenceクラスに属するchildNodesプロパティは、XML文書内のエンティティ参照ノードが持つ子ノードのリストを取得します。エンティティ参照とは、&example;のように、あらかじめ定義された文字列やマークアップに置き換えられるものです。このプロパティは、そのエンティティが展開された結果として生成される、すべての子ノードの集合にアクセスするために使用されます。

このプロパティにアクセスする際に引数は不要です。戻り値は、発見された子ノードの集合を表すDom\NodeListオブジェクト、または子ノードが存在しない場合にnullです。返されたDom\NodeListは、foreachループなどを用いて、各子ノードを個別に処理することができます。例えば、エンティティが「いくつかの単語」というテキストで定義されている場合、childNodesにはその内容を持つテキストノードが一つだけ含まれます。エンティティが複数のXMLタグで構成されている場合は、それらの要素ノードが子ノードのリストとして返されます。このように、childNodesはエンティティ参照の具体的な内容をプログラムから操作する際に役立ちます。

Copy
1<?php
2
3/**
4 * Dom\EntityReference の childNodes プロパティの使用例を示します。
5 *
6 * XMLドキュメント内のエンティティ参照を特定し、
7 * そのエンティティが展開された場合の子ノードリストを取得して表示します。
8 */
9function demonstrateEntityReferenceChildNodes(): void
10{
11    // 内部DTDでエンティティ "&writer;" を定義したXML文字列。
12    // このエンティティは "<b>J. R. R. Tolkien</b>" というマークアップを含みます。
13    $xmlString = <<<XML
14    <?xml version="1.0" encoding="utf-8"?>
15    <!DOCTYPE book [
16      <!ENTITY writer "<b>J. R. R. Tolkien</b>">
17    ]>
18    <book>
19      <title>The Lord of the Rings</title>
20      <author>&writer;</author>
21    </book>
22    XML;
23
24    // DOMDocumentオブジェクトをインスタンス化
25    $doc = new DOMDocument();
26
27    // XML文字列を読み込みます。
28    // デフォルトではエンティティは置換されず、Dom\EntityReferenceノードとして扱われます。
29    $doc->loadXML($xmlString);
30
31    // <author>要素を取得
32    $authorElement = $doc->getElementsByTagName('author')->item(0);
33
34    // <author>要素の子ノードを走査
35    foreach ($authorElement->childNodes as $node) {
36        // ノードがエンティティ参照であるかを確認 (e.g., &writer;)
37        // Dom\EntityReference は nodeType が XML_ENTITY_REFERENCE_NODE となります。
38        if ($node instanceof \Dom\EntityReference) {
39            echo "エンティティ参照ノード (&{$node->nodeName};) を見つけました。\n\n";
40
41            // Dom\EntityReference::childNodes プロパティにアクセスします。
42            // これはエンティティ "&writer;" の中身 (<b>J. R. R. Tolkien</b>) を
43            // 構成するノードのリスト (DOMNodeList) を返します。
44            $entityChildNodes = $node->childNodes;
45
46            echo "エンティティの子ノード一覧:\n";
47            if ($entityChildNodes && $entityChildNodes->length > 0) {
48                // 子ノードリストの内容をループして表示
49                foreach ($entityChildNodes as $child) {
50                    // ここでは <b> ノードが取得されます。
51                    echo "- ノード名: " . $child->nodeName . "\n";
52                    echo "- テキスト内容: " . $child->textContent . "\n";
53                }
54            } else {
55                echo "- 子ノードはありませんでした。\n";
56            }
57        }
58    }
59}
60
61// 関数を実行
62demonstrateEntityReferenceChildNodes();

PHPの Dom\EntityReference::childNodes は、XMLドキュメント内のエンティティ参照が展開された後の中身を、子ノードのリストとして取得するためのプロパティです。このプロパティは引数を取らず、子ノードの集合である Dom\NodeList オブジェクトを返します。子ノードが存在しない場合は、null または空の Dom\NodeList を返すことがあります。

サンプルコードでは、まず内部DTDで &writer; というエンティティを定義したXML文字列を準備しています。このエンティティの中身は <b>J. R. R. Tolkien</b> というマークアップです。次に、このXMLを DOMDocument オブジェクトとして読み込みます。この時点では、<author> タグの中の &writer; は、まだ展開されずに一つのエンティティ参照ノードとして扱われています。

コードは <author> 要素の子ノードを調べ、&writer; というエンティティ参照ノードを特定します。そして、そのノードの childNodes プロパティにアクセスします。これにより、エンティティの中身である <b>J. R. R. Tolkien</b> が解析され、その結果として <b> 要素ノードを含む Dom\NodeList が取得できます。最後に、このリストの内容をループ処理で確認し、含まれるノードの名前やテキスト内容を表示しています。このように、childNodes プロパティは、エンティティ参照の具体的な構造をプログラムで調べる際に役立ちます。