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

Copy
1<?php
2
3/**
4 * Dom\CharacterData::isSameNode メソッドのサンプル
5 *
6 * このメソッドは、2つのノードが「同じオブジェクトインスタンス」であるかを判定します。
7 * ノードの内容が同じであっても、異なるオブジェクトであれば「同じノード」とは見なされません。
8 * 引数 `$otherNode` は null を許容します。
9 */
10function demonstrateIsSameNode(): void
11{
12    // 1. DOMDocumentを作成し、Dom\CharacterDataを継承するテキストノードを生成します。
13    //    Dom\CharacterDataは抽象クラスなので、Dom\Textのような具象クラスを使用します。
14    $dom = new Dom\Document();
15
16    // 最初のノードを作成
17    $nodeA = $dom->createTextNode("最初のテキストノード");
18
19    // 同じ内容を持つが、別のオブジェクトインスタンスであるノードを作成
20    $nodeB = $dom->createTextNode("最初のテキストノード");
21
22    // nodeA と同じオブジェクトインスタンスを参照する変数を作成
23    $nodeC = $nodeA;
24
25    echo "--- Dom\\CharacterData::isSameNode の基本的な使い方 ---\n";
26
27    // nodeA と nodeB の比較: 内容は同じですが、異なるオブジェクトインスタンスなので false
28    $isSame1 = $nodeA->isSameNode($nodeB);
29    echo "nodeA と nodeB は同じノードですか？ (異なるインスタンス): " . var_export($isSame1, true) . "\n"; // 結果: false
30
31    // nodeA と nodeC の比較: 同じオブジェクトインスタンスを参照しているので true
32    $isSame2 = $nodeA->isSameNode($nodeC);
33    echo "nodeA と nodeC は同じノードですか？ (同じインスタンス): " . var_export($isSame2, true) . "\n"; // 結果: true
34
35    echo "\n--- 引数が null の場合と 'php isnotempty' の考慮 ---\n";
36
37    // isSameNode メソッドは引数として null を受け入れます (?Dom\Node $otherNode)。
38    // null が渡された場合、どの有効なノードとも同じではないため、常に false を返します。
39    $isSameWithNull = $nodeA->isSameNode(null);
40    echo "nodeA と null は同じノードですか？ (常に false): " . var_export($isSameWithNull, true) . "\n"; // 結果: false
41
42    // キーワード 'php isnotempty' に関連して、
43    // 引数として渡される可能性のあるノードが本当に存在するか (null でないか) を
44    // 事前に確認する例を示します。これにより、予期せぬ挙動を防ぎ、コードの意図を明確にできます。
45    $possiblyNullNode = null; // null の可能性があるノード
46    $definitelyNode = $dom->createTextNode("別の有効なノード"); // 確実に有効なノード
47
48    echo "\n--- 'isnotempty' の考え方に基づく null チェックの例 ---\n";
49
50    // Case 1: $possiblyNullNode が null の場合
51    // instanceof Dom\Node を使って、変数が Dom\Node のインスタンスであり、かつ null でないことを確認します。
52    if ($possiblyNullNode instanceof Dom\Node) {
53        // このブロックは $possiblyNullNode が null のため実行されません
54        echo "nodeA と possiblyNullNode は同じノードですか？: " . var_export($nodeA->isSameNode($possiblyNullNode), true) . "\n";
55    } else {
56        echo "possiblyNullNode は有効な Dom\\Node ではありません (null です)。\n"; // 結果: possiblyNullNode は有効な Dom\Node ではありません (null です)。
57    }
58
59    // Case 2: $definitelyNode が有効な Dom\Node の場合
60    if ($definitelyNode instanceof Dom\Node) {
61        // $definitelyNode は有効なノードなので、isSameNode を安全に呼び出せます
62        $isSame3 = $nodeA->isSameNode($definitelyNode);
63        echo "nodeA と definitelyNode は同じノードですか？: " . var_export($isSame3, true) . "\n"; // 結果: false (異なるインスタンスなので)
64    } else {
65        // このブロックは $definitelyNode が有効なノードのため実行されません
66        echo "definitelyNode は有効な Dom\\Node ではありません。\n";
67    }
68}
69
70// 関数を実行して動作を確認します
71demonstrateIsSameNode();

