【PHP8.x】DOMDocument::isSameNode()メソッドの使い方

Copy
1<?php
2
3/**
4 * DOMNode::isSameNode メソッドのデモンストレーション関数。
5 *
6 * システムエンジニアを目指す初心者向けに、DOMノードの同一性チェックと
7 * ノードが存在すること（空でないこと）の確認方法を組み合わせたサンプルです。
8 */
9function demonstrateDomNodeComparison(): void
10{
11    echo "DOMNode::isSameNode メソッドのデモンストレーション:\n";
12
13    // 1. 新しいDOMドキュメントを作成
14    $dom = new DOMDocument('1.0', 'UTF-8');
15    // 出力を見やすくするためにフォーマットを有効化
16    $dom->formatOutput = true;
17
18    // 2. ルート要素を作成し、ドキュメントに追加
19    $rootElement = $dom->createElement('root');
20    $dom->appendChild($rootElement);
21
22    // 3. 子要素を作成し、ルート要素に追加
23    $child1 = $dom->createElement('item', 'Item A');
24    $rootElement->appendChild($child1);
25
26    // 別の内容で、見た目は同じだが異なるオブジェクトの子要素を作成
27    $child2 = $dom->createElement('item', 'Item B');
28    $rootElement->appendChild($child2);
29
30    // child1 と全く同じオブジェクトを参照する変数を作成
31    $child1Reference = $child1;
32
33    echo "\n--- ノードの同一性比較 ---\n";
34
35    // ケース1: 同じオブジェクトを参照しているか？
36    // $child1 と $child1Reference は同じDOMNodeオブジェクトを指しているため、true になります。
37    echo "1. \$child1 と \$child1Reference:\n";
38    if ($child1->isSameNode($child1Reference)) {
39        echo "   -> 同じノードです。 (期待値: true)\n";
40    } else {
41        echo "   -> 異なるノードです。 (期待値: false)\n";
42    }
43
44    // ケース2: 内容は異なるが、同じタグ名を持つ別のオブジェクトか？
45    // $child1 と $child2 は内容が異なるだけでなく、異なるDOMNodeオブジェクトなので、false になります。
46    echo "\n2. \$child1 と \$child2:\n";
47    if ($child1->isSameNode($child2)) {
48        echo "   -> 同じノードです。 (期待値: false)\n";
49    } else {
50        echo "   -> 異なるノードです。 (期待値: true)\n";
51    }
52
53    // ケース3: ドキュメントツリーから取得したノードとの比較
54    // 'item' タグ名を持つすべての要素を取得
55    $items = $dom->getElementsByTagName('item');
56    $firstItemFromDocument = null;
57
58    // キーワード 'php isnotempty' に関連するチェック
59    // getElementsByTagName は DOMNodeList を返す。リストが空でないことを確認してから要素にアクセスすることが重要です。
60    echo "\n--- ノードの存在（空でないこと）チェック ---\n";
61    if (!empty($items) && $items->length > 0) {
62        // リストの最初の要素を取得
63        $firstItemFromDocument = $items->item(0);
64        echo "ドキュメントから'item'要素が取得できました。（リストは空ではありません）\n";
65    } else {
66        echo "ドキュメントから'item'要素が取得できませんでした。（リストは空です）\n";
67    }
68
69    // 取得したノードが実際に有効なDOMNodeオブジェクトであり、空ではないことを確認してから比較を行います。
70    // PHP 8では、null を isSameNode に渡すと TypeError になるため、このチェックは重要です。
71    if ($firstItemFromDocument instanceof DOMNode) { // instanceof は、変数が特定のクラスのインスタンスであるかを確認します。
72        echo "\n3. オリジナルの \$child1 と ドキュメントから取得した \$firstItemFromDocument:\n";
73        // $child1 と $firstItemFromDocument は、メモリ内の同じDOMNodeオブジェクトを指しているため、true になります。
74        if ($child1->isSameNode($firstItemFromDocument)) {
75            echo "   -> 同じノードです。 (期待値: true)\n";
76        } else {
77            echo "   -> 異なるノードです。 (期待値: false)\n";
78        }
79    } else {
80        echo "   \$firstItemFromDocument が有効なDOMNodeではありません。比較できません。\n";
81    }
82
83    // 存在しないノード（null）との比較を試みる場合の安全なコード
84    $nonExistentNode = null;
85    echo "\n--- 存在しないノードとの安全な比較試行 ---\n";
86    if ($nonExistentNode instanceof DOMNode) {
87        // このブロックは $nonExistentNode が null のため実行されません。
88        // これにより、isSameNode に null を渡すことによる TypeError を防ぎます。
89        if ($child1->isSameNode($nonExistentNode)) {
90            echo "   (この行は表示されません)\n";
91        }
92    } else {
93        echo "   比較対象のノード (\$nonExistentNode) は有効なDOMNodeではありません。比較は行いません。\n";
94    }
95
96
97    echo "\n--- 生成されたXMLドキュメントの内容 ---\n";
98    // 現在のDOMドキュメントの内容をXML形式で出力
99    echo $dom->saveXML();
100}
101
102// デモンストレーション関数を実行
103demonstrateDomNodeComparison();
104
105?>

