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

Copy
1<?php
2
3// DOMDocument を作成し、XML 文字列を読み込む
4$dom = new DOMDocument();
5$dom->loadXML('<root><child1>value1</child1><child2>value2</child2></root>');
6
7// root 要素を取得
8$root = $dom->documentElement;
9
10// root 要素の子ノードリストを取得
11$childNodes = $root->childNodes;
12
13// 子ノードをループして表示
14foreach ($childNodes as $child) {
15    // ELEMENT_NODE のみ処理する
16    if ($child->nodeType === XML_ELEMENT_NODE) {
17        echo $child->nodeName . ': ' . $child->nodeValue . PHP_EOL;
18    }
19}

このサンプルコードは、PHPのDOM拡張を使って、XMLドキュメントから特定要素の子ノードを取得し、その情報を表示する例を示しています。

まず、DOMDocumentクラスのインスタンスを作成し、loadXML()メソッドを使ってXML文字列を読み込み、DOMドキュメントを構築します。次に、documentElementプロパティを使って、ドキュメントのルート要素を取得します。

childNodesプロパティは、DOMElementクラスに属し、その要素の全ての子ノードを含むDOMNodeListオブジェクトを返します。この例では、ルート要素の子ノードリストを取得しています。childNodesは引数を取りません。

取得したDOMNodeListをforeachループで処理し、各子ノードの情報を表示します。nodeTypeプロパティを使ってノードの種類を確認し、XML_ELEMENT_NODE（要素ノード）の場合のみ、nodeNameプロパティで要素名、nodeValueプロパティで要素の値を取得して表示します。PHP_EOLは改行コードです。

このコードを実行すると、child1: value1とchild2: value2が出力されます。このサンプルは、XMLデータの解析と操作の基本的な流れを理解するのに役立ちます。特に、childNodesプロパティを利用することで、XMLドキュメントの構造をプログラム的に操作し、必要な情報を抽出できます。

Copy
1<?php
2
3/**
4 * DOMElement::childNodes プロパティの使用方法を示すサンプル関数。
5 * この関数は、XMLドキュメントを作成し、特定のDOM要素の直接の子ノードをすべて取得し、
6 * そのタイプと値を出力します。
7 *
8 * システムエンジニアを目指す初心者向けに、DOMツリーの基本構造と、
9 * 要素だけでなくテキストやコメントも子ノードとして扱われることを示します。
10 */
11function demonstrateChildNodes(): void
12{
13    // 1. 新しいDOMDocumentオブジェクトを作成
14    $dom = new DOMDocument('1.0', 'UTF-8');
15    // XMLを整形して出力するための設定（デバッグ時に便利）
16    $dom->formatOutput = true;
17
18    // 2. XML文字列をロード
19    // このXMLには、要素ノード、テキストノード（要素間の改行と空白）、コメントノードが含まれます。
20    // DOMDocumentは、これらの改行や空白も「テキストノード」として認識することに注意してください。
21    $xmlString = <<<XML
22<library>
23    <book id="1">
24        <title>The Great PHP Guide</title>
25        <author>John Doe</author>
26    </book>
27    <!-- このコメントも子ノードとして扱われます -->
28    <book id="2">
29        <title>Mastering DOM</title>
30        <author>Jane Smith</author>
31    </book>
32    ここに直接の子テキストノードの例があります。
33</library>
34XML;
35
36    // XML文字列をDOMDocumentに読み込む
37    $dom->loadXML($xmlString);
38
39    // 読み込んだXMLの全体像を表示
40    echo "--- オリジナルXML ---" . PHP_EOL;
41    echo $dom->saveXML() . PHP_EOL . PHP_EOL;
42
43    // 3. ルート要素（'library'）を取得
44    // DOMDocument::documentElement は、ドキュメントのルート要素を返します。
45    $rootElement = $dom->documentElement;
46
47    if ($rootElement === null) {
48        echo "エラー: ルート要素が見つかりませんでした。" . PHP_EOL;
49        return;
50    }
51
52    echo "--- '{$rootElement->nodeName}' 要素の直接の子ノード一覧 ---" . PHP_EOL;
53
54    // 4. DOMElement::childNodes プロパティにアクセス
55    // このプロパティは、指定された要素のすべての直接の子ノードを DOMNodeList として返します。
56    // DOMNodeListは、要素ノード、テキストノード、コメントノードなど、あらゆるタイプのノードを含みます。
57    $childNodes = $rootElement->childNodes;
58
59    // 5. 取得したDOMNodeListをループし、各子ノードの情報を表示
60    foreach ($childNodes as $node) {
61        echo "  - ";
62        echo "ノード名: " . $node->nodeName;
63        echo ", タイプ: " . $node->nodeType; // DOMNode::ELEMENT_NODE (1), DOMNode::TEXT_NODE (3) などの定数に対応する整数値
64        
65        // ノードのタイプに応じて詳細情報を表示
66        if ($node->nodeType === XML_ELEMENT_NODE) { // 要素ノードの場合 (定数: DOMNode::ELEMENT_NODE)
67            echo " (要素)";
68            echo ", タグ名: " . $node->tagName;
69        } elseif ($node->nodeType === XML_TEXT_NODE) { // テキストノードの場合 (定数: DOMNode::TEXT_NODE)
70            echo " (テキスト)";
71            // テキストノードの値から余分な空白や改行を削除して表示
72            $trimmedValue = trim($node->nodeValue);
73            if ($trimmedValue !== '') {
74                echo ", 値: '" . $trimmedValue . "'";
75            } else {
76                echo ", (空白や改行のみ)"; // XML整形によるノード
77            }
78        } elseif ($node->nodeType === XML_COMMENT_NODE) { // コメントノードの場合 (定数: DOMNode::COMMENT_NODE)
79            echo " (コメント)";
80            echo ", 値: '" . trim($node->nodeValue) . "'";
81        }
82        echo PHP_EOL;
83    }
84}
85
86// 関数を実行して、DOMElement::childNodes の動作を確認
87demonstrateChildNodes();
88
89?>

