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

Copy
1<?php
2
3/**
4 * Dom\CDATASection::isSameNode メソッドの使用例。
5 * この関数は、2つのDOMノードがメモリ上で同じオブジェクト（実体）を指しているかどうかを確認します。
6 * キーワード「php isnotempty」は、ノードが有効で存在するか（空ではないか）を確認したいという文脈で
7 * 使われることがありますが、isSameNodeメソッドは既に存在するノード同士の同一性を比較するものです。
8 * つまり、比較対象のノードは、isSameNodeメソッドが機能する前に「存在し、空ではない」状態であることが前提となります。
9 */
10function demonstrateCdataSectionIsSameNode(): void
11{
12    // 1. 新しいDOMドキュメントを作成します。
13    // このドキュメント内でDOMノードを作成、操作します。
14    $dom = new DOMDocument('1.0', 'UTF-8');
15
16    // 2. 最初のCDATAセクションノードを作成します。
17    // これで $cdata1 は「空ではない」有効なノードとなります。
18    $cdata1 = $dom->createCDATASection('これは最初のCDATAセクションです。');
19    echo "作成された最初の CDATA セクションの内容: " . $cdata1->nodeValue . "\n";
20
21    // 3. 別のCDATAセクションノードを作成します。
22    // これも $cdata2 は「空ではない」有効なノードです。
23    $cdata2 = $dom->createCDATASection('これは2番目のCDATAセクションです。');
24    echo "作成された2番目の CDATA セクションの内容: " . $cdata2->nodeValue . "\n\n";
25
26    // 4. 最初のノードへの参照を作成します。
27    // $cdata1Ref は $cdata1 と全く同じオブジェクトを指します。
28    $cdata1Ref = $cdata1;
29
30    // 5. isSameNode メソッドを使ってノードの同一性をチェックします。
31    // このメソッドは、ノードの「内容」ではなく、ノードが「同じ実体」であるかを判断します。
32
33    // $cdata1 と $cdata1Ref は同じオブジェクトですか？
34    // 期待される結果: true (同じ参照なので)
35    $isSame1 = $cdata1->isSameNode($cdata1Ref);
36    echo "cdata1 と cdata1Ref は同じノードですか？ " . ($isSame1 ? 'はい' : 'いいえ') . "\n";
37
38    // $cdata1 と $cdata2 は同じオブジェクトですか？
39    // 期待される結果: false (内容が同じかどうかにかかわらず、それぞれ独立したオブジェクトなので)
40    $isSame2 = $cdata1->isSameNode($cdata2);
41    echo "cdata1 と cdata2 は同じノードですか？ " . ($isSame2 ? 'はい' : 'いいえ') . "\n";
42
43    // 補足: 内容が同じでも、別々に作成されたノードはisSameNodeでは「異なる」と判断されます。
44    $cdata3 = $dom->createCDATASection('これは最初のCDATAセクションです。');
45    echo "\n内容が '{$cdata1->nodeValue}' と同じ新しいノード cdata3 を作成しました。\n";
46    $isSame3 = $cdata1->isSameNode($cdata3);
47    echo "cdata1 と cdata3 は同じノードですか？ " . ($isSame3 ? 'はい' : 'いいえ') . "\n";
48    echo "内容が同じでも、別のDOM操作で作成されたノードは異なる実体とみなされます。\n";
49}
50
51// 関数を実行します。
52demonstrateCdataSectionIsSameNode();

Dom\CDATASection::isSameNodeメソッドは、PHPのDOM操作において、2つのDOMノードがメモリ上で「全く同じオブジェクト（実体）」を指しているかどうかを判断するために使用されます。このメソッドは、引数として比較したい別のDom\Nodeオブジェクトを受け取り、もし両方のノードが同じ実体であればtrueを返し、異なる実体であればfalseを返します。

重要な点は、このメソッドがノードの「内容」が同じかどうかではなく、そのノードがプログラム内で「同じもの」として扱われているかを確認するという点です。例えば、内容が全く同じCDATAセクションを別々に作成した場合、それらはメモリ上では異なるオブジェクトとして扱われるため、isSameNodeはfalseを返します。一方で、あるCDATAセクションオブジェクトへの参照を別の変数にコピーした場合、両方の変数は同じ実体を指すため、isSameNodeはtrueを返します。

キーワードの「php isnotempty」は、通常、変数が存在し、空ではないことを確認する文脈で使われますが、isSameNodeメソッドは、比較対象となるノードが既に存在し、有効なオブジェクトであることを前提として動作します。このメソッドは、DOM操作中に特定のノードがすでに処理されたものか、あるいは特定の参照と一致するかどうかを効率的に確認する際に役立ちます。

