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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * Dom\EntityReference の nextSibling プロパティの使用例を示します。
7 *
8 * この関数は、XMLドキュメント内にいくつかのノードを作成し、
9 * エンティティ参照ノード (&amp;) の直後にある兄弟ノードを取得して、
10 * その内容を表示します。
11 */
12function demonstrateEntityReferenceNextSibling(): void
13{
14    // 1. DOMDocumentオブジェクトを作成します
15    $dom = new DOMDocument('1.0', 'UTF-8');
16    $dom->formatOutput = true; // 出力を見やすく整形する
17
18    // 2. ルート要素を作成してドキュメントに追加します
19    $root = $dom->createElement('content');
20    $dom->appendChild($root);
21
22    // 3. ルート要素に子ノードを追加します
23    // Text -> EntityReference -> Element という順序で追加します
24    $textNode = $dom->createTextNode('This is an ampersand: ');
25    $entityRef = $dom->createEntityReference('amp'); // &amp; を表すエンティティ参照
26    $elementNode = $dom->createElement('tag', 'This is a sibling element.');
27
28    $root->appendChild($textNode);
29    $root->appendChild($entityRef); // ここが今回の主役となるノードです
30    $root->appendChild($elementNode);
31
32    // 4. エンティティ参照ノード (&amp;) の次の兄弟ノードを取得します
33    // $entityRef は Dom\EntityReference オブジェクトです
34    // nextSibling プロパティは、ツリー構造でこのノードの直後にあるノードを返します
35    $sibling = $entityRef->nextSibling;
36
37    // 5. 結果を出力します
38    echo "ドキュメント構造:\n";
39    echo $dom->saveXML();
40    echo "\n----------------------------------------\n";
41    echo "対象ノード: " . $entityRef->nodeName . " (エンティティ参照)\n";
42
43    // nextSibling が存在するかチェックします
44    if ($sibling !== null) {
45        // 取得した兄弟ノードの情報を表示します
46        // この例では、<tag>要素が取得されるはずです
47        echo "nextSibling で取得したノード名: " . $sibling->nodeName . "\n";
48        echo "nextSibling で取得したノードの内容: " . $sibling->textContent . "\n";
49    } else {
50        echo "次の兄弟ノードはありません。\n";
51    }
52}
53
54// 関数を実行して結果を表示します
55demonstrateEntityReferenceNextSibling();
56
57?>

このPHPコードは、XML文書を操作するDom\EntityReferenceクラスのnextSiblingプロパティの使用例を解説するものです。nextSiblingプロパティは、XML文書の階層構造において、あるノードのすぐ隣に続く「次の兄弟ノード」を取得する機能を提供します。このプロパティは引数を取らず、アクセスするだけで値を取得できます。

サンプルコードでは、まず<content>という親要素を作成し、その中に「テキスト」「エンティティ参照 (&)」「<tag>要素」という3種類の子ノードを順番に追加しています。ここで主役となるのは、中央に配置されたエンティティ参照ノードです。このノードのnextSiblingプロパティにアクセスすることで、その直後にある<tag>`要素のオブジェクトを取得しています。

このプロパティの戻り値は、次の兄弟ノードが存在する場合はそのノードオブジェクト (Dom\Node)、存在しない場合（つまり、自身が最後の子ノードである場合）はnullになります。そのため、コードの最後では、取得した値がnullでないことを確認してから、ノード名や内容を出力しています。このようにnextSiblingプロパティを使うことで、特定のノードを基準に、同じ階層にある後続のノードを簡単にたどることができます。