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

Copy
1<?php
2
3/**
4 * DOMノードの同一性を比較するサンプルコード。
5 *
6 * DOMNode::isSameNode メソッドを使用して、2つのノードがDOMツリー内で
7 * 物理的に同じオブジェクトであるかを確認します。
8 * DOMNotation クラスは DOMNode を継承しているため、
9 * その挙動は DOMNode の他のサブクラス (例: DOMElement) と同じです。
10 *
11 * キーワード "isnotempty" との関連性について：
12 * isSameNode が true を返す場合、それは比較対象のノードが'存在する'、
13 * つまり'空ではない'ノードであり、かつ、参照しているノードと
14 * 同じ実体を持つことを意味します。これにより、特定のノードが
15 * DOMツリー内で有効な存在として認識できるかを確認する際に役立ちます。
16 */
17function demonstrateIsSameNode(): void
18{
19    // 1. DOMDocument オブジェクトを作成
20    // XML文書全体を扱うためのコンテナです。
21    $dom = new DOMDocument('1.0', 'UTF-8');
22    $dom->formatOutput = true; // 出力されるXMLを見やすくするための設定
23
24    // 2. 複数の DOMElement ノードを作成
25    // これらのノードはまだDOMツリーには追加されていません。
26    $nodeA = $dom->createElement('exampleNode', 'Hello');
27    $nodeB = $dom->createElement('anotherNode', 'World');
28
29    // 3. 一つのノードを別の変数に代入し、同じオブジェクトを参照させる
30    // $nodeC は $nodeA と全く同じインスタンスを指します。
31    $nodeC = $nodeA;
32
33    // 4. DOMツリーにノードを追加 (isSameNode の動作には必須ではありませんが、実際のDOM操作を模倣します)
34    $dom->appendChild($nodeA); // $nodeA をDOMツリーに追加
35    $dom->appendChild($nodeB); // $nodeB をDOMツリーに追加
36
37    echo "--- DOMNode::isSameNode() メソッドのデモンストレーション ---\n";
38
39    // --- ケース1: 同じオブジェクトを参照しているノードの比較 ---
40    echo "\n[ケース1] \$nodeA と \$nodeC の比較 (同じオブジェクト参照)\n";
41    echo "  \$nodeC = \$nodeA; としているため、これらは同じ実体のノードです。\n";
42    if ($nodeA->isSameNode($nodeC)) {
43        echo "  結果: true - \$nodeA と \$nodeC は同じノードです。\n";
44        echo "  補足: これは、ノードが存在し、かつ同一であることを示します。\n";
45    } else {
46        echo "  結果: false - \$nodeA と \$nodeC は異なるノードです。\n";
47    }
48
49    // --- ケース2: 異なるオブジェクトだが同じ内容のノードの比較 ---
50    // $nodeD は $nodeA と同じタグ名と内容ですが、新しい独立したインスタンスです。
51    $nodeD = $dom->createElement('exampleNode', 'Hello');
52    echo "\n[ケース2] \$nodeA と \$nodeD の比較 (異なるオブジェクト、同じタグ名と内容)\n";
53    echo "  \$nodeD は \$nodeA とは別に新しく作成されたノードです。\n";
54    if ($nodeA->isSameNode($nodeD)) {
55        echo "  結果: true - \$nodeA と \$nodeD は同じノードです。\n";
56    } else {
57        echo "  結果: false - \$nodeA と \$nodeD は異なるノードです。\n";
58        echo "  補足: 内容が同じでも、異なるオブジェクトインスタンスなので、異なるノードとして認識されます。\n";
59    }
60
61    // --- ケース3: 異なるオブジェクトを参照しているノードの比較 ---
62    echo "\n[ケース3] \$nodeA と \$nodeB の比較 (異なるオブジェクト参照)\n";
63    echo "  \$nodeA と \$nodeB はそれぞれ異なる目的で作成されたノードです。\n";
64    if ($nodeA->isSameNode($nodeB)) {
65        echo "  結果: true - \$nodeA と \$nodeB は同じノードです。\n";
66    } else {
67        echo "  結果: false - \$nodeA と \$nodeB は異なるノードです。\n";
68        echo "  補足: 異なるオブジェクトを参照しているため、異なるノードとして認識されます。\n";
69    }
70}
71
72// サンプル関数を実行します。
73demonstrateIsSameNode();

PHPのDOMNotation::isSameNodeメソッドは、DOMツリー内の二つのノードが物理的に同じオブジェクトインスタンスであるかを確認するために使用されます。このメソッドは、比較したい別のDOMノードをDOMNode $otherNodeとして引数に受け取り、もし両方のノードがメモリ上で全く同じ実体を指していればtrueを、そうでなければfalseをbool型で返します。

単にノードの内容や属性、タグ名が同じであっても、それぞれが異なるタイミングで新しく作成された独立したオブジェクトであれば、このメソッドはfalseを返します。例えば、あるノードを別の変数に代入して参照を共有させた場合にのみ、それらは同じノードとして認識されtrueとなります。

キーワード「php isnotempty」との関連性では、isSameNodeがtrueを返す場合、それは比較対象のノードがDOMツリー内で有効に「存在する」（つまり空ではない）ノードであり、かつ基準となるノードと完全に同一の実体を持つことを意味します。これにより、特定のノードがDOMツリー内で有効な存在として認識でき、さらにその同一性を厳密に確認する際に役立ちます。DOMNotationクラスはDOMNodeを継承しているため、DOMElementなどの他のサブクラスでも同様の挙動を示します。

