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

Copy
1<?php
2
3// DOMDocumentFragment を作成
4$doc = new DOMDocument();
5$fragment = $doc->createDocumentFragment();
6
7// フラグメントに子ノードを追加
8$fragment->appendXML('<p>This is a paragraph.</p><p>Another paragraph.</p>');
9
10// childNodes プロパティを使用して子ノードのリストを取得
11$childNodes = $fragment->childNodes;
12
13// 子ノードをループして情報を表示
14if ($childNodes !== null) {
15    foreach ($childNodes as $node) {
16        echo $node->nodeName . PHP_EOL;
17    }
18}
19?>

PHPのDOMDocumentFragmentクラスにおけるchildNodesプロパティについて解説します。このプロパティは、DOMDocumentFragmentノードが持つ子ノードのリストを取得するために使用します。DOMDocumentFragmentは、軽量なドキュメントの一部を表現するために利用され、XMLドキュメントの一部を構築する際に便利です。

サンプルコードでは、まずDOMDocumentFragmentオブジェクトをnew DOMDocument()とcreateDocumentFragment()を用いて作成しています。次に、appendXML()メソッドを使って、<p>タグで囲まれた2つの段落をフラグメントに追加しています。

$childNodes = $fragment->childNodes; の部分が、childNodesプロパティを使用している箇所です。このプロパティにアクセスすることで、フラグメントが持つ子ノードのリストがDOMNodeListオブジェクトとして返されます。引数は不要で、常にフラグメントの子ノードをリストとして返します。

取得したDOMNodeListは、foreachループで反復処理できます。ループ内では、各ノードのnodeNameプロパティにアクセスしてノード名（この例では"p"）を出力しています。PHP_EOLは改行コードを意味します。childNodesプロパティを使うことで、DOMDocumentFragmentが持つ子ノードを簡単に操作できるようになります。DOMDocumentFragmentが空の場合、$childNodesは空のDOMNodeListを返します。

Copy
1<?php
2
3/**
4 * DOMDocumentFragment の childNodes プロパティの使用例
5 *
6 * このスクリプトは、DOMDocumentFragment を作成し、そこに複数の要素を追加した後、
7 * childNodes プロパティを使って子ノードを走査する方法を示します。
8 * DOMDocumentFragment は、複数のノードを一時的にまとめるためのコンテナとして機能します。
9 */
10
11// DOMDocument インスタンスを作成します。
12// DOMDocumentFragment は、通常 DOMDocument のコンテキストで作成されます。
13$dom = new DOMDocument('1.0', 'UTF-8');
14
15// DOMDocumentFragment を作成します。
16// これは、複数のノードを格納できる軽量なコンテナです。
17$fragment = $dom->createDocumentFragment();
18
19// Fragment に子ノードを追加します。
20// appendChild メソッドを使って、DOMElement インスタンスを fragment に追加します。
21$paragraph1 = $dom->createElement('p', 'これは最初の段落です。');
22$fragment->appendChild($paragraph1);
23
24$divElement = $dom->createElement('div');
25$spanElement = $dom->createElement('span', 'これはDIV内のスパンです。');
26$divElement->appendChild($spanElement); // span を div の子として追加
27$fragment->appendChild($divElement);   // div を fragment の子として追加
28
29$paragraph2 = $dom->createElement('p', 'これは2番目の段落です。');
30$fragment->appendChild($paragraph2);
31
32// DOMDocumentFragment の childNodes プロパティを使用して、子ノードのリスト (DOMNodeList) を取得します。
33// childNodes は、fragment の直下の子ノードをすべて含みます。
34$childNodes = $fragment->childNodes;
35
36echo "DOMDocumentFragment の子ノードを走査します:\n";
37
38// DOMNodeList は反復可能 (Traversable) なオブジェクトなので、foreach ループで各子ノードにアクセスできます。
39foreach ($childNodes as $node) {
40    // ノードが要素ノード (例: <p>, <div>) であるかを確認します。
41    if ($node->nodeType === XML_ELEMENT_NODE) {
42        echo "- 要素名: " . $node->nodeName . ", 内容: \"" . $node->textContent . "\"\n";
43    }
44    // 他のノードタイプ（テキストノードなど）は、この例では表示を省略します。
45    // 必要であれば、XML_TEXT_NODE などで判定し、処理を追加できます。
46}
47

PHPのDOMDocumentFragmentクラスが持つchildNodesプロパティは、HTMLやXML文書の構造を操作する際に、一時的に複数のノードをまとめるコンテナとして機能するDOMDocumentFragmentオブジェクトに直接含まれる子ノードのリストを取得するために使用されます。

このプロパティは引数を必要とせず、呼び出すだけで直下の子ノードすべてをまとめたDOMNodeListオブジェクトが戻り値として得られます。DOMNodeListは、取得した子ノードを順番に処理するためのリストであり、foreachループを用いて各ノードにアクセスできます。

サンプルコードでは、まずDOMDocumentFragmentを作成し、そこに「これは最初の段落です。」という内容のp要素や、span要素を含むdiv要素など、複数のHTML要素を追加しています。追加されたこれらの要素は、DOMDocumentFragmentの直下の子ノードとなります。次に、$fragment->childNodesを使用することで、このDOMDocumentFragmentが持つ子ノードのリスト（DOMNodeList）を取得します。取得したDOMNodeListは、foreachループで子ノードを一つずつ走査し、各ノードが要素であるかを判定した上で、その要素名とテキスト内容を表示しています。これにより、DOMDocumentFragment内にどのような要素が格納されているかを簡単に確認し、操作することができます。このようにchildNodesプロパティは、複数のノードを効率的に扱い、DOMツリーの構築や操作を行う上で非常に役立つ基本的な機能です。