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

Copy
1<?php
2
3/**
4 * Dom\Notation::isSameNode() メソッドの使用例をデモンストレーションします。
5 *
6 * このメソッドは、2つのノードが同じオブジェクトを参照しているかどうかをチェックします。
7 * キーワード "php isnotempty" に関連付けて、比較結果が 'true' (つまりノードが同じで、
8 * nullではないという意味で「空ではない」) 場合の条件処理を示します。
9 */
10function demonstrateNotationComparison(): void
11{
12    // DTD (Document Type Definition) を含むXML文字列を定義します。
13    // Dom\Notation インスタンスは DTD 内の NOTATION 宣言から取得されます。
14    $xmlString = <<<XML
15<!DOCTYPE root [
16  <!NOTATION mygif SYSTEM "image/gif">
17  <!NOTATION myjpeg SYSTEM "image/jpeg">
18  <!ELEMENT root EMPTY>
19]>
20<root/>
21XML;
22
23    $dom = new DOMDocument();
24    // XML文字列を読み込みます。読み込みに失敗した場合は処理を中断します。
25    // 正しいXMLなので通常は成功しますが、エラーハンドリングは重要です。
26    if (!$dom->loadXML($xmlString)) {
27        echo "エラー: XMLの読み込みに失敗しました。XMLの構文を確認してください。\n";
28        return;
29    }
30
31    $notation1 = null;
32    $notation2 = null;
33    $notation3 = null; // $notation1 と同じノードを参照することを期待
34
35    // DOMDocument から DTD (Document Type Definition) を取得します。
36    $doctype = $dom->doctype;
37
38    // $doctype が DOMDocumentType のインスタンスであることを確認します。
39    if ($doctype instanceof DOMDocumentType) {
40        // DTD から NOTATION 宣言のマップを取得します。
41        $notations = $doctype->notations;
42        if ($notations->length > 0) {
43            // "mygif" という名前の Dom\Notation を取得します。
44            $notation1 = $notations->getNamedItem('mygif');
45            // "myjpeg" という名前の Dom\Notation を取得します。
46            $notation2 = $notations->getNamedItem('myjpeg');
47            // 再度 "mygif" という名前の Dom\Notation を取得します。
48            // これは $notation1 と同じオブジェクトを指すはずです。
49            $notation3 = $notations->getNamedItem('mygif');
50        }
51    }
52
53    echo "Dom\\Notation::isSameNode() の使用例:\n\n";
54
55    // 例1: 同じノードの比較
56    // $notation1 と $notation3 は同じ NOTATION 宣言を参照しているため、true が返されるはずです。
57    if ($notation1 instanceof Dom\Notation && $notation3 instanceof Dom\Notation) {
58        $isSame = $notation1->isSameNode($notation3);
59        echo "notation1 ('mygif') と notation3 ('mygif') は同じノードですか？ " . ($isSame ? "はい" : "いいえ") . "\n";
60
61        // isSameNode の結果が 'true' (ノードが同じ、つまり比較結果が空ではない) ならば、
62        // 特定の処理を実行します。
63        if ($isSame) {
64            echo "  -> 結果が真です。これらはメモリ上で同じ 'mygif' NOTATION 宣言を参照しています。\n";
65        } else {
66            echo "  -> 結果が偽です。これらは異なる NOTATION 宣言を指しています。\n";
67        }
68    } else {
69        echo "エラー: 'mygif' NOTATION の取得に失敗しました。XML DTDを確認してください。\n";
70    }
71
72    echo "\n";
73
74    // 例2: 異なるノードの比較
75    // $notation1 と $notation2 は異なる NOTATION 宣言を参照しているため、false が返されるはずです。
76    if ($notation1 instanceof Dom\Notation && $notation2 instanceof Dom\Notation) {
77        $isSame = $notation1->isSameNode($notation2);
78        echo "notation1 ('mygif') と notation2 ('myjpeg') は同じノードですか？ " . ($isSame ? "はい" : "いいえ") . "\n";
79
80        if (!$isSame) { // 結果が false (異なるノード) の場合の処理
81            echo "  -> 結果が偽です。これらはメモリ上で異なる NOTATION 宣言を指しています。\n";
82        } else {
83            echo "  -> 結果が真です。これらは同じ NOTATION 宣言を指しています。\n";
84        }
85    } else {
86        echo "エラー: 少なくとも一つの NOTATION の取得に失敗しました。XML DTDを確認してください。\n";
87    }
88
89    echo "\n";
90
91    // 例3: null との比較
92    // isSameNode() は、null との比較では常に false を返すはずです。
93    if ($notation1 instanceof Dom\Notation) {
94        $isSameWithNull = $notation1->isSameNode(null);
95        echo "notation1 ('mygif') は null と同じノードですか？ " . ($isSameWithNull ? "はい" : "いいえ") . "\n";
96
97        if (!$isSameWithNull) { // 結果が false (nullとは異なる) の場合の処理
98            echo "  -> 結果が偽です。ノードは null とは同じではありません。\n";
99        }
100    } else {
101        echo "エラー: 'mygif' NOTATION の取得に失敗しました。XML DTDを確認してください。\n";
102    }
103}
104
105// デモンストレーション関数を実行します。
106demonstrateNotationComparison();

