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

Copy
1<?php
2
3/**
4 * DOMCdataSection::isSameNode() メソッドの動作を示すサンプルコードです。
5 *
6 * このメソッドは、2つのDOMノードが「同じオブジェクトインスタンス」を指しているかどうかを判定します。
7 * ノードの内容が同じかどうかではなく、オブジェクト参照の同一性を確認する際に使用します。
8 * システムエンジニアを目指す方にとって、DOM操作におけるノードの同一性判断は重要な概念です。
9 *
10 * @return void
11 */
12function demonstrateCdataSectionIsSameNode(): void
13{
14    // 1. DOMDocumentを新規作成し、XMLデータをロードします。
15    //    CDATAセクションを含む基本的なXML構造を用意します。
16    $dom = new DOMDocument();
17    // loadXML()は成功するとtrueを返しますが、エラーチェックは省略します。
18    $dom->loadXML(
19        '<root>' .
20        '  <item1><![CDATA[これは最初のCDATAセクションです。]]></item1>' .
21        '  <item2><![CDATA[これは最初のCDATAセクションです。]]></item2>' . // item1と内容が同じ
22        '  <item3><![CDATA[これは異なるCDATAセクションです。]]></item3>' .
23        '</root>'
24    );
25    // 出力を整形するためにformatOutputをtrueに設定しますが、機能には影響しません。
26    $dom->formatOutput = true;
27
28    // 2. 最初のCDATAセクションノードを取得します。
29    //    getElementsByTagName('item1')はDOMNodeListを返すため、item(0)で最初の要素を取得し、
30    //    そのfirstChild（子ノード）がCDATAセクションになります。
31    $cdataNode1 = $dom->getElementsByTagName('item1')->item(0)->firstChild;
32
33    // 3. $cdataNode1 と「全く同じインスタンス」を参照する変数を宣言します。
34    //    $cdataNode1Refは$cdataNode1と同じオブジェクトを指します。
35    $cdataNode1Ref = $cdataNode1;
36
37    // 4. 内容は$cdataNode1と同じですが、「異なるインスタンス」のCDATAセクションノードを取得します。
38    //    $cdataNode2はitem2の子ノードであり、item1の子ノードとは別のインスタンスです。
39    $cdataNode2 = $dom->getElementsByTagName('item2')->item(0)->firstChild;
40
41    // 5. 内容も異なるCDATAセクションノードを取得します。
42    $cdataNode3 = $dom->getElementsByTagName('item3')->item(0)->firstChild;
43
44    echo "--- DOMCdataSection::isSameNode() メソッドのデモンストレーション ---\n\n";
45
46    // --- テストケース1: 同じオブジェクトインスタンスへの参照と比較 ---
47    // $cdataNode1 と $cdataNode1Ref は、メモリ上で全く同じオブジェクトを指しています。
48    // 期待値: true
49    echo "ケース1: \$cdataNode1 と \$cdataNode1Ref は同じノードインスタンスですか？\n";
50    $isSameResult1 = $cdataNode1->isSameNode($cdataNode1Ref);
51    var_dump($isSameResult1);
52    echo "  -> 期待値: true (同じオブジェクトインスタンスを参照しているため)\n\n";
53
54    // --- テストケース2: 内容は同じだが、異なるオブジェクトインスタンスと比較 ---
55    // $cdataNode1 と $cdataNode2 は内容が同じですが、XMLツリー上の異なる場所にあるため、
56    // それぞれが異なるオブジェクトインスタンスとして扱われます。
57    // 期待値: false
58    echo "ケース2: \$cdataNode1 と \$cdataNode2 (内容は同じだが別のインスタンス) は同じノードインスタンスですか？\n";
59    $isSameResult2 = $cdataNode1->isSameNode($cdataNode2);
60    var_dump($isSameResult2);
61    echo "  -> 期待値: false (異なるオブジェクトインスタンスなので)\n\n";
62
63    // --- テストケース3: 内容も異なるCDATAセクションと比較 ---
64    // $cdataNode1 と $cdataNode3 は、内容も異なり、当然ながら異なるオブジェクトインスタンスです。
65    // 期待値: false
66    echo "ケース3: \$cdataNode1 と \$cdataNode3 (内容も異なる別のインスタンス) は同じノードインスタンスですか？\n";
67    $isSameResult3 = $cdataNode1->isSameNode($cdataNode3);
68    var_dump($isSameResult3);
69    echo "  -> 期待値: false (異なるオブジェクトインスタンスなので)\n\n";
70
71    echo "--- 補足 ---\n";
72    echo "isSameNode() は、ノードの「内容」ではなく、ノードオブジェクトがメモリ上で「同じインスタンス」であるかを確認します。\n";
73    echo "例えば、オブジェクトがNULLでないことを確認したい場合は `!is_null($node)` を使用します。\n";
74    echo "また、ノードが空でないことを確認したい場合は `!empty($node->nodeValue)` などを使用します。\n";
75}
76
77// 関数を実行して、DOMCdataSection::isSameNode() のデモンストレーションを開始します。
78demonstrateCdataSectionIsSameNode();
79
80?>

PHPのDOMCdataSection::isSameNode()メソッドは、XMLやHTMLのDOM（Document Object Model）を操作する際に、二つのノードがメモリ上で「全く同じオブジェクトインスタンス」を指しているかどうかを判定するために使用されます。システムエンジニアを目指す方にとって、DOMツリー内のノードの同一性を正確に判断することは、複雑なデータ構造を扱う上で重要な概念です。

このメソッドはDOMNode $otherNodeという引数を受け取ります。これは比較対象となる別のDOMノードを指します。戻り値はbool型で、比較対象のノードと呼び出し元のノードがメモリ上で同じオブジェクトインスタンスであればtrueを、そうでなければfalseを返します。