Copy
1<?php
2
3/**
4 * Dom\CDATASection::isSameNode メソッドの動作を示すサンプルコード。
5 *
6 * isSameNode メソッドは、2つのノードがメモリ上で同じオブジェクトインスタンスであるかどうかをチェックします。
7 * ノードの内容が同じであっても、異なるインスタンスであれば false を返します。
8 */
9function demonstrateCdataSectionIsSameNode(): void
10{
11    // 1. 新しい Dom\Document インスタンスを作成します。
12    //    Dom\CDATASection ノードを作成するために必要です。
13    $document = new Dom\Document();
14
15    // 2. 最初の Dom\CDATASection ノードを作成します。
16    $cdataSection1 = $document->createCDATASection('これはCDATAセクションの内容です。');
17    echo "1. 最初の CDATA セクションを生成しました: '{$cdataSection1->data}'\n";
18
19    // 3. 最初の CDATA セクションと同じインスタンスを指す別の変数を宣言します。
20    $cdataSection1Ref = $cdataSection1;
21    echo "2. 最初の CDATA セクションを参照する別の変数を生成しました。\n";
22
23    // 4. cdataSection1 と cdataSection1Ref を isSameNode で比較します。
24    //    これらはメモリ上で同じオブジェクトインスタンスを参照しているため、true を返します。
25    if ($cdataSection1->isSameNode($cdataSection1Ref)) {
26        echo "3. cdataSection1 と cdataSection1Ref は同じインスタンスです (isSameNode: TRUE)。\n";
27    } else {
28        echo "3. cdataSection1 と cdataSection1Ref は異なるインスタンスです (isSameNode: FALSE)。\n";
29    }
30
31    echo "--------------------------------------------------\n";
32
33    // 5. 内容は同じですが、全く新しい Dom\CDATASection ノードを生成します。
34    $cdataSection2 = $document->createCDATASection('これはCDATAセクションの内容です。');
35    echo "4. 内容が同じですが、新しい CDATA セクションを生成しました: '{$cdataSection2->data}'\n";
36
37    // 6. cdataSection1 と cdataSection2 を isSameNode で比較します。
38    //    これらは内容が同じでも、異なるオブジェクトインスタンスであるため、false を返します。
39    if ($cdataSection1->isSameNode($cdataSection2)) {
40        echo "5. cdataSection1 と cdataSection2 は同じインスタンスです (isSameNode: TRUE)。\n";
41    } else {
42        echo "5. cdataSection1 と cdataSection2 は異なるインスタンスです (isSameNode: FALSE)。\n";
43    }
44
45    echo "--------------------------------------------------\n";
46
47    // 7. 異なる種類のノードと比較する場合の例 (Textノード)
48    $textNode = $document->createTextNode('これはテキストノードの内容です。');
49    echo "6. テキストノードを生成しました: '{$textNode->data}'\n";
50
51    // 8. Dom\CDATASection ノードと Dom\Text ノードを比較します。
52    //    これらは異なる種類のノードであり、異なるインスタンスであるため、false を返します。
53    if ($cdataSection1->isSameNode($textNode)) {
54        echo "7. cdataSection1 と textNode は同じインスタンスです (isSameNode: TRUE)。\n";
55    } else {
56        echo "7. cdataSection1 と textNode は異なるインスタンスです (isSameNode: FALSE)。\n";
57    }
58}
59
60// 上記のデモンストレーション関数を実行します。
61demonstrateCdataSectionIsSameNode();

PHPのDom\CDATASection::isSameNodeメソッドは、二つのDOMノードがメモリ上で全く同じオブジェクトであるか、つまり同一インスタンスであるかを判定します。引数$otherNodeには比較したい別のノードを指定し、戻り値は、同一インスタンスであればtrue、そうでなければfalseを示す真偽値です。

サンプルコードでは、最初に作成したCDATAセクションノード（$cdataSection1）と同じインスタンスを指す別の変数（$cdataSection1Ref）と比較しています。これらは同じメモリ上のオブジェクトを参照しているため、isSameNodeはtrueを返します。

次に、最初のノードと全く同じ内容を持つ新しいCDATAセクションノード（$cdataSection2）を作成し、$cdataSection1と比較します。内容が同じであっても、これらは別々に作成された異なるオブジェクトインスタンスであるため、isSameNodeはfalseを返します。

さらに、CDATAセクションノードとは異なる種類のノード、例えばテキストノードと比較した場合も、当然異なるインスタンスであるためfalseが返されます。このメソッドは、ノードの内容が等しいかどうかではなく、オブジェクトとしてメモリ上で完全に同一であるかを厳密にチェックする際に利用されます。