Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

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

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

作成日: 更新日:

基本的な使い方

childNodesプロパティは、DOMTextクラスに属し、ノードの子ノードのリストを保持するプロパティです。

PHPのDOM拡張機能において、DOMTextクラスは、HTMLやXMLドキュメント内でテキストデータそのものを表すノードです。例えば、<p>これはテキストです</p>というHTML要素がある場合、「これはテキストです」という部分がDOMTextノードとして扱われます。

一般的に、DOMツリー内のノードは、その下位にさらに他のノード(子ノード)を持つことがあります。これらの子ノードの集合は、childNodesプロパティを通じてDOMNodeListという形式で取得されます。DOMNodeListは、リストのように子ノードをまとめて扱い、個々のノードにアクセスするためのオブジェクトです。

しかし、DOMTextノードは「テキスト内容」そのものを表現するノードであり、他の要素ノードのように、さらにその内部に子ノードを持つことはできません。テキストノードはDOMツリーにおける最終的なデータ部分であり、それ以上細分化される構造ではないためです。

したがって、DOMTextオブジェクトからこのchildNodesプロパティにアクセスすると、常に子ノードが一つも含まれていない空のDOMNodeListオブジェクトが返されます。この挙動は、DOMTextノードが子ノードを持たないというDOMの構造的な特性を反映したものです。テキストノードの内容自体を取得したい場合は、nodeValueプロパティなどを使用するのが適切です。

構文(syntax)

1<?php
2$dom = new DOMDocument();
3$element = $dom->createElement('p', 'これはテキストノードです。');
4$dom->appendChild($element);
5
6// DOMElementの子ノードであるDOMTextノードを取得
7$textNode = $element->firstChild; // $textNode は DOMText のインスタンス
8
9// DOMTextノードのchildNodesプロパティにアクセス
10$childrenOfTextNode = $textNode->childNodes;
11
12// DOMTextノードは子ノードを持たないため、childNodesは常に空のDOMNodeListを返します
13// そのため、$childrenOfTextNode->length は常に 0 となります
14echo "DOMTextノードの子ノードの数: " . $childrenOfTextNode->length . "\n";
15?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

DOMNodeList

DOMTextオブジェクトの直下の子ノードのリストをDOMNodeListクラスのインスタンスとして返します。

サンプルコード

PHP DOM childNodes プロパティの利用

1<?php
2
3// DOMText オブジェクトの childNodes プロパティの利用例
4
5// ドキュメントを新規に作成
6$dom = new DOMDocument();
7
8// ルート要素を作成
9$root = $dom->createElement('root');
10$dom->appendChild($root);
11
12// テキストノードを作成
13$textNode = $dom->createTextNode('Hello, world!');
14
15// ルート要素にテキストノードを追加
16$root->appendChild($textNode);
17
18// テキストノードの childNodes プロパティを取得
19$childNodes = $textNode->childNodes;
20
21// childNodes は常に空の DOMNodeList を返す (テキストノードは子ノードを持たないため)
22echo "childNodes count: " . $childNodes->length . PHP_EOL;

このサンプルコードは、PHPのDOM拡張機能におけるDOMTextクラスのchildNodesプロパティの利用方法を示しています。DOMTextオブジェクトはテキストノードを表し、このテキストノードが持つ子ノードをDOMNodeListとして取得するためにchildNodesプロパティを使用します。

まず、DOMDocumentクラスを使って新しいXMLドキュメントを作成し、ルート要素を追加します。次に、createTextNode()メソッドを使用してテキストノードを作成し、それをルート要素の子ノードとして追加しています。

ここで重要なのは、DOMTextオブジェクト(テキストノード)は、それ自体がテキストデータを持つため、原則として子ノードを持ちません。そのため、$textNode->childNodesで取得できるDOMNodeListは常に空になります。

サンプルコードでは、$textNode->childNodesの結果を$childNodes変数に格納し、$childNodes->lengthプロパティを使って、取得したDOMNodeListに含まれるノードの数を表示しています。出力結果は「childNodes count: 0」となり、テキストノードが子ノードを持たないことを確認できます。

このように、childNodesプロパティは、ノードが持つ子ノードのリストを取得するために使用されますが、DOMTextオブジェクトの場合は常に空のリストが返される点に注意が必要です。この特性を理解することで、DOMを操作する際に予期せぬ動作を防ぐことができます。

DOMTextオブジェクトのchildNodesプロパティは、テキストノードの子ノードリストを取得するものですが、テキストノード自体は子ノードを持つことができません。そのため、$textNode->childNodesは常に空のDOMNodeListを返します。この点に注意してください。テキストノードの内容(テキストデータ)を取得したい場合は、nodeValueプロパティを使用します。childNodesプロパティは、主に要素ノード(DOMElementなど)の子ノードを取得する際に利用されます。誤ってテキストノードで使用しないように注意が必要です。

PHP DOMText childNodes を調べる

