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

isSameNodeメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 2025年09月11日更新日: 2025年12月02日

基本的な使い方

isSameNodeメソッドは、DOMDocumentTypeオブジェクトと別のノードが同じノードであるかどうかを判定するメソッドです。このメソッドを使用することで、2つのDOMDocumentTypeオブジェクトがメモリ上で同一のオブジェクトを指しているかどうかを効率的に確認できます。

具体的には、$node->isSameNode($otherNode) のように使用します。ここで $node は DOMDocumentType オブジェクトであり、$otherNode は比較対象のノードです。$otherNode には、別の DOMDocumentType オブジェクトや、DOMNode インターフェースを実装した任意のオブジェクトを指定できます。

isSameNodeメソッドは、2つのノードが完全に同一である場合に true を、そうでない場合に false を返します。ノードの内容が同じであっても、別のオブジェクトとして存在する場合は false が返されます。オブジェクトの同一性を厳密に比較する必要がある場合に有効です。

このメソッドは、DOM (Document Object Model) を操作する際に、特定のノードが期待されるノードと同一であることを確認するために役立ちます。例えば、ノードの置換や削除などの操作を行う前に、操作対象のノードが正しいものであるかを検証するために利用できます。

DOMDocumentTypeオブジェクトは、XMLドキュメントのDOCTYPE宣言を表します。DOCTYPE宣言は、ドキュメントの構造と使用可能な要素や属性を定義するDTD (Document Type Definition) への参照を含みます。isSameNodeメソッドを使用することで、複数のDOCTYPE宣言を扱う際に、特定のDOCTYPE宣言が同一のものであるかを正確に判定し、処理を適切に分岐させることができます。

構文(syntax)


1DOMDocumentType::isSameNode(?DOMNode $node): bool

引数(parameters)

DOMNode $otherNode

DOMNode $otherNode: 比較対象となる他のDOMNodeオブジェクト

戻り値(return)

bool

このメソッドは、指定されたノードがこのノードと同じノードである場合に true を返し、そうでない場合に false を返します。

サンプルコード

PHP DOMDocumentType::isSameNodeでノード同一性チェック


1<?php
2
3// DOMDocumentType::isSameNode メソッドのサンプルコード
4// このメソッドは、2つのDOMノードがDOMツリー内の全く同じオブジェクトインスタンスであるかをチェックします。
5// システムエンジニアを目指す初心者向けに、まずノードが存在するかどうか（isnotemptyの概念）を確認してから、
6// isSameNode の動作を示します。
7
8// 1. 新しいDOMDocumentオブジェクトを作成し、DOCTYPE宣言を含むHTMLコンテンツをロードします。
9$dom = new DOMDocument();
10$htmlContent = '<!DOCTYPE html>
11<html>
12<head>
13    <title>ページタイトル</title>
14</head>
15<body>
16    <h1>ようこそ</h1>
17    <p>これはサンプルの段落です。</p>
18</body>
19</html>';
20$dom->loadHTML($htmlContent);
21
22// 2. DOMDocumentTypeノードを取得します。
23// DOMDocument::doctype プロパティは、文書にDOCTYPE宣言が存在しない場合、nullを返します。
24$doctypeNode1 = $dom->doctype;
25
26// 3. キーワード「php isnotempty」の概念を適用し、DOCTYPEノードが実際に取得できたか（nullでないか）を確認します。
27if ($doctypeNode1 !== null) {
28    echo "DOCTYPEノードが存在します。(isnotempty の概念を満たします)\n";
29    echo "--------------------------------------------------\n";
30
31    // 4. 同じDOMツリーから、再度DOCTYPEノードを取得します。
32    // PHPのDOM拡張では、DOMツリー内の同じノードは常に同じオブジェクトインスタンスとして扱われます。
33    $doctypeNode2 = $dom->doctype;
34
35    // 5. DOMDocumentType::isSameNode() メソッドを使用して、ノードの同一性を比較します。
36
37    // ケース1: 同じDOMDocumentTypeインスタンス同士の比較
38    // $doctypeNode1 と $doctypeNode2 は、同じDOMツリー内の同じDOCTYPEノードを参照しているため、
39    // isSameNode() は true を返します。
40    if ($doctypeNode1->isSameNode($doctypeNode2)) {
41        echo "ケース1: \$doctypeNode1 と \$doctypeNode2 は同じノードです。\n";
42    } else {
43        echo "ケース1: \$doctypeNode1 と \$doctypeNode2 は異なるノードです。\n";
44    }
45
46    // ケース2: 別の種類のDOMノード（例: body要素）との比較
47    // getElementsByTagName() メソッドで body 要素ノードを取得します。
48    $bodyNode = $dom->getElementsByTagName('body')->item(0);
49
50    // body要素ノードが存在するか確認します。
51    if ($bodyNode !== null) {
52        // DOCTYPEノードとbody要素ノードはDOMツリー内で異なるオブジェクトインスタンスであるため、
53        // isSameNode() は false を返します。
54        if ($doctypeNode1->isSameNode($bodyNode)) {
55            echo "ケース2: \$doctypeNode1 と body要素ノードは同じノードです。\n";
56        } else {
57            echo "ケース2: \$doctypeNode1 と body要素ノードは異なるノードです。\n";
58        }
59    } else {
60        echo "エラー: body要素ノードが見つかりませんでした。\n";
61    }
62
63} else {
64    // DOCTYPE宣言がないHTMLをロードした場合、このブロックが実行されます。
65    echo "DOCTYPEノードが存在しません。(isnotempty の概念を満たしません)\n";
66    echo "isSameNode メソッドは利用できません。\n";
67}
68
69?>