サンプルコードでは、CDATAセクションの内容が完全に同じであっても、それらが異なるXML要素から取得されたノードであれば、isSameNode()はfalseを返すことが示されています。これは、isSameNode()がノードの「内容」ではなく、メモリ上での「オブジェクト参照の同一性」を確認しているためです。同じノードを指す変数同士を比較した場合にのみtrueとなります。

補足として、isSameNode()はノードが存在するかどうかや、ノードが空でないかを確認するものではありません。例えば、ノードが空ではないことを確認したい場合は、!empty($node->nodeValue)のようにノードのnodeValueプロパティを評価する方法が一般的です。

Copy
1<?php
2
3/**
4 * DOMCdataSection::isSameNode メソッドの使用例を示します。
5 *
6 * このメソッドは、2つのノードがメモリ上で同じオブジェクトであるかどうかを
7 * 厳密に比較し、その同一性を判定します。ノードの値や構造が同じかどうかではなく、
8 * オブジェクトそのものが同じインスタンスであるかをチェックします。
9 */
10function demonstrateCdataSectionIsSameNode(): void
11{
12    // 1. 新しいDOMDocumentを作成します。
13    $dom = new DOMDocument('1.0', 'UTF-8');
14    $dom->formatOutput = true; // 出力整形を有効にします
15
16    // ルート要素を追加します。
17    $root = $dom->createElement('root');
18    $dom->appendChild($root);
19
20    // CDATAセクションを含む要素を作成します。
21    $dataElement = $dom->createElement('data');
22    $root->appendChild($dataElement);
23
24    // 2. 最初のDOMCdataSectionオブジェクトを作成し、ドキュメントに追加します。
25    $cdataNode1 = $dom->createCDATASection('これは最初のCDATAセクションです。');
26    $dataElement->appendChild($cdataNode1);
27
28    echo "--- ケース 1: 同じオブジェクトを参照する場合 ---\n";
29    // 3. $cdataNode1 と全く同じオブジェクトを参照する別の変数を作成します。
30    $cdataNode1Ref = $cdataNode1;
31
32    // isSameNode() メソッドを使って比較します。
33    // 同じオブジェクトを参照しているため、true を返します。
34    if ($cdataNode1->isSameNode($cdataNode1Ref)) {
35        echo "cdataNode1 と cdataNode1Ref は同じノードです。\n";
36    } else {
37        echo "cdataNode1 と cdataNode1Ref は異なるノードです。\n";
38    }
39
40    echo "\n--- ケース 2: 内容が同じでも、異なるオブジェクトの場合 ---\n";
41    // 4. 内容は同じですが、新しく作成された別のDOMCdataSectionオブジェクトです。
42    $cdataNode2 = $dom->createCDATASection('これは最初のCDATAセクションです。');
43    $dataElement->appendChild($cdataNode2); // ドキュメントに追加しても、結果には影響しません
44
45    // isSameNode() メソッドを使って比較します。
46    // 内容は同じでも、異なるオブジェクトなので false を返します。
47    if ($cdataNode1->isSameNode($cdataNode2)) {
48        echo "cdataNode1 と cdataNode2 は同じノードです。\n";
49    } else {
50        echo "cdataNode1 と cdataNode2 は異なるノードです。\n";
51    }
52
53    echo "\n--- ケース 3: 異なる種類のノードと比較する場合 (DOMText) ---\n";
54    // 5. 別の種類のノード (DOMText) を作成します。
55    $textNode = $dom->createTextNode('これは通常のテキストノードです。');
56    $dataElement->appendChild($textNode);
57
58    // isSameNode() メソッドを使って比較します。
59    // 型が異なるため、false を返します。
60    if ($cdataNode1->isSameNode($textNode)) {
61        echo "cdataNode1 と textNode は同じノードです。\n";
62    } else {
63        echo "cdataNode1 と textNode は異なるノードです。\n";
64    }
65
66    echo "\n--- ドキュメントの現在のXML出力 (参考) ---\n";
67    echo $dom->saveXML();
68}
69
70// 上記のデモンストレーション関数を実行します。
71demonstrateCdataSectionIsSameNode();

PHPのDOMCdataSection::isSameNodeメソッドは、DOMツリー内の2つのノードがメモリ上で全く同じオブジェクトインスタンスを指しているかどうかを判定します。このメソッドは、引数として比較したい別のノード（DOMNode型）を受け取り、両者が同じオブジェクトであればtrueを、そうでなければfalseをブール値で返します。

このメソッドの重要な点は、ノードの「内容」や「構造」が同じかどうかではなく、「オブジェクトそのもの」が同一であるかを厳密にチェックする点です。

サンプルコードでは、この挙動を具体的に示しています。 まず、DOMCdataSectionオブジェクトを作成し、それを$cdataNode1とします。

1. 同じオブジェクトを参照する場合: $cdataNode1を別の変数$cdataNode1Refに代入すると、両方の変数はメモリ上の同じオブジェクトを指します。このため、$cdataNode1->isSameNode($cdataNode1Ref)はtrueを返します。
2. 内容が同じでも異なるオブジェクトの場合: $cdataNode1と全く同じ内容で新しいDOMCdataSectionオブジェクト$cdataNode2を作成します。これらは内容こそ同じですが、メモリ上では別々のオブジェクトであるため、$cdataNode1->isSameNode($cdataNode2)はfalseを返します。
3. 異なる種類のノードと比較する場合: DOMCdataSectionとは異なる種類のノードであるDOMTextオブジェクトと比較すると、型が異なるため、やはり$cdataNode1->isSameNode($textNode)はfalseを返します。

このように、isSameNodeメソッドは、DOMオブジェクトの同一性を厳密に確認したい場合に利用されるメソッドです。