1<?php
2
3/**
4 * DOMTextノードのchildNodesプロパティの動作を示すサンプルコードです。
5 * DOMTextノードはテキストコンテンツを表し、それ自体は子ノードを持つことができません。
6 * したがって、DOMText::childNodesプロパティは常に空のDOMNodeListを返します。
7 */
8function demonstrateDomTextChildNodes(): void
9{
10    // 新しいDOMDocumentインスタンスを作成
11    $dom = new DOMDocument('1.0', 'UTF-8');
12
13    // HTMLコンテンツをロード
14    // libxml_use_internal_errorsを設定して、HTML解析エラーが出力されないようにします
15    libxml_use_internal_errors(true);
16    $dom->loadHTML('<!DOCTYPE html><html><body><p>これは<b>サンプル</b>テキストです。</p></body></html>');
17    libxml_clear_errors(); // エラーフラグをクリア
18
19    echo "--- DOMText::childNodesのデモンストレーション ---\n\n";
20
21    // <p>要素を取得
22    $pElements = $dom->getElementsByTagName('p');
23
24    if ($pElements->length > 0) {
25        $p = $pElements->item(0); // 最初の<p>要素を取得
26        echo "親要素: <p>\n";
27        echo "  コンテンツ: " . $p->textContent . "\n\n";
28
29        // <p>要素の子ノードをループして、DOMTextノードを探します
30        echo "  <p>要素の子ノードを探索中...\n";
31        foreach ($p->childNodes as $node) {
32            // ノードがDOMTextインスタンスであるかを確認
33            if ($node instanceof DOMText) {
34                echo "  DOMTextノードが見つかりました。\n";
35                echo "    ノードの値: '" . $node->nodeValue . "'\n";
36
37                // DOMTextノードのchildNodesプロパティにアクセス
38                $childNodesOfText = $node->childNodes;
39
40                // DOMTextノードは子ノードを持てないため、childNodesプロパティは常に空のDOMNodeListを返します
41                echo "    DOMTextノードのchildNodesの数: " . $childNodesOfText->length . " (常に0が期待されます)\n\n";
42            } elseif ($node instanceof DOMElement) {
43                echo "  DOMElementノードが見つかりました: <" . $node->tagName . ">\n";
44                // DOMElementノードの場合は子ノードを持つことができますが、ここではDOMTextに焦点を当てます
45                // echo "    DOMElementノードの子ノードの数: " . $node->childNodes->length . "\n\n";
46            }
47        }
48    } else {
49        echo "HTMLコンテンツ内に<p>要素が見つかりませんでした。\n";
50    }
51
52    echo "--- デモンストレーション終了 ---\n";
53}
54
55// 関数を実行してデモンストレーションを開始
56demonstrateDomTextChildNodes();
57

PHPのDOMText::childNodesプロパティは、HTMLやXML文書の構造を扱うDOM(Document Object Model)拡張機能の一部です。このプロパティは、DOMTextクラスに属しており、特定のテキストノードが持つ子ノードのリストを取得するために使用されます。DOMTextノードは、要素の内部にある純粋なテキストコンテンツ(例えば、<p>これは<b>サンプル</b>テキストです。</p>における「これは」や「テキストです。」の部分)を表します。テキストノードは、それ自体がさらに子ノードを持つことはできません。

そのため、DOMText::childNodesプロパティにアクセスすると、引数は不要で、常に空のDOMNodeListオブジェクトが戻り値として返されます。このDOMNodeListには、子ノードが一つも含まれていないため、そのlengthプロパティは常に0となります。サンプルコードでは、HTMLドキュメントからDOMTextノードを抽出し、そのchildNodesプロパティが実際に空のリストを返すことを確認しています。この挙動は、DOMツリー構造におけるテキストノードの役割を理解する上で重要です。

DOMTextノードのchildNodesプロパティは、常に空のDOMNodeListを返す点にご注意ください。これは、DOMTextノードがHTML要素のような構造を持たず、純粋なテキストコンテンツを表すためです。初心者の方は、子要素を持つDOMElementノードのchildNodesプロパティと混同しやすいですが、DOMTextノード自体は子ノードを持つことはできません。したがって、DOMTextノードから子ノードを期待してループ処理などを行うと、常に何も処理されません。DOMTextノードの実際のテキスト内容を取得するには、nodeValueプロパティを使用します。この違いを理解し、適切に使い分けることが重要です。

PHP DOMText::childNodes 動作確認

