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

Copy
1<?php
2
3/**
4 * DOMCharacterDataクラスのchildNodesプロパティの動作を示すサンプルコードです。
5 *
6 * DOMCharacterDataは、DOMTextやDOMCommentのような文字データを含むノードの基底クラスです。
7 * これらのノードはDOMツリーにおける「葉」ノードであり、通常、それ自体は子ノードを持ちません。
8 * そのため、childNodesプロパティは常に空のDOMNodeListを返します。
9 */
10function demonstrateDomCharacterDataChildNodes(): void
11{
12    // DOMDocumentを作成します。これはDOMツリーのルートとなるオブジェクトです。
13    $dom = new DOMDocument('1.0', 'UTF-8');
14
15    // DOMCharacterDataのサブクラスであるDOMTextノードを作成します。
16    // テキストノードは文字データのみを持ち、子ノードは持ちません。
17    $textNode = $dom->createTextNode('これはテキストデータです。');
18
19    echo "--- DOMText ノードの childNodes プロパティ ---" . PHP_EOL;
20    // DOMTextノードの子ノードリストを取得します。
21    // DOMCharacterData::childNodes は DOMNodeList または null を返します。
22    $textChildNodes = $textNode->childNodes;
23
24    // 戻り値がDOMNodeListのインスタンスであるかを確認します。
25    if ($textChildNodes instanceof DOMNodeList) {
26        echo "  戻り値の型: DOMNodeList" . PHP_EOL;
27        echo "  子ノードの数: " . $textChildNodes->length . PHP_EOL;
28        if ($textChildNodes->length === 0) {
29            echo "  DOMTextノードは子ノードを持たないため、結果は空のリストです。" . PHP_EOL;
30        }
31    } elseif ($textChildNodes === null) {
32        // リファレンスには null の可能性も示されていますが、通常は発生しません。
33        echo "  戻り値の型: null (まれなケース)" . PHP_EOL;
34    } else {
35        echo "  予期しない戻り値の型です。" . PHP_EOL;
36    }
37    echo PHP_EOL;
38
39    // DOMCharacterDataの別のサブクラスであるDOMCommentノードでも確認します。
40    // コメントノードも文字データのみを持ち、子ノードは持ちません。
41    $commentNode = $dom->createComment('これはコメントデータです。');
42
43    echo "--- DOMComment ノードの childNodes プロパティ ---" . PHP_EOL;
44    // DOMCommentノードの子ノードリストを取得します。
45    $commentChildNodes = $commentNode->childNodes;
46
47    // 戻り値がDOMNodeListのインスタンスであるかを確認します。
48    if ($commentChildNodes instanceof DOMNodeList) {
49        echo "  戻り値の型: DOMNodeList" . PHP_EOL;
50        echo "  子ノードの数: " . $commentChildNodes->length . PHP_EOL;
51        if ($commentChildNodes->length === 0) {
52            echo "  DOMCommentノードは子ノードを持たないため、結果は空のリストです。" . PHP_EOL;
53        }
54    } elseif ($commentChildNodes === null) {
55        echo "  戻り値の型: null (まれなケース)" . PHP_EOL;
56    } else {
57        echo "  予期しない戻り値の型です。" . PHP_EOL;
58    }
59}
60
61// 関数を実行して、DOMCharacterDataのchildNodesプロパティの動作を確認します。
62demonstrateDomCharacterDataChildNodes();
63

PHPのDOM拡張機能において、DOMCharacterDataクラスは、XMLやHTMLドキュメント内で純粋な文字データ（テキストやコメントなど）を表現するノードの基底クラスです。このクラスは、DOMTextやDOMCommentといった、具体的な文字データを持つノードの共通の親となります。

childNodesプロパティは、あるノードが持つ直接の子ノードのリストを取得するために使用されます。このプロパティは引数を取らず、戻り値としてDOMNodeListまたはまれにnullを返します。通常、DOMNodeListは子ノードの集合であり、そのlengthプロパティで子ノードの数を取得できます。

しかし、DOMCharacterDataを継承するノードは、それ自体が子ノードを持つことができない「葉」ノードの性質を持っています。そのため、DOMTextやDOMCommentノードに対してchildNodesプロパティにアクセスすると、常に子ノードが一つも含まれていない、空のDOMNodeListが返されます。これにより、これらのノードが構造的な子要素を持たないことが明確に示されます。例えば、サンプルコードではDOMTextノードとDOMCommentノードの両方で、childNodesプロパティがlengthが0のDOMNodeListを返すことを確認しています。

