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

Copy
1<?php
2
3// Dom\XMLDocument::hasChildNodes() の使用例
4// この関数は、XMLノードが子ノードを持っているかどうかを判定するhasChildNodes()メソッドの動作を示します。
5// Dom\XMLDocument クラスは PHP 8 以降で導入された新しいDOM拡張の一部です。
6function demonstrateHasChildNodes(): void
7{
8    // サンプルXML文字列を定義します。
9    // 子要素を持つノード、テキストノードのみを持つノード、子ノードを持たないノードの例を含みます。
10    $xmlString = <<<XML
11<?xml version="1.0" encoding="UTF-8"?>
12<root>
13    <parent>
14        <child>子要素とテキストを含むノード</child>
15    </parent>
16    <text_only>これはテキストノードのみの要素です。</text_only>
17    <empty_element/>
18    <!-- これはコメントノードです -->
19</root>
20XML;
21
22    try {
23        // Dom\XMLDocument の新しいインスタンスを作成します。
24        $document = new Dom\XMLDocument();
25
26        // XML文字列を読み込みます。
27        // XMLのパースに失敗した場合は Dom\ParseException がスローされます。
28        $document->loadXML($xmlString);
29
30        echo "--- Dom\\XMLDocument::hasChildNodes() の動作確認 ---\n\n";
31
32        // 例1: ドキュメントルート要素 (<root>)
33        // documentElement プロパティはドキュメントのルート要素 (この場合 <root>) を返します。
34        // <root>要素は <parent>, <text_only>, <empty_element>, コメントノード、および空白のテキストノードを持っています。
35        $rootElement = $document->documentElement;
36        if ($rootElement) {
37            $hasChildren = $rootElement->hasChildNodes();
38            echo "ノード '<root>': 子ノードを持っていますか？ " . ($hasChildren ? "はい" : "いいえ") . " (期待: はい)\n";
39        }
40
41        // 例2: 子要素を持つノード (<parent>)
42        // getElementsByTagName() は指定されたタグ名の要素のコレクションを返します。
43        // item(0) でそのコレクションの最初の要素にアクセスします。
44        $parentElement = $document->getElementsByTagName('parent')->item(0);
45        if ($parentElement) {
46            $hasChildren = $parentElement->hasChildNodes();
47            echo "ノード '<parent>': 子ノードを持っていますか？ " . ($hasChildren ? "はい" : "いいえ") . " (期待: はい)\n";
48        }
49
50        // 例3: テキストノードを持つノード (<child>)
51        // <child>要素はテキストノード「子要素とテキストを含むノード」を持っています。
52        $childElement = $document->getElementsByTagName('child')->item(0);
53        if ($childElement) {
54            $hasChildren = $childElement->hasChildNodes();
55            echo "ノード '<child>': 子ノードを持っていますか？ " . ($hasChildren ? "はい" : "いいえ") . " (期待: はい, テキストノードが存在するため)\n";
56        }
57
58        // 例4: テキストノードのみを持つノード (<text_only>)
59        // <text_only>要素はテキストノード「これはテキストノードのみの要素です。」を持っています。
60        $textOnlyElement = $document->getElementsByTagName('text_only')->item(0);
61        if ($textOnlyElement) {
62            $hasChildren = $textOnlyElement->hasChildNodes();
63            echo "ノード '<text_only>': 子ノードを持っていますか？ " . ($hasChildren ? "はい" : "いいえ") . " (期待: はい, テキストノードが存在するため)\n";
64        }
65
66        // 例5: 子ノードを持たないノード (<empty_element>)
67        // <empty_element>要素には、子要素もテキストノードもありません。
68        $emptyElement = $document->getElementsByTagName('empty_element')->item(0);
69        if ($emptyElement) {
70            $hasChildren = $emptyElement->hasChildNodes();
71            echo "ノード '<empty_element>': 子ノードを持っていますか？ " . ($hasChildren ? "はい" : "いいえ") . " (期待: いいえ)\n";
72        }
73
74        // 例6: XMLドキュメント自体
75        // XMLドキュメントノード自体は、ルート要素 (documentElement) を子ノードとして持つため、通常は true を返します。
76        $documentHasChildren = $document->hasChildNodes();
77        echo "ドキュメント自体: 子ノードを持っていますか？ " . ($documentHasChildren ? "はい" : "いいえ") . " (期待: はい, ルート要素が存在するため)\n";
78
79    } catch (Dom\ParseException $e) {
80        // XMLのパースエラーが発生した場合の処理
81        echo "XMLのパースエラーが発生しました: " . $e->getMessage() . "\n";
82    } catch (Throwable $e) {
83        // その他の予期せぬエラーが発生した場合の処理
84        echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
85    }
86}
87
88// 定義した関数を実行し、サンプルコードの動作を示します。
89demonstrateHasChildNodes();

