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

Copy
1<?php
2
3// Dom\Document::hasChildNodes() メソッドのサンプルコード
4
5// Dom\Document オブジェクトはXMLやHTMLドキュメント全体を表します。
6// hasChildNodes() メソッドは、このドキュメントオブジェクトが子ノード（例: ルート要素、DOCTYPE宣言、コメントなど）を持つかどうかを真偽値で返します。
7
8echo "--- ケース1: ドキュメントが子ノードを持つ場合 ---\n";
9
10// 新しい Dom\Document オブジェクトを作成します。
11$documentWithChildren = new Dom\Document();
12
13// ドキュメントにルート要素を作成し、子ノードとして追加します。
14// 例: '<root>' というXML要素をドキュメントの最初の子として追加します。
15$rootElement = $documentWithChildren->createElement('root');
16$documentWithChildren->appendChild($rootElement);
17
18// hasChildNodes() メソッドを呼び出し、子ノードの有無を確認します。
19$hasChildren1 = $documentWithChildren->hasChildNodes();
20
21// 結果を出力します。
22echo "ドキュメントに子ノードがありますか？ " . ($hasChildren1 ? 'はい' : 'いいえ') . "\n";
23echo "hasChildNodes() の戻り値: " . var_export($hasChildren1, true) . "\n\n";
24
25
26echo "--- ケース2: ドキュメントが子ノードを持たない場合 ---\n";
27
28// 新しい Dom\Document オブジェクトを作成します。
29// このオブジェクトは、初期状態では子ノードを何も持っていません。
30$documentWithoutChildren = new Dom\Document();
31
32// hasChildNodes() メソッドを呼び出し、子ノードの有無を確認します。
33$hasChildren2 = $documentWithoutChildren->hasChildNodes();
34
35// 結果を出力します。
36echo "ドキュメントに子ノードがありますか？ " . ($hasChildren2 ? 'はい' : 'いいえ') . "\n";
37echo "hasChildNodes() の戻り値: " . var_export($hasChildren2, true) . "\n";
38
39?>

Dom\Document::hasChildNodes() メソッドは、XMLやHTMLなどのドキュメント構造を扱う際に使用されるPHPの機能です。このメソッドは、Dom\Document オブジェクト（ドキュメント全体を表すオブジェクト）が、子ノードを持っているかどうかを確認するために利用されます。

具体的には、ドキュメントのルート要素やコメント、DOCTYPE宣言、テキストノードなど、ドキュメント直下に存在する要素やノードがあるかどうかを判定します。このメソッドに引数は必要ありません。

戻り値は bool 型で、ドキュメントオブジェクトが子ノードを一つでも持っていれば true を、子ノードを全く持っていなければ false を返します。

サンプルコードでは、まず子ノードを持つケースを示しています。新しい Dom\Document オブジェクトに 'root' という要素を子として追加した後、hasChildNodes() を呼び出すと、期待通り true が返されることが確認できます。これは、ドキュメントにルート要素という子ノードが存在するためです。

次に、子ノードを全く持たない初期状態の Dom\Document オブジェクトに対して同じメソッドを呼び出すと、false が返されることを確認できます。これは、まだ何も追加されていない空のドキュメントには子ノードが存在しないためです。この例を通して、メソッドがどのようにドキュメントの子ノードの有無を判定するかが明確に理解できます。

Copy
1<?php
2
3// Dom\Document クラスのインスタンスを作成します。
4// これはXMLやHTMLドキュメント全体を表すオブジェクトです。
5$document = new Dom\Document();
6
7echo "初期状態のドキュメント:\n";
8// hasChildNodes() メソッドは、このノードが一つ以上の子ノードを持っているかをチェックします。
9// ドキュメントが作成されたばかりの時点では、通常子ノードは存在しません。
10if ($document->hasChildNodes()) {
11    echo "  - 子ノードを持っています。\n";
12} else {
13    echo "  - 子ノードを持っていません。\n"; // このメッセージが表示されます。
14}
15
16// ドキュメントにHTMLルート要素を追加します。
17$htmlElement = $document->createElement('html');
18$document->appendChild($htmlElement);
19
20echo "\nルート要素追加後のドキュメント:\n";
21// ルート要素が追加されたので、ドキュメントは子ノードを持つようになります。
22if ($document->hasChildNodes()) {
23    echo "  - 子ノードを持っています。\n"; // このメッセージが表示されます。
24} else {
25    echo "  - 子ノードを持っていません。\n";
26}
27
28?>

PHPのDom\Document::hasChildNodes()メソッドは、XMLやHTMLドキュメントを操作する際、特定のノードが子ノードを持っているかを確認するために使用されます。このメソッドは引数を一切取らず、ノードが一つでも子ノードを持っていればtrue（真）、そうでなければfalse（偽）をブール値として返します。

提供されたサンプルコードでは、まずnew Dom\Document()で空のドキュメントを作成します。この初期状態のドキュメントはまだ何もコンテンツを含んでいないため、hasChildNodes()を実行するとfalseを返し、「子ノードを持っていません。」と出力されます。

次に、$document->createElement('html')でHTML要素を作成し、$document->appendChild($htmlElement)を使ってドキュメントのルート要素として追加します。これにより、ドキュメントはhtmlという子ノードを一つ持つ状態になります。この状態で再度hasChildNodes()を呼び出すと、ドキュメントが子ノードを持つようになったためtrueが返され、「子ノードを持っています。」と出力されます。

このように、hasChildNodes()メソッドは、DOMツリーの構造をプログラムで確認し、その後の処理を分岐させるための基本的な機能として役立ちます。