DOMDocumentType::isSameNodeメソッドは、PHPのDOM操作において、二つのDOMノードがDOMツリー内で全く同じオブジェクトインスタンスであるかを厳密に比較するために使用されます。

このメソッドは引数としてDOMNode $otherNodeを受け取ります。これは、比較対象となる別のDOMノードを指定するものです。メソッドが実行されると、呼び出し元のノードと引数で指定されたノードが同一である場合trueを、異なる場合はfalseをbool型の戻り値として返します。

システムエンジニアを目指す初心者の方は、まずノードが取得できたか（「php isnotempty」の概念として、nullではないか）を確認してから、このメソッドを利用することが重要です。

例えば、サンプルコードでは、まず文書からDOCTYPEノードが正しく取得できたかを確認しています。その後、同じDOCTYPEノードを再度取得して比較すると、同一のオブジェクトインスタンスであるためisSameNodeはtrueを返します。しかし、DOCTYPEノードと、文書内の<body>要素のような異なる種類のノードを比較した場合は、これらはDOMツリー内で別のオブジェクトインスタンスであるため、isSameNodeはfalseを返します。このように、このメソッドはDOMツリー内のノードの物理的な同一性を判断する際に役立ちます。

DOMDocumentType::isSameNodeメソッドは、二つのDOMノードがDOMツリー内で全く同じオブジェクトインスタンスであるかを厳密に比較します。このメソッドを呼び出す前に、比較対象のノードがnullでないことを必ず確認してください。これは「isnotempty」の概念に通じ、未定義のノードに対してメソッドを呼び出すエラーを防ぐために非常に重要です。このメソッドはノードの内容や値が同じかどうかを判断するのではなく、メモリアドレス上の同一性を確認するものです。PHPのDOM拡張では、同じDOMツリーから同じノードを複数回取得しても、常に同じオブジェクトインスタンスが返される特性があります。そのため、異なるDOMDocumentオブジェクトに属するノードや、ツリー内で異なる種類のノードと比較した場合はfalseとなります。

PHP DOMDocumentType isSameNode でノード比較する