PHPのDom\Notation::isSameNode()メソッドは、二つのDOMノードがメモリ上で同じオブジェクトであるかを確認するための機能です。引数$otherNodeには比較したい別のDom\Nodeオブジェクト、またはnullを指定します。このメソッドは、比較の結果を真偽値（bool）で返します。具体的には、引数と自身がメモリ上で同じオブジェクトを参照していればtrueを、異なっていればfalseを返します。特にnullと比較した場合は常にfalseとなります。

サンプルコードでは、XMLのDTD（Document Type Definition）から取得したDom\Notationオブジェクトを用いています。同じNOTATION宣言から取得されたオブジェクト同士はtrueと判定され、異なるNOTATION宣言のオブジェクトはfalseと判定される様子を示しています。このメソッドは、あるオブジェクトが「空ではない」（つまり、比較対象と同一の有効なオブジェクトである）という状態を明確に確認する際に役立ちます。キーワード「php isnotempty」と関連付けて、比較対象が同一かつ存在している場合の条件処理を実装するのに適しています。

Copy
1<?php
2
3/**
4 * Dom\Notation::isSameNode メソッドの使用例を示します。
5 *
6 * isSameNode メソッドは、2つの Dom\Node オブジェクトがDOMツリー内で同じノードであるかを確認します。
7 * これはPHPのオブジェクト比較演算子 (===) とは異なり、DOMツリー上の構造的な同一性を判断します。
8 * Dom\Notation は、XMLのDTDで定義される記法を表す特殊なノードです。
9 *
10 * @param void
11 * @return void
12 */
13function demonstrateDomNotationIsSameNode(): void
14{
15    echo "--- Dom\\Notation::isSameNode メソッドの使用例 ---\n\n";
16
17    // 1. DTDにNOTATIONを定義したXML文字列を準備します。
18    $xmlString = <<<XML
19<?xml version="1.0"?>
20<!DOCTYPE root [
21  <!NOTATION gif SYSTEM "image/gif">
22  <!NOTATION jpeg SYSTEM "image/jpeg">
23]>
24<root/>
25XML;
26
27    // 2. XMLを Dom\Document オブジェクトとしてロードします。
28    $dom = new Dom\Document();
29    $dom->loadXML($xmlString);
30
31    // 3. ドキュメントタイプノード (DOCTYPE) を取得します。
32    //    Dom\Notation オブジェクトは、この doctype ノードから取得します。
33    $docType = $dom->doctype;
34
35    if ($docType === null) {
36        echo "エラー: DOCTYPE ノードが見つかりませんでした。\n";
37        return;
38    }
39
40    // 4. 'gif' と 'jpeg' のNOTATIONノードを取得します。
41    //    getNamedItem() は Dom\Notation または null を返します。
42    $notationGif1 = $docType->notations?->getNamedItem('gif');
43    $notationJpeg = $docType->notations?->getNamedItem('jpeg');
44    
45    // 同じNOTATIONノードを再度取得します。
46    // これにより、DOMツリー上は同じノードだが、PHPのオブジェクトとしては別インスタンスになる可能性を示します。
47    $notationGif2 = $docType->notations?->getNamedItem('gif');
48
49    echo "--- 比較結果 ---\n";
50
51    // シナリオ A: 同じDOMノードを参照する異なるPHPオブジェクトを比較
52    if ($notationGif1 instanceof Dom\Notation && $notationGif2 instanceof Dom\Notation) {
53        $isSameDomNode = $notationGif1->isSameNode($notationGif2);
54        echo "A. NOTATION 'gif' (1) と NOTATION 'gif' (2) は同じDOMノードか？: " . ($isSameDomNode ? 'はい' : 'いいえ') . "\n";
55        // 補足: PHPのオブジェクト参照の比較 (===)
56        echo "   (参考: PHPのオブジェクト参照が同じか (===) : " . ($notationGif1 === $notationGif2 ? 'はい' : 'いいえ') . ")\n";
57    } else {
58        echo "エラー: 'gif' NOTATION の取得に失敗しました。\n";
59    }
60
61    // シナリオ B: 異なるNOTATIONノード同士を比較
62    if ($notationGif1 instanceof Dom\Notation && $notationJpeg instanceof Dom\Notation) {
63        $isSameDomNode = $notationGif1->isSameNode($notationJpeg);
64        echo "B. NOTATION 'gif' と NOTATION 'jpeg' は同じDOMノードか？: " . ($isSameDomNode ? 'はい' : 'いいえ') . "\n";
65    } else {
66        echo "エラー: 'jpeg' NOTATION の取得に失敗しました。\n";
67    }
68
69    // シナリオ C: Dom\Notation ノードと異なる種類の Dom\Node (例: 要素ノード) を比較
70    $rootElement = $dom->documentElement; // <root/> 要素ノード
71    if ($notationGif1 instanceof Dom\Notation && $rootElement instanceof Dom\Node) {
72        $isSameDomNode = $notationGif1->isSameNode($rootElement);
73        echo "C. NOTATION 'gif' とルート要素ノードは同じDOMノードか？: " . ($isSameDomNode ? 'はい' : 'いいえ') . "\n";
74    }
75
76    // シナリオ D: null と比較
77    if ($notationGif1 instanceof Dom\Notation) {
78        $isSameDomNode = $notationGif1->isSameNode(null);
79        echo "D. NOTATION 'gif' と null は同じDOMノードか？: " . ($isSameDomNode ? 'はい' : 'いいえ') . "\n";
80    }
81}
82
83// サンプルコードの実行
84demonstrateDomNotationIsSameNode();
85

PHP 8のDom\Notation::isSameNodeメソッドは、二つのDom\NodeオブジェクトがXMLドキュメントのDOMツリー上で同じノードを指しているかを確認するために使用されます。引数 $otherNode には比較したいDom\Nodeオブジェクト、またはnullを指定し、同じノードであればtrue、そうでなければfalseをbool型で返します。

このメソッドは、PHPのオブジェクト比較演算子である===とは異なり、オブジェクトのメモリ上の同一性ではなく、DOMツリー内での構造的な同一性を判断します。Dom\Notationは、XMLのDTD（Document Type Definition）において、画像形式など外部データの記法を定義するための特殊なノードです。

サンプルコードでは、DTDにgifとjpegのNOTATIONが定義されたXMLを読み込み、それぞれのDom\Notationノードを取得しています。同じgifのNOTATIONを異なるPHPオブジェクトとして取得した場合でも、isSameNodeはDOMツリー上で同じノードであると判断しtrueを返します。一方、gifとjpegのように異なるNOTATIONノードや、Dom\Notationとルート要素のような異なる種類のノード、あるいはnullと比較した場合はfalseとなります。これにより、DOMツリーにおけるノードの厳密な同一性チェックが可能です。