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

Copy
1<?php
2
3/**
4 * DOMElement::isSameNode メソッドの使用例を示します。
5 * このメソッドは、2つのDOMノードが同じオブジェクトインスタンスを参照しているかを確認します。
6 * キーワード「isnotempty」に関連して、DOMノードが存在すること（nullでないこと）の確認も含まれています。
7 *
8 * @return void
9 */
10function demonstrateDomElementIsSameNode(): void
11{
12    // HTML文字列からDOMDocumentを作成します。
13    $dom = new DOMDocument();
14    // 適切なHTMLをロードします。XMLエラーを抑制するために @ を使用しています。
15    @$dom->loadHTML('<div id="container"><p id="first-paragraph">Hello</p><p id="second-paragraph">World</p></div>');
16
17    echo "--- DOMElement::isSameNode の使用例 ---\n\n";
18
19    // ケース1: 同じノードを複数回取得した場合の比較
20    // getElementByIdは、同じIDに対して常に同じオブジェクトインスタンスを返します。
21    $firstParagraphNode1 = $dom->getElementById('first-paragraph');
22    $firstParagraphNode2 = $dom->getElementById('first-paragraph');
23
24    echo "ケース1: 同じIDで取得した2つのノードの比較\n";
25    // ノードがnullでないか（isnotemptyな状態か）を確認することは、安全なDOM操作の基本です。
26    if ($firstParagraphNode1 !== null && $firstParagraphNode2 !== null) {
27        echo "  \$firstParagraphNode1 と \$firstParagraphNode2 は同じノードですか？ ";
28        var_dump($firstParagraphNode1->isSameNode($firstParagraphNode2)); // 期待値: true
29        echo "  (理由: 同じgetElementById呼び出しは、同じオブジェクトインスタンスを指します)\n\n";
30    } else {
31        echo "  エラー: 'first-paragraph' ノードが見つかりませんでした。\n\n";
32    }
33
34    // ケース2: 異なるノードの比較
35    $firstParagraphNode = $dom->getElementById('first-paragraph');
36    $secondParagraphNode = $dom->getElementById('second-paragraph');
37
38    echo "ケース2: 異なるIDで取得した2つのノードの比較\n";
39    // ここでもノードがnullでないかを確認します。
40    if ($firstParagraphNode !== null && $secondParagraphNode !== null) {
41        echo "  \$firstParagraphNode と \$secondParagraphNode は同じノードですか？ ";
42        var_dump($firstParagraphNode->isSameNode($secondParagraphNode)); // 期待値: false
43        echo "  (理由: 異なる要素は異なるオブジェクトインスタンスです)\n\n";
44    } else {
45        echo "  エラー: 'first-paragraph' または 'second-paragraph' ノードが見つかりませんでした。\n\n";
46    }
47
48    // ケース3: 存在するノードと存在しないノード (null) の比較
49    $existingNode = $dom->getElementById('first-paragraph');
50    $nonExistentNode = $dom->getElementById('non-existent-id'); // 存在しないIDなのでnullが返されます。
51
52    echo "ケース3: 存在するノードと存在しないノード (null) の比較\n";
53    // isSameNodeは引数にnullを受け入れます。
54    if ($existingNode !== null) { // 比較対象のノードがnullでないことを確認
55        echo "  \$existingNode と \$nonExistentNode (null) は同じノードですか？ ";
56        var_dump($existingNode->isSameNode($nonExistentNode)); // 期待値: false
57        echo "  (理由: DOMElementオブジェクトはnullとは同じではありません)\n\n";
58    } else {
59        echo "  エラー: 'first-paragraph' ノードが見つかりませんでした。\n\n";
60    }
61}
62
63// 関数を実行して結果を表示します。
64demonstrateDomElementIsSameNode();
65

PHPのDOMElement::isSameNodeメソッドは、二つのDOMノードがメモリ上で「全く同じオブジェクトインスタンス」であるかを確認するために使用されます。このメソッドはDOMElementクラスに属し、引数として比較対象のDOMNodeオブジェクト、またはnullを受け取ります。戻り値は真偽値（bool）で、両者が同じインスタンスであればtrue、そうでなければfalseを返します。

サンプルコードでは、DOMDocumentにロードされたHTML内の要素を使って挙動を示しています。例えば、getElementByIdで同じIDを持つ要素を複数回取得した場合、それらは常に同じオブジェクトインスタンスを指すため、isSameNodeはtrueを返します。これに対し、異なるIDの要素や、getElementByIdで存在しないIDを指定して取得されたnullと比較した場合は、異なるオブジェクトインスタンスであるためfalseを返します。特に、比較対象のノードがnullでないこと（キーワードのisnotemptyの状態であること）を確認することは、安全なDOM操作において非常に重要です。このメソッドは、DOMノードの正確な同一性判定を可能にし、DOMツリーを扱うプログラミングの信頼性を高めます。

