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

Copy
1<?php
2
3/**
4 * DOMText::isSameNode メソッドの利用例を示します。
5 * このメソッドは、2つのDOMノードがメモリ上で同じオブジェクトであるか（つまり、同じノードであるか）を判断します。
6 * キーワード「php isnotempty」の概念を考慮し、ノードの存在（空ではないこと）と同一性のチェックを組み合わせたシナリオをデモンストレーションします。
7 *
8 * @param void
9 * @return void
10 */
11function demonstrateDomNodeIdentityAndExistence(): void
12{
13    // 1. DOMDocumentを作成し、操作の準備をします。
14    $dom = new DOMDocument('1.0', 'UTF-8');
15    // 出力を見やすくするため、フォーマットを有効にします。
16    $dom->formatOutput = true;
17
18    // 2. ルート要素 'container' を作成し、DOMツリーに追加します。
19    $containerElement = $dom->createElement('container');
20    $dom->appendChild($containerElement);
21
22    // 3. 元となるテキストノードを作成し、container要素の子として追加します。
23    //    これは、私たちが比較の基準とするノードです。
24    $originalTextNode = $dom->createTextNode('Hello PHP DOM!');
25    $containerElement->appendChild($originalTextNode);
26
27    echo "--- DOMText::isSameNode() デモンストレーション ---\n\n";
28
29    // --- シナリオ1: ドキュメント内から既存のノードを再取得し、同一性を確認 ---
30    // ここでは、DOMツリー内の既存ノードへの参照を再度取得します。
31    // isSameNodeは、たとえ変数名が異なっても、同じメモリ上のノードを指しているかをチェックします。
32    
33    // containerElement の最初の子ノードを取得します。
34    // childNodes->item(0) は DOMNode オブジェクト、またはノードが存在しない場合は null を返します。
35    $retrievedNode = $containerElement->childNodes->item(0);
36
37    echo "シナリオ1: DOMツリーからノードを再取得して比較\n";
38    echo "  元のノード (\$originalTextNode) と、再取得したノード (\$retrievedNode) が同一か？\n";
39    
40    // 「isnotempty」の概念に沿って、まずノードが取得できたか（nullでないか）をチェックします。
41    // そして、DOMText::isSameNode を呼び出す前に、取得したノードが期待する DOMText 型であることを確認します。
42    if ($retrievedNode instanceof DOMText) {
43        // ノードが存在し（isnotempty）、かつDOMText型であることを確認できました。
44        if ($originalTextNode->isSameNode($retrievedNode)) {
45            echo "  結果: [成功] 再取得したノードは存在し、元のノードとメモリ上で同一です。\n";
46        } else {
47            echo "  結果: [失敗] 再取得したノードは存在しますが、元のノードとは異なります。\n";
48        }
49    } else {
50        // ノードが取得できなかった場合や、DOMText型でなかった場合
51        echo "  結果: [失敗] ノードを取得できませんでした（または DOMText 型ではありませんでした）。\n";
52        echo "        これは、ノードが「empty」な状態であることに相当します。\n";
53    }
54    echo "\n";
55
56    // --- シナリオ2: 新しいテキストノードを作成し、既存ノードとの同一性を確認 ---
57    // ここでは、DOMツリーには追加されていない、まったく新しいテキストノードを作成します。
58    
59    $newTextNode = $dom->createTextNode('新しい異なるテキスト');
60
61    echo "シナリオ2: 新しい（未追加の）ノードを作成して比較\n";
62    echo "  元のノード (\$originalTextNode) と、新たに作成したノード (\$newTextNode) が同一か？\n";
63    
64    // $originalTextNode はすでに存在（isnotempty）しているので、
65    // 新しく作成された $newTextNode との同一性のみをチェックします。
66    // 新しく作成されたノードは、既存のノードとは異なるオブジェクトです。
67    if ($originalTextNode->isSameNode($newTextNode)) {
68        echo "  結果: [失敗] 新しいノードが元のノードと同一と判断されました（これは通常予期されません）。\n";
69    } else {
70        echo "  結果: [成功] 新しいノードは、元のノードとは異なるオブジェクトです。\n";
71    }
72    echo "\n";
73
74    // --- シナリオ3: 別のDOMDocumentで作成されたノードとの同一性を確認 ---
75    // DOMノードは作成されたDOMDocumentに属しており、異なるDOMDocumentのノードとは同一にはなりません。
76    
77    $anotherDom = new DOMDocument();
78    $textNodeFromAnotherDom = $anotherDom->createTextNode('別のドキュメントのテキスト');
79
80    echo "シナリオ3: 別のDOMDocumentで作成されたノードと比較\n";
81    echo "  元のノード (\$originalTextNode) と、別のDOMDocumentで作成されたノード (\$textNodeFromAnotherDom) が同一か？\n";
82    
83    // 同様に、両方のノードが存在（isnotempty）することを前提に、同一性をチェックします。
84    // 別のDOMDocumentで作成されたノードは、元のDOMDocumentのノードとは同一ではありません。
85    if ($originalTextNode->isSameNode($textNodeFromAnotherDom)) {
86        echo "  結果: [失敗] 別のDOMDocumentのノードが元のノードと同一と判断されました（これは予期されません）。\n";
87    } else {
88        echo "  結果: [成功] 別のDOMDocumentのノードは、元のノードとは異なるオブジェクトです。\n";
89    }
90}
91
92// 上記で定義したデモンストレーション関数を実行します。
93demonstrateDomNodeIdentityAndExistence();
94

