【PHP8.x】Dom\CharacterData::hasChildNodes()メソッドの使い方

Copy
1<?php
2
3/**
4 * PHPのDom\CharacterData::hasChildNodes()メソッドの使用例を示します。
5 *
6 * Dom\CharacterDataは、DOMツリーにおけるテキストデータ（DOMText）、コメント（DOMComment）、
7 * またはCDATAセクション（DOMCdataSection）を表す抽象基底クラスです。
8 * これらのノードは、その性質上、自身の中にさらに子ノードを持つことはできません。
9 * したがって、hasChildNodes()メソッドは常にfalseを返します。
10 */
11function demonstrateCharacterDataHasChildNodes(): void
12{
13    // DOMDocumentオブジェクトを作成します。これはDOMツリーのコンテナとなります。
14    $dom = new DOMDocument('1.0', 'UTF-8');
15
16    // 1. DOMTextノードのhasChildNodes()の確認
17    // テキストノードを作成します。これはDom\CharacterDataを継承しています。
18    $textNode = $dom->createTextNode('これはサンプルテキストです。');
19
20    // テキストノードが子ノードを持っているかを確認します。
21    // テキストノードは他のDOMノードを子として持つことができないため、常にfalseを返します。
22    echo "テキストノード '{$textNode->nodeValue}' の hasChildNodes() 結果: ";
23    var_dump($textNode->hasChildNodes()); // 期待される出力: bool(false)
24
25    echo "\n"; // 見やすくするために改行を追加
26
27    // 2. DOMCommentノードのhasChildNodes()の確認
28    // コメントノードを作成します。これもDom\CharacterDataを継承しています。
29    $commentNode = $dom->createComment('これはHTMLコメントです。');
30
31    // コメントノードが子ノードを持っているかを確認します。
32    // コメントノードも他のDOMノードを子として持つことができないため、常にfalseを返します。
33    echo "コメントノード '{$commentNode->nodeValue}' の hasChildNodes() 結果: ";
34    var_dump($commentNode->hasChildNodes()); // 期待される出力: bool(false)
35}
36
37// 上記のデモンストレーション関数を実行します。
38demonstrateCharacterDataHasChildNodes();

PHPのDom\CharacterData::hasChildNodes()メソッドは、DOMツリー内の特定のノードが子ノードを持っているかどうかを確認するために使用されます。Dom\CharacterDataクラスは、ウェブページの構造を記述するDOM（Document Object Model）において、テキストデータ、HTMLコメント、CDATAセクションといった文字情報を扱うノードの抽象的な基底クラスです。

このメソッドは引数を取らず、戻り値として真偽値（bool）を返します。通常、trueは子ノードが存在すること、falseは子ノードが存在しないことを示します。しかし、Dom\CharacterDataを継承するノード、例えばテキストノード（DOMText）やコメントノード（DOMComment）は、その性質上、自身の中に他のDOM要素のような構造的な子ノードを持つことができません。

そのため、Dom\CharacterDataのインスタンスに対してhasChildNodes()を呼び出すと、常にfalseが返されるという挙動になります。サンプルコードでは、DOMTextとDOMCommentのそれぞれでこのメソッドを実行していますが、どちらの場合も子ノードを持たないため、falseが出力されることを確認できます。これは、文字情報そのものが自己完結しており、内部にさらに構造を持つことはない、というDOMの設計に基づいています。

Copy
1<?php
2
3// PHP DOM拡張機能を利用したhasChildNodes()メソッドのサンプルコード
4// このメソッドは、ノードが子ノードを持っているかを真偽値で返します。
5
6// DOMDocumentを作成します。これはXMLやHTMLドキュメントを扱うための基盤となります。
7$dom = new DOMDocument('1.0', 'UTF-8');
8
9// Dom\CharacterData クラスのインスタンス（またはその子クラス）を作成します。
10// ここでは、Dom\CharacterData を継承する DOMText クラスを使用します。
11// DOMText は、テキストコンテンツを持つノード（例: <p>テキスト</p> の「テキスト」部分）を表します。
12$textNode = $dom->createTextNode('これはサンプルテキストです。');
13
14// DOMText ノードに子ノードがあるかを確認します。
15// Dom\CharacterData を継承するノード（テキストノード、コメントノード、CDATAセクションノードなど）は、
16// その性質上、自身がデータの終端であるため、通常は他のノードを子として持ちません。
17$hasChildren = $textNode->hasChildNodes();
18
19echo "DOMTextノードに子ノードがありますか？" . PHP_EOL;
20echo "結果: " . ($hasChildren ? 'はい' : 'いいえ') . PHP_EOL;
21// 期待される出力: いいえ
22
23// 解説:
24// Dom\CharacterData クラス（およびその子クラスであるDOMTextなど）のインスタンスは、
25// テキストデータそのものを表し、他のDOMノードを内部に含む構造ではありません。
26// したがって、hasChildNodes() を呼び出すと、常に false が返されます。
27// このメソッドは、一般的には Dom\Element (要素ノード) などに対して、
28// その要素が子要素やテキストノードを持っているかを確認するために利用されます。
29
30?>

このコードは、PHPのDOM拡張機能に属するDom\CharacterData::hasChildNodes()メソッドの利用例を示しています。このメソッドは、呼び出されたノードが子ノードを持っているかどうかを真偽値（bool）で判定し、結果を返します。引数は必要ありません。

サンプルコードでは、DOMTextクラスのインスタンスに対してhasChildNodes()を呼び出しています。DOMTextはDom\CharacterDataクラスを継承しており、テキストコンテンツ自体を表すノードです。テキストノードは、それ自体がデータの終端であるため、原則として他のノードを子として持つことはありません。

したがって、Dom\CharacterDataを継承するDOMTextノードに対してhasChildNodes()を実行すると、常にfalse（子ノードがない）が返されます。このメソッドは通常、HTML要素を表すDom\Elementのようなノードに対して、その要素が子要素やテキストコンテンツを含んでいるかを確認するために利用されることが多いです。