Copy
1<?php
2
3/**
4 * DOMElement::isSameNode メソッドのサンプルコード
5 *
6 * このメソッドは、2つのDOMノードがDOMツリー内で同じオブジェクト（インスタンス）を
7 * 参照しているかどうかを判定します。
8 * 主に、ノードが物理的に同一であるかを確認する際に使用されます。
9 */
10function demonstrateIsSameNode(): void
11{
12    // 1. 新しいDOMDocumentオブジェクトを作成
13    // XMLドキュメントを構築するための基盤となります。
14    $dom = new DOMDocument('1.0', 'UTF-8');
15    $dom->formatOutput = true; // 出力を読みやすく整形する設定
16
17    // 2. ルート要素 'root' を作成し、ドキュメントに追加
18    $root = $dom->createElement('root');
19    $dom->appendChild($root);
20
21    // 3. 最初の <item> 要素を作成し、ルート要素に追加
22    $item1 = $dom->createElement('item', 'First Item Content');
23    $item1->setAttribute('id', 'unique-id-1'); // IDを設定して後で取得できるようにする
24    $root->appendChild($item1);
25
26    // 4. 2番目の <item> 要素を作成し、ルート要素に追加
27    $item2 = $dom->createElement('item', 'Second Item Content');
28    $item2->setAttribute('id', 'unique-id-2');
29    $root->appendChild($item2);
30
31    // 5. 同じノードへの別の参照を取得
32    // getElementById() を使用して、ID 'unique-id-1' を持つ要素を取得します。
33    // $item1Ref は、$item1 と同じDOMノードオブジェクトを指します。
34    $item1Ref = $dom->getElementById('unique-id-1');
35
36    echo "--- DOMElement::isSameNode の使用例 ---\n\n";
37
38    // ケース1: 同じDOMノードオブジェクトを比較する
39    // $item1 と $item1Ref は、DOMツリー内の全く同じノードインスタンスです。
40    echo "比較1: \$item1 と \$item1Ref (同じノードの参照):\n";
41    if ($item1->isSameNode($item1Ref)) {
42        echo "  結果: true - これらは同じDOMノードオブジェクトです。\n";
43    } else {
44        echo "  結果: false - これらは異なるノードです。\n";
45    }
46    echo "  (\$item1 のtextContent: '{$item1->textContent}', \$item1Ref のtextContent: '{$item1Ref->textContent}')\n\n";
47
48
49    // ケース2: 異なるDOMノードオブジェクトを比較する
50    // $item1 と $item2 は、DOMツリー内の異なるノードインスタンスです。
51    echo "比較2: \$item1 と \$item2 (異なるノード):\n";
52    if ($item1->isSameNode($item2)) {
53        echo "  結果: true - これらは同じDOMノードオブジェクトです。\n";
54    } else {
55        echo "  結果: false - これらは異なるDOMノードオブジェクトです。\n";
56    }
57    echo "  (\$item1 のtextContent: '{$item1->textContent}', \$item2 のtextContent: '{$item2->textContent}')\n\n";
58
59    // ケース3: null と比較する
60    // isSameNode メソッドは引数として null を受け取ることができ、この場合常に false を返します。
61    echo "比較3: \$item1 と null:\n";
62    if ($item1->isSameNode(null)) {
63        echo "  結果: true - (このケースは通常発生しません)\n";
64    } else {
65        echo "  結果: false - null はどのノードとも同じではありません。\n";
66    }
67    echo "\n";
68
69    // ケース4: 異なるDOMDocumentに属するノードを比較する
70    // isSameNode は、異なるDOMDocumentに属するノードに対しては常に false を返します。
71    // たとえ内容が全く同じであっても、オブジェクトが異なるため「同じノード」とは見なされません。
72    $dom2 = new DOMDocument('1.0', 'UTF-8');
73    $otherItem = $dom2->createElement('item', 'First Item Content'); // $item1 と同じ内容
74    
75    echo "比較4: \$item1 と別のDOMDocumentのノード:\n";
76    if ($item1->isSameNode($otherItem)) {
77        echo "  結果: true - (このケースは通常発生しません)\n";
78    } else {
79        echo "  結果: false - 異なるDOMDocumentに属するノードは同じと見なされません。\n";
80    }
81    echo "\n";
82}
83
84// 関数を実行してサンプルコードの動作を確認
85demonstrateIsSameNode();
86
87?>

PHPのDOMElement::isSameNodeメソッドは、DOMツリー内で2つのノードがメモリ上で全く同じオブジェクト（インスタンス）であるかを判定するために使用されます。このメソッドは、比較対象となるDOMNodeオブジェクト、またはnullを引数として受け取り、結果を真偽値（trueまたはfalse）として返します。

サンプルコードでは、いくつかの異なる状況でのisSameNodeの挙動を示しています。まず、$item1と$item1Refのように、DOMツリー内の同じ要素ノードを指す異なる変数同士を比較すると、これらは物理的に同じオブジェクトであるためtrueが返されます。これに対して、$item1と$item2のように、DOMツリー内で別々に作成された異なる要素ノードを比較すると、たとえタグ名や内容が似ていても、それぞれが独立したオブジェクトであるためfalseが返されます。

また、isSameNodeメソッドにnullを引数として渡した場合、いかなるノードとも同じではないため常にfalseとなります。さらに重要な点として、たとえ内容が全く同じであったとしても、異なるDOMDocumentオブジェクトに属するノード同士を比較した場合は、それぞれが独立したドキュメント内で管理される別々のオブジェクトであるためfalseとなります。このメソッドは、ノードの「内容」ではなく、メモリ上の「実体」が同一であるかを厳密に確認したい場合に役立ちます。