PHPのDOMElement::childNodesプロパティは、XMLやHTML文書をDOM（Document Object Model）として扱う際に、特定の要素の直下にあるすべての子ノードを取得するために使用されます。このプロパティには引数はなく、アクセスするとDOMNodeListという型のオブジェクトが返されます。

DOMNodeListは、取得した子ノードの集合を表し、要素ノード（タグで囲まれた部分）、テキストノード（要素内の文字列や、要素間の改行・空白）、コメントノードなど、様々なタイプのノードが含まれます。DOMツリーでは、たとえ要素間の改行や空白であっても、独立したテキストノードとして扱われる点に注意が必要です。

サンプルコードでは、まずXML文字列をDOMDocumentオブジェクトに読み込み、XML文書全体のDOMツリーを構築します。その後、ドキュメントのルート要素である<library>要素を取得し、そのchildNodesプロパティにアクセスしています。これにより、<library>の直下にある<book>要素、コメント、さらにXML整形による改行や空白からなるテキストノード、そして直接記述されたテキストノードといった全ての子ノードがDOMNodeListとして取得されます。

取得したDOMNodeListをループ処理することで、各子ノードのノード名、ノードタイプ、そしてその値などの詳細情報を確認できます。このプロパティを使用することで、文書の階層構造を正確にたどり、必要な情報にアクセスしたり、変更したりする操作が可能になります。システムエンジニアを目指す方にとって、DOMツリーの理解と操作は、WebスクレイピングやXMLデータの処理において非常に基本的なスキルとなります。