Copy
1<?php
2
3/**
4 * DOMNotation::isSameNode の使用例。
5 *
6 * このコードは、2つのDOMNodeオブジェクトがDOMツリー内の全く同じノードを参照しているかどうかを
7 * 判定する DOMNotation::isSameNode メソッドの動作を示します。
8 * DOMNotation ノードは、NOTATION 宣言を含む XML DOCTYPE をパースすることによって取得されます。
9 *
10 * システムエンジニアを目指す初心者向けに、各ステップと期待される結果をコメントで説明しています。
11 */
12
13// 新しい DOMDocument インスタンスを作成します。
14$dom = new DOMDocument('1.0', 'UTF-8');
15// 整形された出力のためにホワイトスペースを保持せず、出力も整形します。
16$dom->preserveWhiteSpace = false;
17$dom->formatOutput = true;
18
19// NOTATION 宣言を含む DOCTYPE を持つXML文字列を定義します。
20// DOMNotation ノードは、通常このようなDTDをパースすることによって作成・アクセスされます。
21$xmlString = <<<XML
22<?xml version="1.0" encoding="UTF-8"?>
23<!DOCTYPE root [
24  <!NOTATION image-format SYSTEM "http://example.com/formats/image.dtd">
25  <!ELEMENT root EMPTY>
26  <!ATTLIST root
27    img-type NOTATION (image-format) #REQUIRED>
28]>
29<root img-type="image-format"/>
30XML;
31
32// XML文字列を DOMDocument に読み込みます。
33$dom->loadXML($xmlString);
34
35// ドキュメントから DOCTYPE ノードを取得します。
36$doctype = $dom->doctype;
37
38// DOCTYPE が存在し、notation (表記) が含まれているかを確認します。
39if ($doctype && $doctype->notations->length > 0) {
40    // 'image-format' という名前の DOMNotation ノードを取得します。これが最初の DOMNotation オブジェクトです。
41    $notation1 = $doctype->notations->getNamedItem('image-format');
42
43    // 同じ 'image-format' notation ノードを再度取得します。
44    // これにより、同じ基になる DOMNotation ノードへの2番目の参照が得られます。
45    $notation2 = $doctype->notations->getNamedItem('image-format');
46
47    // 比較のために、異なる種類のノード (例: ルート要素) を取得します。
48    $rootElement = $dom->documentElement;
49
50    // 異なるノードタイプである属性ノードも取得します。
51    $attributeNode = $rootElement->getAttributeNode('img-type');
52
53    if ($notation1 instanceof DOMNotation) {
54        echo "DOMNotation::isSameNode のデモンストレーション:\n\n";
55
56        // テスト1: notation1 と notation2 を比較します。
57        // 期待される結果: true。両方の変数で同じノードオブジェクトを参照しているためです。
58        if ($notation1->isSameNode($notation2)) {
59            echo "テスト1: notation1 と notation2 は同じノードです。\n";
60        } else {
61            echo "テスト1: notation1 と notation2 は異なるノードです (予期せぬ結果)。\n";
62        }
63
64        // テスト2: notation1 とルート要素を比較します。
65        // 期待される結果: false。これらはDOMツリー内の異なるノードであるためです。
66        if ($notation1->isSameNode($rootElement)) {
67            echo "テスト2: notation1 と rootElement は同じノードです (予期せぬ結果)。\n";
68        } else {
69            echo "テスト2: notation1 と rootElement は異なるノードです。\n";
70        }
71
72        // テスト3: notation1 と属性ノードを比較します。
73        // 期待される結果: false。これらはDOMツリー内の異なるノードであるためです。
74        if ($attributeNode instanceof DOMNode && $notation1->isSameNode($attributeNode)) {
75            echo "テスト3: notation1 と attributeNode は同じノードです (予期せぬ結果)。\n";
76        } else {
77            echo "テスト3: notation1 と attributeNode は異なるノードです。\n";
78        }
79
80    } else {
81        echo "エラー: 'image-format' を DOMNotation インスタンスとして取得できませんでした。\n";
82    }
83} else {
84    echo "エラー: XML ドキュメントに DOCTYPE または notation が見つかりませんでした。\n";
85}
86
87?>

PHP 8のDOMNotationクラスに属するisSameNodeメソッドは、引数として与えられたDOMNodeオブジェクトが、メソッドを呼び出したDOMNotationオブジェクトとDOMツリー内で「全く同じノード」を参照しているかどうかを判定するために使用されます。

このメソッドは、比較対象となるDOMNodeオブジェクトを$otherNodeとして一つ受け取ります。戻り値は真偽値（bool）で、もし両方のオブジェクトがDOMツキュリー内の物理的に同一のノードインスタンスを指していればtrueを、そうでなければfalseを返します。ここでいう「同じノード」とは、ノードの内容や値が等しいことではなく、メモリ上およびDOMツリー上の同一性を意味します。

サンプルコードでは、XMLのDOCTYPE宣言から同じ名前のNOTATIONノードを二度取得し、それらを比較しています。この場合、両方の変数で同じノードインスタンスを参照しているため、isSameNodeメソッドはtrueを返します。一方で、DOMNotationノードと、XML文書内の異なるノードであるルート要素や属性ノードを比較した場合は、DOMツリー内の物理的な位置が異なるため、falseが返されることが確認できます。このメソッドは、DOM操作において特定のノードが同一であるかを厳密に判断する際に役立ちます。