Copy
1<?php
2
3/**
4 * DOMCharacterData (特に DOMText) クラスの子ノードプロパティの挙動を示す関数。
5 * DOMCharacterDataを継承するノードは子ノードを持たないため、
6 * childNodesプロパティは常に空のDOMNodeListを返します。
7 */
8function demonstrateDomCharacterDataChildNodes(): void
9{
10    // サンプルHTML文字列を準備
11    $html = '<p>これはテキストノードの<b>一部</b>です。</p>';
12
13    // DOMDocumentオブジェクトを作成し、HTMLをロード
14    $dom = new DOMDocument();
15    // HTMLをロードします。HTMLの構文エラーに関する警告を抑制します。
16    @$dom->loadHTML($html);
17
18    // DOMXPathオブジェクトを作成し、DOMDocumentを関連付け
19    // XPathはXML/HTMLドキュメントから特定のノードを選択するための言語です。
20    $xpath = new DOMXPath($dom);
21
22    // XPathクエリを使用して、最初の<p>タグ内のテキストノードを選択します。
23    // text() はテキストノードを選択するXPath関数です。
24    // このテキストノードはDOMTextクラスのインスタンスであり、DOMCharacterDataを継承しています。
25    $xpathQuery = '//p/text()';
26    $nodes = $xpath->query($xpathQuery);
27
28    // クエリ結果が空の場合のエラーハンドリング
29    if ($nodes->length === 0) {
30        echo "エラー: XPathクエリ '{$xpathQuery}' に一致するテキストノードが見つかりませんでした。\n";
31        return;
32    }
33
34    // 最初のマッチしたテキストノードを取得
35    // DOMTextはDOMCharacterDataを継承しているため、DOMCharacterDataとして扱えます。
36    /** @var DOMText $textNode */
37    $textNode = $nodes->item(0);
38
39    echo "XPathクエリ '{$xpathQuery}' で見つかったノードの情報:\n";
40    echo "  ノード名: " . $textNode->nodeName . "\n"; // 例: #text
41    echo "  ノードタイプ: " . $textNode->nodeType . " (TEXT_NODE)\n";
42    echo "  ノード値: '" . $textNode->nodeValue . "'\n";
43    echo "  ----------------------------------------\n";
44
45    // DOMCharacterDataを継承するノード（DOMTextなど）は、それ自体の子ノードを持ちません。
46    // そのため、childNodesプロパティは常に空のDOMNodeListを返します。
47    $childNodes = $textNode->childNodes;
48
49    echo "DOMCharacterDataノード（DOMText）の子ノード数: " . $childNodes->length . "\n";
50
51    if ($childNodes->length === 0) {
52        echo "  (DOMCharacterDataを継承するノードは、その性質上、子ノードを持ちません。)\n";
53    } else {
54        // このブロックは通常実行されません。
55        echo "  予期せぬ子ノードが検出されました。\n";
56        foreach ($childNodes as $index => $childNode) {
57            echo "    子ノード #" . ($index + 1) . ": " . $childNode->nodeName . "\n";
58        }
59    }
60    echo "----------------------------------------\n";
61}
62
63// 関数を実行して、DOMCharacterDataのchildNodesプロパティの挙動を確認します。
64demonstrateDomCharacterDataChildNodes();
65
66?>

このコードは、PHPのDOM拡張機能におけるDOMCharacterDataクラスのchildNodesプロパティの挙動を示すものです。DOMCharacterDataは、テキストノードやコメントノードのように、文字データを直接扱うノードの基底クラスです。これらのノードは、他の種類のノード（例えば要素ノード）とは異なり、自身の中に別の子ノードを持つことはありません。したがって、DOMCharacterData::childNodesプロパティにアクセスしても、常に空のDOMNodeListオブジェクトが返されます。

childNodesプロパティは引数を取らず、ノードが持つ子ノードのリストをDOMNodeListとして返します。しかし、DOMCharacterDataを継承するノードの場合、このリストは常に空です。戻り値の型はDOMNodeListまたはnullです。

サンプルコードでは、まずHTML文字列をDOMDocumentに読み込み、DOMXPathを使って<p>タグ内のテキストノードを特定しています。このテキストノードはDOMCharacterDataを継承したDOMTextオブジェクトです。コードは、このDOMTextオブジェクトのchildNodesプロパティにアクセスし、そのlengthが0であることを明示することで、DOMCharacterDataノードが子ノードを持たないという特性を具体的に示しています。