Copy
1<?php
2
3/**
4 * 指定されたXML文字列から特定の要素をXPathで探し、その子ノードを列挙して表示します。
5 * システムエンジニアを目指す初心者向けに、DOMElement::childNodes の使い方を具体的に示します。
6 *
7 * @param string $xmlString 処理するXMLデータ文字列
8 */
9function processDomChildNodes(string $xmlString): void
10{
11    // DOMDocument オブジェクトを作成し、XMLを操作できるようにします。
12    $dom = new DOMDocument();
13
14    // XMLパース時の警告を抑制し、内部エラーとして処理します。
15    // これにより、エラーメッセージがPHPの標準出力に直接出ることなく、
16    // 必要に応じてエラー情報を取得できるようになります。（今回は簡略化）
17    libxml_use_internal_errors(true);
18
19    // XML文字列をDOMDocumentにロードします。
20    if (!$dom->loadXML($xmlString)) {
21        echo "エラー: XMLのロードに失敗しました。\n";
22        libxml_clear_errors(); // 内部に保存されたエラー情報をクリアします。
23        return;
24    }
25    libxml_clear_errors(); // XMLが正常にロードされた場合も、念のためエラーをクリアします。
26
27    // DOMXPath オブジェクトを作成し、XPathクエリを実行できるようにします。
28    $xpath = new DOMXPath($dom);
29
30    // XPathクエリを使用して、idが"targetParent"の<parent>要素を探します。
31    // XPathはXMLツリーから特定のノードを選択するための強力な言語です。
32    // このクエリは、マッチしたノードのリスト (DOMNodeList) を返します。
33    $targetElements = $xpath->query('//parent[@id="targetParent"]');
34
35    // 目的の要素が見つからなかった場合の処理です。
36    if ($targetElements->count() === 0) {
37        echo "エラー: 指定されたIDを持つ親要素が見つかりませんでした。\n";
38        return;
39    }
40
41    // XPathクエリで最初にマッチした要素 (DOMElement) を取得します。
42    // DOMNodeList::item(0) はリストの最初のノードを返します。
43    /** @var DOMElement $parentElement ここで取得されるのはDOMElement型であることが保証されます */
44    $parentElement = $targetElements->item(0);
45
46    echo "--- 親要素 '{$parentElement->tagName}' (id: {$parentElement->getAttribute('id')}) の子ノード一覧 ---\n";
47
48    // DOMElement::childNodes プロパティにアクセスし、すべての子ノードのリストを取得します。
49    // このプロパティは、要素ノードだけでなく、テキストノードやコメントノードなども含みます。
50    // 戻り値は DOMNodeList オブジェクトです。
51    $childNodes = $parentElement->childNodes;
52
53    // 子ノードが存在しない場合の処理です。
54    if ($childNodes->count() === 0) {
55        echo "子ノードはありません。\n";
56        return;
57    }
58
59    echo "合計 " . $childNodes->count() . " 個の子ノードが見つかりました。\n";
60    echo "各子ノードの詳細:\n";
61
62    // DOMNodeList をループ処理し、各子ノードの情報を表示します。
63    /** @var DOMNode $childNode DOMNodeList は DOMNode のコレクションです */
64    foreach ($childNodes as $childNode) {
65        echo "  - ノードタイプ: ";
66        switch ($childNode->nodeType) {
67            case DOMNode::ELEMENT_NODE: // 要素ノード (<tag/> のようなもの)
68                echo "要素 (タグ名: <{$childNode->tagName}>)\n";
69                break;
70            case DOMNode::TEXT_NODE:    // テキストノード ("Hello" のようなテキスト)
71                $trimmedText = trim($childNode->nodeValue);
72                if ($trimmedText !== '') {
73                    echo "テキスト (値: '{$trimmedText}')\n";
74                } else {
75                    echo "テキスト (空白のみ)\n"; // 要素間の改行などもテキストノードとして扱われます。
76                }
77                break;
78            case DOMNode::COMMENT_NODE: // コメントノード (<!-- comment -->)
79                echo "コメント (内容: '{$childNode->nodeValue}')\n";
80                break;
81            // 他にもDOMNode::CDATA_SECTION_NODEなど様々なノードタイプが存在しますが、
82            // ここでは主要なものに限定しています。
83            default:
84                echo "不明なタイプ (ノード名: {$childNode->nodeName}, 値: '{$childNode->nodeValue}')\n";
85                break;
86        }
87    }
88}
89
90// サンプルとして使用するXMLデータです。
91// <parent id="targetParent"> 要素は、複数の種類の子ノードを含んでいます。
92$sampleXml = <<<XML
93<?xml version="1.0" encoding="UTF-8"?>
94<root>
95    <header>これはヘッダーです</header>
96    <parent id="targetParent">
97        <child1>子要素A</child1>
98        これは親要素直下のテキストノードです。
99        <child2 active="true">子要素B</child2>
100        <!-- これはコメントノードです -->
101        <child3/>
102    </parent>
103    <footer/>
104</root>
105XML;
106
107// 上記で定義した関数を実行し、結果を表示します。
108processDomChildNodes($sampleXml);

PHPのDOMElement::childNodesプロパティは、XMLやHTMLドキュメントの操作において、特定の要素直下にあるすべての子ノードを取得するために使用されます。このプロパティに引数はなく、該当する子ノードのリストをDOMNodeListオブジェクトとして返します。

サンプルコードでは、まず与えられたXML文字列をDOMDocumentにロードし、DOMXPathを使ってid="targetParent"を持つ<parent>要素を検索しています。目的の<parent>要素が見つかると、そのDOMElementオブジェクトに対してchildNodesプロパティにアクセスします。これにより、<parent>要素の直下にある<child1>や<child2>のような要素ノード、要素間の改行やスペース、これは親要素直下のテキストノードです。のようなテキストノード、さらにはコメントノードなど、あらゆる種類の子ノードがDOMNodeListとして取得されます。

取得したDOMNodeListはループ処理が可能で、各子ノードのタイプ（要素、テキスト、コメントなど）を判別し、その内容を表示しています。このようにchildNodesを利用することで、XMLの階層構造を詳細に調べ、特定の要素にどのような子要素やテキストが含まれているかを正確に把握することができます。これはXMLデータの解析や変換を行う際に非常に強力なツールとなります。