DOMNode::isSameNodeは、PHP 8で利用できるDOM操作用のメソッドです。このメソッドは、指定された二つのDOMノードが、メモリ上で全く同じオブジェクトであるかどうかを厳密に比較し、その結果を真偽値（trueまたはfalse）で返します。引数$otherNodeには比較したい別のDOMノードを指定します。

サンプルコードでは、まず新しいXMLドキュメントを作成し、いくつかの要素を追加しています。isSameNodeメソッドは、同じ変数が同じオブジェクトを参照している場合や、ドキュメントツリーから取得したノードが、元々追加したノードとメモリ上で同一である場合にtrueを返します。一方、内容やタグ名が同じであっても、別々に作成された異なるオブジェクトであればfalseとなります。これは、ノードが持つ情報ではなく、ノードそのものの同一性を確認するためです。

システムエンジニアを目指す方にとって重要な点として、DOM操作でノードリストを取得した際には、そのリストが空でないこと（例：!empty($items) && $items->length > 0）を確認してから要素にアクセスすることが大切です。また、比較対象のノードがnullではないことや、実際にDOMNode型のインスタンスであること（例：$node instanceof DOMNode）を確認する習慣をつけましょう。これにより、PHP 8でTypeErrorが発生するのを防ぎ、プログラムの安定性を高めることができます。このメソッドは、XMLやHTMLのDOMツリーを扱う際に、特定のノードが重複していないか、あるいは期待するノードであるかを確実に判断するために役立ちます。

