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

childNodesプロパティの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

childNodesプロパティは、DOMDocumentクラスに属する、ドキュメントの直接の子ノードを保持するプロパティです。具体的には、DOMNodeListオブジェクトとして提供されます。DOMNodeListは、ノードの順番付きのリストであり、インデックスを使用して各ノードにアクセスできます。

このプロパティを使用することで、DOMドキュメントのルート要素(通常は<html>タグ)や、ドキュメントタイプ宣言(<!DOCTYPE>)などの子ノードをプログラムから操作することが可能になります。例えば、ドキュメントの構造を解析したり、新しいノードを挿入する場所を特定したりする際に役立ちます。

childNodesプロパティが返すDOMNodeListは、ライブリストであることに注意が必要です。つまり、DOMツリーが変更されると、DOMNodeListの内容も自動的に更新されます。したがって、DOMNodeListを反復処理中にノードを追加または削除すると、予期しない動作が発生する可能性があります。このような場合は、事前にノードリストを配列にコピーしてから処理を行うなどの対策が必要です。

DOMDocumentのchildNodesプロパティを通じて取得できるノードの種類には、DOMElement(要素ノード)、DOMText(テキストノード)、DOMComment(コメントノード)などがあります。ただし、属性ノードは含まれません。属性は要素ノードのプロパティとしてアクセスされます。

システムエンジニアを目指す上で、DOMDocumentのchildNodesプロパティは、XMLやHTMLドキュメントをPHPで操作する際の基礎となる重要な概念です。このプロパティを理解し、効果的に活用することで、Webアプリケーション開発におけるデータ処理や動的なコンテンツ生成をより柔軟に行うことができるようになります。

構文(syntax)

1DOMDocument::$childNodes;

引数(parameters)

引数なし

引数はありません

戻り値(return)

DOMNodeList

DOMDocument オブジェクトの直下にある子ノードのリストを DOMNodeList オブジェクトとして返します。

サンプルコード

PHP DOM childNodesで子ノードを取得する

1<?php
2
3// DOMDocument を作成
4$dom = new DOMDocument();
5
6// XML 文字列をロード
7$dom->loadXML('<root><child1>value1</child1><child2>value2</child2></root>');
8
9// childNodes プロパティを使用して、ルート要素の子ノードリストを取得
10$childNodes = $dom->documentElement->childNodes;
11
12// 子ノードをループして出力
13foreach ($childNodes as $childNode) {
14    // テキストノード以外を出力
15    if ($childNode->nodeType != XML_TEXT_NODE) {
16        echo $childNode->nodeName . PHP_EOL;
17    }
18}
19
20?>

PHP 8 における DOMDocument クラスの childNodes プロパティについて解説します。このプロパティは、特定のノード(この例ではドキュメントのルート要素)が持つ子ノードのリストを取得するために使用されます。

サンプルコードでは、まず DOMDocument オブジェクトを生成し、loadXML() メソッドを使ってXML文字列を読み込んでいます。次に、documentElement プロパティでドキュメントのルート要素にアクセスし、その childNodes プロパティにアクセスします。

childNodes プロパティは DOMNodeList オブジェクトを返します。このオブジェクトは、ルート要素直下のすべての子ノード(要素ノード、テキストノードなど)を含むリストです。

サンプルコードでは、取得した子ノードリストを foreach ループで処理し、各子ノードの nodeName プロパティを出力しています。ただし、nodeType プロパティが XML_TEXT_NODE でない場合のみ出力することで、テキストノード(空白や改行など)を除外しています。これにより、XML構造を構成する要素名のみを表示できます。

childNodes プロパティを使用することで、XMLドキュメント内の特定要素の子要素を簡単に取得し、操作することが可能になります。DOMNodeList はイテレータブルなオブジェクトなので、foreach ループなどで容易にアクセスできます。

childNodes は DOMElement の子ノード全てを含む DOMNodeList を返します。テキストノード(空白や改行など)も含まれるため、不要なノードを処理しないように nodeType で種類を判別する必要があります。サンプルコードでは XML_TEXT_NODE 以外のノードを出力しています。documentElementnull でないことを確認してから childNodes にアクセスしてください。また、DOMNodeList はライブリストであるため、リストをループ中にノードを追加・削除すると予期せぬ結果になることがあります。必要に応じて、事前に配列にコピーしてから処理することを検討してください。

関連コンテンツ

関連プログラミング言語

【PHP8.x】childNodesプロパティの使い方 | いっしー@Webエンジニア