1<?php
2
3/**
4 * DOMTextノードのchildNodesプロパティの動作をデモンストレーションします。
5 *
6 * DOMTextノードはHTML/XMLドキュメント内の純粋なテキストデータ自体を表します。
7 * そのため、構造的な子ノード(例えば、他の要素タグなど)を持つことはありません。
8 * この関数では、XPathを使って特定のテキストノードを選択し、その childNodes プロパティが
9 * 常に空の DOMNodeList を返すことを示します。
10 */
11function demonstrateDomTextChildNodesUsage(): void
12{
13    // HTMLドキュメントの準備
14    // ここでは、テキストと要素が混在するシンプルなHTMLを使用
15    $html = '<div id="container">これは <span>サンプル</span> のテキストです。</div>';
16    $dom = new DOMDocument();
17
18    // HTMLを読み込みます。
19    // LIBXML_HTML_NOIMPLIED と LIBXML_HTML_NODEFDTD は、
20    // DOMDocumentが自動的に<html>や<body>タグを追加したり、DOCTYPEを宣言したりするのを抑制し、
21    // より正確なDOMツリーを構築するのに役立ちます。
22    // エラーが発生しても処理を続行するために @ を使用していますが、
23    // 実際のアプリケーションでは適切なエラーハンドリングを行うべきです。
24    @$dom->loadHTML($html, LIBXML_HTML_NOIMPLIED | LIBXML_HTML_NODEFDTD);
25
26    // XPathオブジェクトを作成し、DOMドキュメントを紐付けます。
27    // XPathを使用することで、複雑な条件でノードを効率的に検索できます。
28    $xpath = new DOMXPath($dom);
29
30    // XPathクエリを使用して、特定のテキストノードを選択します。
31    // "//div[@id='container']/text()[1]" は、idが"container"の<div>要素の
32    // 最初のテキスト子ノード("これは ")を選択します。
33    $query = "//div[@id='container']/text()[1]";
34    $nodes = $xpath->query($query);
35
36    // 検索結果のノードが存在するか確認します。
37    if ($nodes->length > 0) {
38        $textNode = $nodes->item(0);
39
40        // 取得したノードがDOMTextのインスタンスであることを確認します。
41        // DOMTextクラスは、ノードがテキストデータであることを示します。
42        if ($textNode instanceof DOMText) {
43            echo "--- DOMTextノード情報 ---\n";
44            echo "XPathクエリ: " . $query . "\n";
45            echo "ノードの内容 (nodeValue): '" . $textNode->nodeValue . "'\n";
46            echo "ノードの型 (nodeName): " . $textNode->nodeName . " (DOMText)\n";
47
48            // DOMText::childNodes プロパティにアクセスします。
49            // DOMTextノードはテキストデータそのものであり、自身の中に他のノードを含むことはないため、
50            // このプロパティは常に空のDOMNodeListを返します。
51            $children = $textNode->childNodes;
52
53            echo "DOMTextノードの子ノード数 (childNodes): " . $children->length . "\n";
54
55            if ($children->length === 0) {
56                echo "説明: DOMTextノードは構造的な子ノードを持たず、自身の値がテキストデータです。そのため、childNodesプロパティは常に空のDOMNodeListを返します。\n";
57            }
58        } else {
59            echo "警告: XPathクエリ ('" . $query . "') で選択されたノードはDOMTextインスタンスではありませんでした。\n";
60        }
61    } else {
62        echo "エラー: 指定されたXPath ('" . $query . "') に一致するテキストノードが見つかりませんでした。\n";
63    }
64}
65
66// 関数を実行して、DOMText::childNodes の動作を確認します。
67demonstrateDomTextChildNodesUsage();

PHP 8のDOMText::childNodesプロパティは、HTMLやXMLドキュメント内で純粋なテキストデータ(文字列)を表すDOMTextクラスのインスタンスが持つプロパティです。このプロパティは引数を取りません。通常、childNodesプロパティは、そのノードが持つすべての子ノードのリストをDOMNodeListオブジェクトとして返しますが、DOMTextノードは要素のような構造的な子ノードを持つことはありません。そのため、DOMTextインスタンスからchildNodesプロパティにアクセスすると、常に子ノードを一つも含まない空のDOMNodeListが戻り値として返されます。

サンプルコードでは、まずシンプルなHTMLをDOMDocumentで読み込み、DOMXPathを使って特定のテキストノードを検索しています。具体的には、id="container"を持つdiv要素内の最初のテキスト部分("これは ")を選択しています。選択されたノードがDOMTextのインスタンスであることを確認した後、そのchildNodesプロパティにアクセスし、子ノードの数が0であることを表示しています。これにより、DOMTextノードが構造的な子ノードを持たないという特性と、それに伴いchildNodesプロパティが常に空のDOMNodeListを返すという挙動を、システムエンジニアを目指す初心者が理解できるようデモンストレーションしています。

DOMTextノードはHTML/XMLドキュメント内の純粋なテキスト部分を指し、他の要素ノードのように構造的な子ノードを持つことはありません。そのため、DOMText::childNodesプロパティは常に空のDOMNodeListを返すことを理解してください。この点を誤解すると、テキストノードから子要素が取得できないと勘違いする可能性があります。

サンプルコード中の@$dom->loadHTMLのようにエラーを抑制する記述は、本番環境では避けるべきです。問題発生時に適切なエラーハンドリングを行い、原因を特定できるコードを記述することが重要です。XPathはDOMツリーから特定のノードを効率的に検索する強力なツールです。基本的なクエリを習得すると、より柔軟なデータ抽出が可能になります。

関連コンテンツ

関連プログラミング言語