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

Copy
1<?php
2
3// Dom\Comment::isSameNode メソッドの使用例
4// このメソッドは、2つのDOMノードが同じオブジェクトであるかをチェックします。
5// 引数として Dom\Node または null を受け取り、bool を返します。
6
7// 1. 新しい Dom\Document を作成します。Dom\Comment ノードを作成するために必要です。
8$dom = new Dom\Document();
9
10// 2. 複数の Dom\Comment ノードを作成します。
11$comment1 = $dom->createComment('最初のコメント');
12$comment2 = $dom->createComment('2番目のコメント');
13
14// 3. 最初のコメントノードと同じオブジェクトを参照する変数を作成します。
15$sameComment1 = $comment1;
16
17// 4. 他の種類のノードも作成し、比較対象とします。
18$element = $dom->createElement('div');
19
20echo "--- Dom\\Comment::isSameNode の基本使用例 ---\n";
21
22// シナリオ1: 同じオブジェクトを参照するノードを比較する
23// 結果: true (両者がまったく同じオブジェクトであるため)
24echo "comment1 と sameComment1 を比較: ";
25var_dump($comment1->isSameNode($sameComment1));
26
27// シナリオ2: 異なるオブジェクトのコメントノードを比較する
28// 結果: false (内容は似ていても異なるオブジェクトであるため)
29echo "comment1 と comment2 を比較: ";
30var_dump($comment1->isSameNode($comment2));
31
32// シナリオ3: コメントノードと異なる種類のノードを比較する
33// 結果: false (種類が異なるオブジェクトであるため)
34echo "comment1 と element を比較: ";
35var_dump($comment1->isSameNode($element));
36
37// シナリオ4: 比較対象が null の場合
38// isSameNode メソッドは、引数に null が渡されると false を返します。
39// これは「比較するノードが存在しない」状態と解釈できます。
40echo "comment1 と null を比較: ";
41var_dump($comment1->isSameNode(null));
42
43echo "\n--- 'php isnotempty' の概念を考慮した使用例 ---\n";
44// キーワード「php isnotempty」は、変数が空でないか（null でないか、など）を確認する状況を指します。
45// isSameNode メソッドは引数として Dom\Node|null を取るため、
46// 比較対象が有効なノード（null でない）であることを確認してから呼び出すことが、
47// この「isnotempty」の概念と関連します。
48
49$potentialNode = $comment2; // 有効な Dom\Node オブジェクト
50$nullNode = null;           // null 値
51
52// potentialNode が null でない（is not empty）場合のみ比較を実行
53echo "有効なノード (\$potentialNode) の場合:\n";
54if ($potentialNode !== null) {
55    echo "  comment1 と potentialNode を比較: ";
56    var_dump($comment1->isSameNode($potentialNode));
57} else {
58    echo "  potentialNode は null です。比較をスキップしました。\n";
59}
60
61// nullNode が null でない（is not empty）場合のみ比較を実行
62echo "null のノード (\$nullNode) の場合:\n";
63if ($nullNode !== null) { // このブロックは実行されません
64    echo "  comment1 と nullNode を比較: ";
65    var_dump($comment1->isSameNode($nullNode));
66} else {
67    echo "  nullNode は null です。比較をスキップしました。\n";
68}

PHP 8のDom\Comment::isSameNodeメソッドは、二つのDOMノードが「まったく同じオブジェクト」であるかを確認するために使用されます。このメソッドは、比較したい別のノード（Dom\Nodeオブジェクト）またはnullを引数として受け取り、結果を真偽値（bool）で返します。

具体的には、二つのノードがメモリー上で同じ実体（同じオブジェクト）を指している場合にのみtrueを返し、そうでなければfalseとなります。たとえ内容が同じコメントノードであっても、それぞれが別々に作成されたオブジェクトであればfalseです。また、コメントノードと要素ノードのようにノードの種類が異なる場合もfalseを返します。引数にnullが渡された場合もfalseとなり、これは「比較する相手が存在しない」という状態を示します。

キーワード「php isnotempty」との関連では、isSameNodeはnullを引数に取れるため、呼び出し前に比較対象がnullではない有効なDom\Nodeオブジェクトであることを確認すると、より安全で確実なコードになります。

Copy
1<?php
2
3// Dom\Comment::isSameNode メソッドの使用例
4// このメソッドは、現在のノードが引数で渡されたノードと同じノードであるかどうかをチェックします。
5
6// 1. DOMDocumentを作成し、コメントノードを扱うための準備をします。
7$dom = new DOMDocument();
8
9// 2. 最初のコメントノードを作成し、DOMツリーに追加します。
10//    createComment() は Dom\Comment クラスのインスタンス (実際には DOMComment クラス) を返します。
11$comment1 = $dom->createComment('これは最初のコメントです。');
12$dom->appendChild($comment1);
13
14// 3. 2番目のコメントノードを作成し、DOMツリーに追加します。
15//    これは comment1 とは異なるオブジェクトですが、内容が似ているかもしれません。
16$comment2 = $dom->createComment('これは2番目のコメントです。');
17$dom->appendChild($comment2);
18
19echo "--- Dom\\Comment::isSameNode の使用例 ---\n";
20
21// 4. comment1 が自分自身 (comment1) と同じノードか確認します。
22//    期待される結果: true (同じオブジェクトなので)
23echo "comment1 は comment1 と同じノードですか？: ";
24if ($comment1->isSameNode($comment1)) {
25    echo "true\n";
26} else {
27    echo "false\n";
28}
29
30// 5. comment1 が comment2 と同じノードか確認します。
31//    期待される結果: false (異なるオブジェクトなので)
32echo "comment1 は comment2 と同じノードですか？: ";
33if ($comment1->isSameNode($comment2)) {
34    echo "true\n";
35} else {
36    echo "false\n";
37}
38
39// 6. comment1 が null と同じノードか確認します。
40//    isSameNode の引数には null も指定できます。
41//    期待される結果: false (null はどのノードとも同じではありません)
42echo "comment1 は null と同じノードですか？: ";
43if ($comment1->isSameNode(null)) {
44    echo "true\n";
45} else {
46    echo "false\n";
47}
48
49?>

Dom\Comment::isSameNodeメソッドは、PHPでXMLやHTMLなどのDOM (Document Object Model) を扱う際に、現在のコメントノードが引数で渡されたノードと「物理的に同じオブジェクト」であるかを判定するために使用されます。

このメソッドは、比較対象となるDom\Node型のノード、またはnullを引数$otherNodeとして受け取ります。現在のノードが引数$otherNodeと全く同じオブジェクトであればtrueを返し、そうでなければfalseを戻り値として返します。これはノードの内容が同じかどうかではなく、メモリ上の同じ実体を指しているかどうかを確認するものです。

サンプルコードでは、まずDOMDocumentを使って文書を作成し、createCommentで二つのコメントノード$comment1と$comment2を作成しています。$comment1->isSameNode($comment1)のように自分自身と比較した場合は、同じオブジェクトであるためtrueが出力されます。しかし、$comment1->isSameNode($comment2)のように、異なるコメントノードを比較すると、たとえ内容が似ていても別々のオブジェクトであるためfalseが出力されます。また、引数にnullを渡した場合も、どのノードもnullとは同じではないためfalseが返されます。このメソッドは、ノードの値の等価性ではなく、オブジェクトの同一性を厳密に確認したい場合に活用されます。