Dom\CharacterData::isSameNodeメソッドは、PHPでXMLやHTMLなどのDOMツリーを操作する際に、二つのノードがメモリ上で「全く同じオブジェクトインスタンス」であるかを判定します。

このメソッドは、比較対象となる別のノードを引数として受け取ります。引数$otherNodeはDom\Node型のオブジェクト、またはnullを許容します。メソッドは判定結果を真偽値（bool）で返します。

具体的には、ノードAとノードBの内容が全く同じであったとしても、それぞれが別々に作成されたオブジェクトインスタンスであれば、isSameNodeはfalseを返します。しかし、ノードAと同じオブジェクトインスタンスをノードCが参照している場合、ノードAとノードCを比較するとtrueが返されます。

引数にnullが渡された場合、どの有効なノードとも同じオブジェクトではないため、isSameNodeは常にfalseを返します。

また、isSameNodeにノードを渡す前に、そのノードが実際に有効なDom\Nodeのインスタンスであるかを確認することは、堅牢なコードを書く上で重要です。例えばif ($possiblyNullNode instanceof Dom\Node)のようにチェックすることで、いわゆる「php isnotempty」の考え方に基づき、変数が有効なオブジェクトを保持していることを確認できます。これにより、意図しない挙動やエラーを防ぎ、コードの信頼性を高めることができます。

Copy
1<?php
2
3// DOMDocument クラスを使用して新しい DOM ドキュメントを作成します。
4// これにより、DOM ツリーのノードを操作できるようになります。
5$document = new DOMDocument();
6
7// Dom\CharacterData のサブクラスである Dom\Text ノードを作成します。
8// Dom\CharacterData::isSameNode メソッドは、Dom\Text オブジェクトで利用できます。
9$nodeA = $document->createTextNode('最初のテキストノード');
10
11// $nodeA と全く同じオブジェクトを参照する別の変数を作成します。
12// これは物理的に同じノードを指します。
13$nodeAReference = $nodeA;
14
15// 別の内容を持つ、全く異なる Dom\Text ノードを作成します。
16// これは物理的に異なるノードです。
17$nodeB = $document->createTextNode('異なるテキストノード');
18
19// 同じノードへの参照を比較します。
20// $nodeA と $nodeAReference はDOMツリー内で同じオブジェクトを指しているため、true を返します。
21$isSameResult1 = $nodeA->isSameNode($nodeAReference);
22echo "nodeA と nodeAReference は同じノードですか？ " . ($isSameResult1 ? 'はい' : 'いいえ') . "\n";
23
24// 異なるノードを比較します。
25// $nodeA と $nodeB はDOMツリー内で異なるオブジェクトを指しているため、false を返します。
26$isSameResult2 = $nodeA->isSameNode($nodeB);
27echo "nodeA と nodeB は同じノードですか？ " . ($isSameResult2 ? 'はい' : 'いいえ') . "\n";
28
29// null と比較します。
30// isSameNode メソッドは、比較対象が null の場合は常に false を返します。
31$isSameResult3 = $nodeA->isSameNode(null);
32echo "nodeA と null は同じノードですか？ " . ($isSameResult3 ? 'はい' : 'いいえ') . "\n";
33
34?>

PHP 8のDom\CharacterData::isSameNodeメソッドは、二つのDOMノードが物理的に同じオブジェクトであるかを判定するために使用されます。このメソッドは、Dom\CharacterDataクラス、またはそのサブクラス（例: Dom\Text）のオブジェクトから呼び出すことができます。

引数として?Dom\Node $otherNodeを取り、比較したい別のDOMノードを指定します。この引数はnullも受け入れます。戻り値はbool型で、呼び出し元のノードと引数で指定されたノードが完全に同じオブジェクトを指している場合にtrueを返し、それ以外の場合はfalseを返します。

サンプルコードでは、まずDom\Textノードを作成しています。 一つ目の例では、作成した$nodeAとそのノードを指す別の変数$nodeAReferenceを比較しています。これらは物理的に同じオブジェクトを指しているため、trueが返されます。 二つ目の例では、$nodeAと、内容が異なる別のDom\Textノード$nodeBを比較しています。これらは異なるオブジェクトであるため、falseが返されます。 三つ目の例では、$nodeAとnullを比較しています。isSameNodeメソッドは、比較対象がnullの場合には常にfalseを返します。

このように、isSameNodeメソッドはDOMツリーにおけるノードの同一性を厳密に確認する際に役立ちます。