PHP 8で導入されたDom\XMLDocumentクラスのhasChildNodes()メソッドは、特定のXMLノードが子ノードを持っているかどうかを真偽値で判断します。このメソッドは引数を取らず、戻り値としてbool型（真偽値）を返します。子ノードとは、他の要素ノードだけでなく、ノード内のテキストコンテンツを表すテキストノードや、コメントノードなども含みます。したがって、たとえ子要素がなくても、テキストコンテンツを持つノードはhasChildNodes()がtrueを返します。サンプルコードでは、XML文書内の様々なノード（子要素を持つノード、テキストノードのみを持つノード、完全に空のノードなど）に対してこのメソッドを適用し、その具体的な動作を示しています。これにより、XML文書の特定のノードが内容を持っているかをプログラムで効率的に確認できます。

Copy
1<?php
2
3/**
4 * XMLドキュメント内の指定されたノードが子ノードを持つか判定するサンプル関数です。
5 *
6 * この関数は、Dom\XMLDocument::hasChildNodes() メソッドの基本的な使い方を示します。
7 * JavaScriptのjQueryなどで要素に子要素があるかを判定するのと
8 * 同様の概念で、PHPのDOM操作でノードの子ノードの有無をチェックする方法です。
9 * Dom\XMLDocument クラスはPHP 8で導入された新しいDOM拡張機能です。
10 *
11 * @return void
12 */
13function demonstrateDomHasChildNodes(): void
14{
15    // サンプルXMLデータを作成します。
16    // いくつかの異なるタイプのノードを用意し、hasChildNodes() の振る舞いを検証します。
17    // - <parent_with_children>: 子要素ノード (<child1>, <child2>) を持つ。
18    // - <parent_without_children/>: 子要素ノードを持たない (自己閉じタグ)。
19    // - <text_node_only>: テキストノードのみを持つ。hasChildNodes() はテキストノードも子ノードとみなします。
20    // - <empty_node>: 子ノードもテキストノードも持たない。
21    $xmlString = <<<XML
22<?xml version="1.0" encoding="UTF-8"?>
23<root>
24    <parent_with_children>
25        <child1>データ1</child1>
26        <child2>データ2</child2>
27    </parent_with_children>
28    <parent_without_children/>
29    <text_node_only>これはテキストコンテンツです。</text_node_only>
30    <empty_node></empty_node>
31</root>
32XML;
33
34    try {
35        // Dom\XMLDocument オブジェクトを新しく作成します。
36        $document = new Dom\XMLDocument();
37        // XML文字列をロードします。失敗した場合は例外をスローします。
38        $document->loadXML($xmlString);
39
40        echo "XMLドキュメントが正常にロードされました。\n\n";
41
42        // ルートノード (<root>) を取得します。
43        $rootElement = $document->documentElement;
44
45        // --- ルートノードの子ノードの有無をチェック ---
46        // <root> ノードは、<parent_with_children> などの子ノードを持っています。
47        echo "ルートノード (<root>) に子ノードがありますか？ ";
48        if ($rootElement->hasChildNodes()) {
49            echo "はい、あります。\n"; // => true
50        } else {
51            echo "いいえ、ありません。\n";
52        }
53        echo "---------------------------------\n";
54
55        // --- <parent_with_children> ノードの子ノードの有無をチェック ---
56        // このノードは <child1> と <child2> という子要素ノードを持っています。
57        $parentWithChildren = $document->getElementsByTagName('parent_with_children')->item(0);
58        if ($parentWithChildren) {
59            echo "<parent_with_children> ノードに子ノードがありますか？ ";
60            if ($parentWithChildren->hasChildNodes()) {
61                echo "はい、あります。\n"; // => true
62            } else {
63                echo "いいえ、ありません。\n";
64            }
65        }
66        echo "---------------------------------\n";
67
68        // --- <parent_without_children> ノードの子ノードの有無をチェック ---
69        // このノードは子要素ノードを全く持っていません。
70        $parentWithoutChildren = $document->getElementsByTagName('parent_without_children')->item(0);
71        if ($parentWithoutChildren) {
72            echo "<parent_without_children> ノードに子ノードがありますか？ ";
73            if ($parentWithoutChildren->hasChildNodes()) {
74                echo "はい、あります。\n";
75            } else {
76                echo "いいえ、ありません。\n"; // => false
77            }
78        }
79        echo "---------------------------------\n";
80
81        // --- <text_node_only> ノードの子ノードの有無をチェック ---
82        // このノードは子要素ノードを持ちませんが、テキストノード ('これはテキストコンテンツです。') を持ちます。
83        // hasChildNodes() はテキストノードも子ノードとしてカウントします。
84        $textNodeOnly = $document->getElementsByTagName('text_node_only')->item(0);
85        if ($textNodeOnly) {
86            echo "<text_node_only> ノードに子ノードがありますか？ ";
87            if ($textNodeOnly->hasChildNodes()) {
88                echo "はい、あります (テキストノードを含む)。\n"; // => true
89            } else {
90                echo "いいえ、ありません。\n";
91            }
92        }
93        echo "---------------------------------\n";
94        
95        // --- <empty_node> ノードの子ノードの有無をチェック ---
96        // このノードは子要素ノードもテキストノードも持ちません。
97        $emptyNode = $document->getElementsByTagName('empty_node')->item(0);
98        if ($emptyNode) {
99            echo "<empty_node> ノードに子ノードがありますか？ ";
100            if ($emptyNode->hasChildNodes()) {
101                echo "はい、あります。\n";
102            } else {
103                echo "いいえ、ありません。\n"; // => false
104            }
105        }
106        echo "---------------------------------\n";
107
108    } catch (Throwable $e) {
109        // XMLのロードや解析中にエラーが発生した場合の処理
110        echo "エラーが発生しました: " . $e->getMessage() . "\n";
111    }
112}
113
114// サンプル関数を実行します。
115demonstrateDomHasChildNodes();
116

Dom\XMLDocument::hasChildNodes() メソッドは、PHP 8で導入された新しいDOM拡張機能に属し、XMLドキュメント内の特定のノードが子ノードを持っているかを判定します。

このメソッドは引数を一切取りません。対象となるノードに対して直接呼び出すことで、そのノードが子ノードを持つかどうかをチェックします。

戻り値は bool 型です。対象のノードが子ノードを一つでも持っていれば true を、一つも持っていなければ false を返します。ここで言う子ノードには、他の要素ノードだけでなく、ノード内のテキストコンテンツを表すテキストノードも含まれます。

サンプルコードでは、いくつかの異なるXMLノードに対してこのメソッドの挙動を検証しています。例えば、<parent_with_children> ノードのように子要素を持つ場合は true を返します。子要素を全く持たない <parent_without_children/> や <empty_node> の場合は false を返します。特に重要な点として、<text_node_only> ノードのように子要素はなくてもテキストコンテンツを持つ場合は、そのテキストが子ノードとして扱われるため true を返します。

このメソッドを理解することで、XMLドキュメントの構造を効率的かつ正確に解析し、ノードの有無に基づいた条件分岐処理を記述できるようになります。