【PHP8.x】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を返すことを確認しています。