Copy
1<?php
2
3/**
4 * DOMNode::isSameNode メソッドの使用例を示します。
5 *
6 * このメソッドは、2つのDOMノードが同じオブジェクトインスタンスであるかを判定します。
7 * PHPのDOM拡張では、このメソッドはオブジェクトの同一性 (=== 演算子) とほぼ同じ振る舞いをします。
8 * 提供されたリファレンス情報では「所属クラス: DOMDocument」とありますが、
9 * isSameNodeはDOMNodeクラスのメソッドです。
10 * DOMDocumentはDOMNodeを継承しているため、DOMDocumentオブジェクト自身や、
11 * DOMDocumentから取得したDOMElementなどのDOMNodeオブジェクトに対して使用できます。
12 */
13function demonstrateIsSameNode(): void
14{
15    // 1. DOMDocument オブジェクトを作成し、XML文字列を読み込みます。
16    $dom = new DOMDocument();
17    $dom->loadXML('<root><item id="first" /><item id="second" /></root>');
18
19    // 2. DOMツリーから最初の <item> ノードを取得します。
20    //    getElementsByTagName() は DOMNodeList を返し、item(index) で個々の DOMNode を取得します。
21    //    DOMElement は DOMNode を継承しています。
22    $nodeA = $dom->getElementsByTagName('item')->item(0); // <item id="first"/> ノード
23
24    // 3. $nodeA と全く同じオブジェクトインスタンスへの参照を作成します。
25    //    $nodeB は $nodeA と同じメモリ上のオブジェクトを指します。
26    $nodeB = $nodeA;
27
28    // 4. DOMツリー上の同じ要素に、異なるパスでアクセスしてノードを取得します。
29    //    PHPのDOM実装では、同じDOMツリー上のノードを参照していても、
30    //    別のDOMNodeListから取得すると、通常は新しいDOMNodeオブジェクトのインスタンスが作成されます。
31    $nodeC = $dom->getElementsByTagName('item')->item(0); // $nodeA と同じ <item id="first"/> ノードだが、異なるインスタンス
32
33    // 5. DOMツリー上の別の要素ノードを取得します。
34    $nodeD = $dom->getElementsByTagName('item')->item(1); // <item id="second"/> ノード
35
36    echo "--- DOMNode::isSameNode() の使用例 ---\n";
37    echo "このメソッドは、2つのDOMノードがPHPのオブジェクトとして同じインスタンスであるかを判定します。\n";
38    echo "(PHPの '===' 演算子によるオブジェクト同一性比較とほぼ同じ振る舞いをします)\n\n";
39
40    // 例 1: 同じオブジェクトインスタンスを比較
41    echo "比較: \$nodeA と \$nodeB (同じオブジェクトインスタンスへの参照)\n";
42    echo "  isSameNode(): " . ($nodeA->isSameNode($nodeB) ? "TRUE" : "FALSE") . "\n";
43    echo "  (参考: \$nodeA === \$nodeB は " . ($nodeA === $nodeB ? "TRUE" : "FALSE") . ")\n";
44    echo "  -> 同じ変数に代入されたオブジェクトなので、同じインスタンスと判定されます。\n\n";
45
46    // 例 2: DOMツリー上は同じだが、PHPのオブジェクトとしては異なるインスタンスを比較
47    echo "比較: \$nodeA と \$nodeC (DOMツリー上は同じ要素、PHPでは異なるインスタンス)\n";
48    echo "  isSameNode(): " . ($nodeA->isSameNode($nodeC) ? "TRUE" : "FALSE") . "\n";
49    echo "  (参考: \$nodeA === \$nodeC は " . ($nodeA === $nodeC ? "TRUE" : "FALSE") . ")\n";
50    echo "  -> DOMツリーの同じ要素を参照していても、通常は異なるオブジェクトインスタンスとして扱われるため、\n";
51    echo "     isSameNode() は FALSE を返します。\n\n";
52
53    // 例 3: DOMツリー上で異なる要素を比較
54    echo "比較: \$nodeA と \$nodeD (DOMツリー上で異なる要素)\n";
55    echo "  isSameNode(): " . ($nodeA->isSameNode($nodeD) ? "TRUE" : "FALSE") . "\n";
56    echo "  (参考: \$nodeA === \$nodeD は " . ($nodeA === $nodeD ? "TRUE" : "FALSE") . ")\n";
57    echo "  -> 異なる要素なので、当然 FALSE を返します。\n\n";
58
59    // DOMDocument オブジェクト自身を比較する例
60    // DOMDocumentもDOMNodeを継承しているため、isSameNode()を呼び出せます。
61    $anotherDom = $dom; // 同じDOMDocumentオブジェクトへの参照
62    $clonedDom = new DOMDocument();
63    $clonedDom->loadXML('<root><item id="first" /><item id="second" /></root>');
64
65    echo "--- DOMDocument オブジェクトの比較 ---\n";
66    echo "比較: \$dom と \$anotherDom (同じDOMDocumentインスタンスへの参照)\n";
67    echo "  isSameNode(): " . ($dom->isSameNode($anotherDom) ? "TRUE" : "FALSE") . "\n";
68    echo "  (参考: \$dom === \$anotherDom は " . ($dom === $anotherDom ? "TRUE" : "FALSE") . ")\n";
69    echo "  -> 同じDOMDocumentオブジェクトを参照しています。\n\n";
70
71    echo "比較: \$dom と \$clonedDom (内容が同じだが異なるDOMDocumentインスタンス)\n";
72    echo "  isSameNode(): " . ($dom->isSameNode($clonedDom) ? "TRUE" : "FALSE") . "\n";
73    echo "  (参考: \$dom === \$clonedDom は " . ($dom === $clonedDom ? "TRUE" : "FALSE") . ")\n";
74    echo "  -> 内容が同じでも、異なるDOMDocumentオブジェクトなので FALSE を返します。\n";
75}
76
77// サンプル関数を実行します。
78demonstrateIsSameNode();

PHP 8のDOMNode::isSameNodeメソッドは、二つのDOMノードオブジェクトがメモリ上で全く同じインスタンスであるかを判定します。リファレンスではDOMDocumentに所属とありますが、実際はDOMNodeクラスのメソッドです。DOMDocumentはDOMNodeを継承しているため、DOMDocumentオブジェクトやその子ノードであるDOMElementなどで利用可能です。

引数DOMNode $otherNodeには比較対象のノードを指定し、同じインスタンスであればtrue、異なればfalseをbool値で返します。その挙動はPHPの===演算子によるオブジェクトの同一性比較とほぼ同じです。

DOMツリー上で同じ要素であっても、getElementsByTagNameなどのメソッドで別のタイミングで取得すると、通常は新しいオブジェクトインスタンスが生成されるため、isSameNodeはfalseを返します。これは、DOMツリー上の論理的な位置ではなく、PHPプログラムが扱うオブジェクトの実体に着目しているためです。このメソッドは、DOM操作において特定のノードが以前参照していたものと同一であるかを正確に判断する際に役立ちます。