1<?php
2
3/**
4 * DOMDocumentType::isSameNode メソッドのサンプルコード
5 *
6 * このスクリプトは、2つのDOMノードが同じオブジェクトであるかを
7 * DOMDocumentType::isSameNode メソッドを使って確認する方法を示します。
8 * 主に DOMDocumentType ノードを対象としていますが、DOMNode を引数に取ります。
9 */
10
11// 1. DOMDocument オブジェクトを作成します。
12//    HTMLやXMLを解析するために必要です。
13$dom = new DOMDocument();
14
15// 2. HTML5 の DOCTYPE 宣言を含む簡単なHTMLをロードします。
16//    isSameNode メソッドをテストするためには、DOMDocumentType ノードが必要です。
17//    loadHTML() メソッドが自動的に DOCTYPE ノードを解析します。
18$html = '<!DOCTYPE html><html><head><title>Sample</title></head><body><h1>Hello World</h1></body></html>';
19$dom->loadHTML($html);
20
21// 3. ドキュメントから DOMDocumentType ノードを取得します。
22//    $dom->doctype プロパティは、ドキュメントの DOCTYPE ノード (DOMDocumentType クラスのインスタンス) を返します。
23$docTypeNode1 = $dom->doctype;
24
25// 4. 同じ DOMDocumentType ノードへの参照を別の変数に代入します。
26//    PHPではオブジェクトは参照として扱われるため、$docTypeNode2 も $docTypeNode1 と同じオブジェクトを指します。
27$docTypeNode2 = $dom->doctype;
28
29echo "DOMDocumentType::isSameNode メソッドの実行例:\n\n";
30
31// 5. $docTypeNode1 と $docTypeNode2 が同じノードであるかを比較します。
32//    両方とも同じオブジェクトを指しているため、true が返されます。
33if ($docTypeNode1 && $docTypeNode2) {
34    $isSame = $docTypeNode1->isSameNode($docTypeNode2);
35    echo "ケース1: \$docTypeNode1 と \$docTypeNode2 の比較 (同じオブジェクト): " . ($isSame ? "true" : "false") . "\n";
36    echo "  -> 期待される結果: true (両方の変数が同じ DOMDocumentType オブジェクトを参照しているため)\n\n";
37} else {
38    echo "エラー: DOMDocumentType ノードが正しく取得できませんでした。\n\n";
39}
40
41// 6. 異なる種類のノード (例: <body> 要素ノード) と比較する例です。
42//    ドキュメントから <body> 要素ノードを取得します。
43$bodyElementNode = $dom->getElementsByTagName('body')->item(0);
44
45// 7. $docTypeNode1 と $bodyElementNode が同じノードであるかを比較します。
46//    これらは異なる種類のノードであり、メモリ上の異なるオブジェクトなので、false が返されます。
47if ($docTypeNode1 && $bodyElementNode) {
48    $isSameWithOtherNode = $docTypeNode1->isSameNode($bodyElementNode);
49    echo "ケース2: \$docTypeNode1 と body 要素ノードの比較 (異なるオブジェクト): " . ($isSameWithOtherNode ? "true" : "false") . "\n";
50    echo "  -> 期待される結果: false (これらは異なる種類のノードであり、メモリ上の異なるオブジェクトのため)\n\n";
51} else {
52    echo "エラー: DOMDocumentType または body 要素ノードが正しく取得できませんでした。\n\n";
53}
54
55?>

PHPのDOMDocumentType::isSameNodeメソッドは、二つのDOMノードがメモリ上で全く同じオブジェクトであるかどうかを確認するための機能です。このメソッドは、HTMLやXMLドキュメントの構造を扱う際に、特定のノードが期待するノードと完全に同一であるかを厳密に比較したい場合に使用されます。

DOMDocumentTypeクラスのインスタンスから呼び出されますが、引数としてDOMNode $otherNodeを受け取るため、任意のDOMノードと比較することができます。メソッドの実行結果はbool型の真偽値で返されます。具体的には、比較対象の二つのノードがメモリ上で同じオブジェクトを参照していればtrueを、異なるオブジェクトであればfalseを返します。

サンプルコードでは、まず同じDOMDocumentTypeノードを二つの変数に取得し、比較することでtrueが返される例を示しています。これは、両方の変数がメモリ上の同一オブジェクトを指しているためです。次に、DOMDocumentTypeノードと<body>要素ノードという異なる種類のノードを比較する例も示しています。これらはメモリ上で別々のオブジェクトであるため、isSameNodeメソッドはfalseを返します。このメソッドは、ノードの内容や属性が同じかどうかではなく、オブジェクトそのものが同一であるかを判断する際に利用されます。

isSameNodeメソッドは、二つのDOMノードがメモリ上で全く同じオブジェクトであるかを判定します。見た目や内容が同じでも、異なるオブジェクトであればfalseを返しますのでご注意ください。PHPの===演算子によるオブジェクトの同一性チェックに近い振る舞いをします。引数にはDOMDocumentTypeだけでなく、他のDOMElementなどのDOMNode派生クラスも渡せますが、ドキュメントツリー内の異なる種類のノードを比較すると常にfalseとなります。また、$dom->doctypeでDOCTYPEノードを取得する際、HTMLにDOCTYPE宣言がない場合はnullとなるため、使用前に変数が有効なオブジェクトであるか確認するようにしてください。