PHPのDOMText::isSameNodeメソッドは、二つのDOMノードがメモリ上で同じオブジェクトであるかを判定します。引数に比較対象のDOMNode $otherNodeを指定し、同一であればtrue、そうでなければfalseをブール値で返します。

このメソッドは、ノードの内容が同じかどうかではなく、インスタンスそのものが同一であるかを厳密に確認します。例えば、DOMツリーから取得した同じノードへの複数の参照はtrueと判定されますが、テキスト内容が同じでも新たに作成されたノードや異なるDOMDocumentで生成されたノードはfalseと判定されます。

システムエンジニアを目指す初心者にとって、「php isnotempty」の概念は重要です。isSameNodeを利用する前に、比較対象のノードがnullではないか、また適切なDOMText型であるかを確認することで、予期せぬエラーを防ぎ、より安全にノードの存在と同一性を検証できます。

Copy
1<?php
2
3/**
4 * DOMText::isSameNode メソッドの使用例を示します。
5 *
6 * このメソッドは、2つのDOMNodeオブジェクトがDOMツリー上またはメモリ上で
7 * 物理的に同じインスタンスを指しているかを確認します。
8 * 内容が同じでも、異なるインスタンスであれば false を返します。
9 */
10function demonstrateDomTextIsSameNode(): void
11{
12    echo "DOMText::isSameNode メソッドのデモンストレーション:\n\n";
13
14    // 1. 新しいDOMドキュメントを作成します。
15    $doc = new DOMDocument();
16
17    // 2. ルート要素を作成し、ドキュメントに追加します。
18    $element = $doc->createElement('example');
19    $doc->appendChild($element);
20
21    // 3. 最初のDOMTextノードを作成し、要素に追加します。
22    $textNode1 = $doc->createTextNode('Hello, World!');
23    $element->appendChild($textNode1);
24    echo "最初のテキストノード (\$textNode1): '{$textNode1->nodeValue}' を作成しました。\n";
25
26    // 4. $textNode1 と同じインスタンスを参照する別の変数を作成します。
27    $textNodeSameInstance = $textNode1;
28    echo "\$textNode1 と同じインスタンスを参照する変数 (\$textNodeSameInstance) を作成しました。\n";
29
30    // 5. $textNode1 と $textNodeSameInstance を比較します。
31    //    これらは同じオブジェクトインスタンスなので、isSameNode は true を返します。
32    $isSame = $textNode1->isSameNode($textNodeSameInstance);
33    echo "  \$textNode1 と \$textNodeSameInstance は同じノードですか？ " . ($isSame ? "はい" : "いいえ") . "\n"; // 期待: はい
34
35    // 6. 内容は同じですが、新しいDOMTextノードを作成し、要素に追加します。
36    //    これは$textNode1とは異なるオブジェクトインスタンスです。
37    $textNode2 = $doc->createTextNode('Hello, World!');
38    $element->appendChild($textNode2);
39    echo "2番目のテキストノード (\$textNode2): '{$textNode2->nodeValue}' (内容は\$textNode1と同じ) を作成しました。\n";
40
41    // 7. $textNode1 と $textNode2 を比較します。
42    //    内容は同じでも異なるオブジェクトインスタンスなので、isSameNode は false を返します。
43    $isSame = $textNode1->isSameNode($textNode2);
44    echo "  \$textNode1 と \$textNode2 は同じノードですか？ " . ($isSame ? "はい" : "いいえ") . "\n"; // 期待: いいえ
45
46    // 8. DOMTextノードとDOMElementノードを比較します。
47    //    ノードの種類が異なり、インスタンスも異なるため、false を返します。
48    $isSame = $textNode1->isSameNode($element);
49    echo "  \$textNode1 と要素ノード (\$element) は同じノードですか？ " . ($isSame ? "はい" : "いいえ") . "\n"; // 期待: いいえ
50}
51
52// 関数を実行してデモンストレーションを開始します。
53demonstrateDomTextIsSameNode();
54

PHP 8で提供されるDOMText::isSameNodeメソッドは、二つのDOMノードがDOMツリー上またはメモリ上で物理的に同じインスタンスであるかどうかを厳密に比較するために使用されます。このメソッドは、引数として比較したい別のDOMNodeオブジェクト（$otherNode）を受け取ります。そして、二つのノードが全く同じオブジェクトインスタンスを指している場合にtrueを、そうでない場合にfalseを真偽値（bool）として返します。

例えば、あるテキストノードを指す変数を別の変数に代入した場合、両方の変数は同じインスタンスを参照するためisSameNodeはtrueを返します。しかし、内容が全く同じであっても、新しくテキストノードを作成した場合は、元のノードとは異なるインスタンスとなるため、isSameNodeはfalseを返します。これは、ノードの値が同じであるかどうかではなく、ノードそのものがメモリー上で同一であるかを判定する点で、値の比較とは異なります。また、テキストノードと要素ノードのように種類が異なるノードの場合も、物理的に同じインスタンスではないためfalseが返されます。