【PHP8.x】Dom\DocumentType::isEqualNode()メソッドの使い方
isEqualNodeメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
isEqualNodeメソッドは、Dom\DocumentTypeクラスのインスタンスが、引数として与えられた別のノードと等しいかどうかを比較するために使用されるメソッドです。ここで言う「等しい」とは、ノードの種類、ノード名、ノードの値（もしあれば）などが全て一致することを意味します。
具体的には、このメソッドは、ドキュメント型定義（Document Type Definition、DTD）が同じであるかどうかを検証するために利用できます。DTDは、XMLやHTMLなどの構造を定義するものであり、これらが一致するかどうかを確認することで、文書の構造的な同一性を検証できます。
このメソッドは、ブール値（trueまたはfalse）を返します。trueが返された場合、2つのノードは等しいとみなされます。falseが返された場合、それらは等しくありません。
Dom\DocumentTypeオブジェクトのisEqualNodeメソッドを使用することで、プログラムは2つのドキュメント型定義が同一であるかどうかをプログラム的に判断し、それに基づいて適切な処理を行うことができます。例えば、特定のDTDを持つ文書のみを受け入れるようにしたり、DTDが異なる場合はエラーを発生させたりするような処理を実装できます。
引数には比較対象となるノードを指定します。このノードは、Dom\Nodeクラスのインスタンスである必要があります。もし引数が適切な型でなかった場合、予期しないエラーが発生する可能性がありますので注意が必要です。
構文(syntax)
1public Dom\DocumentType::isEqualNode(Dom\Node $node): bool
引数(parameters)
Dom\Node|null $otherNode
- Dom\Node|null $otherNode: 比較対象となる別のDom\Nodeオブジェクト、またはnullを指定します。
戻り値(return)
bool
このメソッドは、比較対象のノードが現在のDom\DocumentTypeノードと構造的に等しい場合にtrueを、そうでない場合にfalseを返します。
サンプルコード
PHP Dom\DocumentType::isEqualNode で doctype mismatch を検出する
1<?php 2 3/** 4 * Dom\DocumentType::isEqualNode の使用例と、ドキュメントタイプが期待と異なる場合の処理を示す関数。 5 * 6 * この関数は、指定されたHTML文字列からDocumentTypeノードを抽出し、 7 * 期待されるHTML5のDocumentTypeと比較します。 8 * 比較結果が一致しない場合、それを「エラー」とみなし、メッセージを出力します。 9 * 10 * @param string $htmlString 処理するHTML文字列。 11 * @return void 12 */ 13function checkDocumentTypeMismatch(string $htmlString): void 14{ 15 // DOMDocument を作成し、HTML文字列をロードします。 16 // HTMLパース時の警告を抑制するために libxml_use_internal_errors を設定します。 17 libxml_use_internal_errors(true); 18 $dom = new DOMDocument(); 19 $dom->loadHTML($htmlString); 20 libxml_clear_errors(); // ロード時に発生したエラーをクリアします。 21 22 // 現在のドキュメントから DocumentType ノードを取得します。 23 // ドキュメントに DocumentType がない場合、$dom->doctype は null になります。 24 $actualDocType = $dom->doctype; 25 26 // 比較対象となる「期待される」DocumentType ノードを作成します。 27 // ここでは、HTML5の <!DOCTYPE html> を想定して作成します。 28 // HTML5 DOCTYPE は名前が 'html' で、公開識別子(publicId)とシステム識別子(systemId)は空です。 29 $domImpl = new DOMImplementation(); 30 $expectedDocType = $domImpl->createDocumentType('html', '', ''); 31 32 echo "--- ドキュメントタイプ比較の例 ---\n"; 33 echo "処理中のHTML:\n"; 34 echo substr(str_replace("\n", "", $htmlString), 0, 70) . "...\n"; // HTML文字列の一部を表示 35 36 // 実際のドキュメントに DocumentType が存在するかを確認します。 37 if ($actualDocType === null) { 38 echo "現在のドキュメントには DocumentType が見つかりませんでした。\n"; 39 // キーワード「iserror」に関連付けて、DocumentTypeがない状況をエラーとして処理します。 40 echo "⚠️ エラー: 期待される DocumentType が見つかりません。この状況は処理上のエラーとみなせます。\n"; 41 echo "\n"; 42 return; 43 } 44 45 // Dom\DocumentType::isEqualNode を使用して、実際のドキュメントタイプと期待されるドキュメントタイプを比較します。 46 // isEqualNode は、ノードの名前、公開識別子、システム識別子が一致するかどうかを判定します。 47 if ($actualDocType->isEqualNode($expectedDocType)) { 48 echo "✅ ドキュメントタイプが期待される 'html' DOCTYPE と一致します。\n"; 49 } else { 50 echo "❌ ドキュメントタイプが期待される 'html' DOCTYPE と一致しません。\n"; 51 // 実際のDocumentTypeと期待されるDocumentTypeの情報を表示します。 52 echo " 現在の DOCTYPE: <!DOCTYPE {$actualDocType->name}"; 53 if ($actualDocType->publicId !== '') { 54 echo ' PUBLIC "' . $actualDocType->publicId . '"'; 55 } 56 if ($actualDocType->systemId !== '') { 57 echo ' "' . $actualDocType->systemId . '"'; 58 } 59 echo ">\n"; 60 61 echo " 期待される DOCTYPE: <!DOCTYPE {$expectedDocType->name}"; 62 if ($expectedDocType->publicId !== '') { 63 echo ' PUBLIC "' . $expectedDocType->publicId . '"'; 64 } 65 if ($expectedDocType->systemId !== '') { 66 echo ' "' . $expectedDocType->systemId . '"'; 67 } 68 echo ">\n"; 69 // キーワード「iserror」に関連付けて、期待する状態と異なる場合にエラーとして処理します。 70 echo "⚠️ エラー: ドキュメントタイプが期待と異なります。この状況は処理上のエラーとみなせます。\n"; 71 } 72 73 echo "\n"; 74} 75 76// --- サンプル実行 --- 77 78// シナリオ1: 期待されるHTML5 DOCTYPEを持つ場合 79echo "シナリオ1: HTML5 DOCTYPE の場合\n"; 80checkDocumentTypeMismatch('<!DOCTYPE html><html><head><title>Test</title></head><body><h1>Hello</h1></body></html>'); 81 82// シナリオ2: 異なるDOCTYPEを持つ場合 (XHTML 1.0 Transitional) 83echo "シナリオ2: 異なる DOCTYPE の場合 (XHTML 1.0 Transitional)\n"; 84checkDocumentTypeMismatch('<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html><body>Hello</body></html>'); 85 86// シナリオ3: DOCTYPE を持たない場合 87echo "シナリオ3: DOCTYPE がない場合\n"; 88checkDocumentTypeMismatch('<html><body>Hello</body></html>'); 89 90?>
Dom\DocumentType::isEqualNodeは、HTMLやXML文書のドキュメントタイプ（<!DOCTYPE ...>の部分）が、別の指定されたノードと「等しい」かどうかを比較するPHPのメソッドです。ここで言う「等しい」とは、ドキュメントタイプの名前（例えばhtml）や、公開識別子、システム識別子がすべて一致することを意味します。
このメソッドはDom\DocumentTypeクラスに属し、引数として比較したい別のドキュメントノード（Dom\Node型かnull）を受け取ります。比較の結果、両方のノードが等しければtrueを、異なればfalseをブール値で返します。
サンプルコードでは、与えられたHTML文字列から実際のドキュメントタイプを抽出し、HTML5の標準的なドキュメントタイプと比較しています。もしHTML文書にドキュメントタイプが存在しない場合や、期待するHTML5のドキュメントタイプと一致しない場合、このプログラムはそれを「エラー（iserror）」として扱い、適切なメッセージを出力します。これにより、Webアプリケーションが特定のHTML標準に準拠しているかを確認する際などに、ドキュメントタイプの不一致を早期に検知し、問題を特定することができます。
Dom\DocumentType::isEqualNodeメソッドは、ドキュメントタイプノードの名前、公開識別子、システム識別子が完全に一致するかを判定します。ノードの構造や関連性は比較しないため、同一性の判断基準を理解しておくことが重要です。
DOMDocument::$doctypeプロパティは、ドキュメントにDOCTYPE宣言が存在しない場合にnullを返します。isEqualNodeメソッドの引数にnullを渡すと型エラーとなるため、呼び出し前に必ずnullチェックを行い、対象ノードが存在することを確認してください。
HTMLをDOMとしてロードする際、パース時の警告やエラーが発生する可能性があります。libxml_use_internal_errors関数で警告を抑制し、libxml_clear_errorsでクリアする処理は、コードを安全に実行するために役立ちます。
サンプルコードでは、期待と異なるドキュメントタイプを「エラー」として扱っていますが、どのような状況をエラーと見なすかは、開発するシステムの要件に合わせて明確に定義することが大切です。
PHP: Dom\DocumentType::isEqualNode と isset() で比較する
1<?php 2 3/** 4 * Dom\DocumentType オブジェクトが別のノードと等しいかどうかを比較する関数。 5 * 6 * この関数は、Dom\DocumentType::isEqualNode メソッドの利用方法を示し、 7 * 特に比較対象のノードが null である可能性を考慮して isset() を使用する方法を例示します。 8 * 9 * @param Dom\DocumentType $docType1 比較元の DocumentType ノード。 10 * @param Dom\Node|null $docType2 比較対象のノード。Dom\Node のサブクラス（Dom\DocumentType も含む） 11 * または null が指定可能です。 12 * @return bool 2つのノードが等しい場合は true、それ以外は false を返します。 13 */ 14function compareDocumentTypes(Dom\DocumentType $docType1, ?Dom\Node $docType2): bool 15{ 16 // PHP 8 の型ヒント `?Dom\Node` により、引数 $docType2 は Dom\Node オブジェクトか null のどちらかを受け取ります。 17 // メソッド呼び出しの前に isset() を使用して、比較対象のノードが null でないことを確認します。 18 // isset() は、変数が存在し、かつ null 以外の値を持っている場合に true を返します。 19 // これにより、もし $docType2 が null だった場合に Dom\DocumentType::isEqualNode() メソッドを 20 // 不適切に呼び出すことを防ぎ、安全にコードを実行できます。 21 if (isset($docType2)) { 22 // Dom\DocumentType は Dom\Node を継承しているため、isEqualNode メソッドが利用できます。 23 // isEqualNode は、ノードの型、名前、ローカル名、名前空間 URI、接頭辞、 24 // 公開識別子 (publicId)、システム識別子 (systemId) などが同じである場合に true を返します。 25 // 子ノードや属性の比較は行われません。 26 return $docType1->isEqualNode($docType2); 27 } 28 29 // 比較対象のノードが null の場合、等しいとはみなせないため false を返します。 30 return false; 31} 32 33// --- サンプルコードの実行例 --- 34 35echo "--- Dom\\DocumentType::isEqualNode のサンプル ---" . PHP_EOL; 36 37// 1. HTML5 ドキュメントの DocumentType を作成 38$domA = new DOMDocument(); 39$domA->loadHTML('<!DOCTYPE html><html><body>Test A</body></html>'); 40$docTypeA = $domA->doctype; // Dom\DocumentType オブジェクトを取得 41 42// 2. 同じ内容のHTML5 ドキュメントの DocumentType を作成 43$domB = new DOMDocument(); 44$domB->loadHTML('<!DOCTYPE html><html><body>Test B</body></html>'); 45$docTypeB = $domB->doctype; // Dom\DocumentType オブジェクトを取得 46 47// 3. 異なる内容の DocumentType を持つドキュメントを作成 (例: HTML 4.01 Strict) 48$domC = new DOMDocument(); 49$domC->loadHTML('<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"><html><body>Test C</body></html>'); 50$docTypeC = $domC->doctype; // 異なる Dom\DocumentType オブジェクトを取得 51 52// 4. 比較対象として null ノードを用意 53$nullNode = null; 54 55// 5. DocumentType 以外の Dom\Node を用意 (例: body 要素) 56$domD = new DOMDocument(); 57$domD->loadHTML('<!DOCTYPE html><html><body id="test">Test D</body></html>'); 58$bodyNode = $domD->getElementsByTagName('body')->item(0); // Dom\Element オブジェクト (Dom\Node の一種) 59 60echo PHP_EOL . "◆ ケース1: 同じ内容の DocumentType オブジェクトを比較 ◆" . PHP_EOL; 61// docTypeA と docTypeB は、どちらも HTML5 の DOCTYPE であるため、等しいと判断されます。 62echo " \$docTypeA と \$docTypeB は等しいか？: " . (compareDocumentTypes($docTypeA, $docTypeB) ? "はい" : "いいえ") . PHP_EOL; // 期待値: はい (true) 63 64echo PHP_EOL . "◆ ケース2: 異なる内容の DocumentType オブジェクトを比較 ◆" . PHP_EOL; 65// docTypeA (HTML5) と docTypeC (HTML 4.01 Strict) は異なる DOCTYPE であるため、等しくないと判断されます。 66echo " \$docTypeA と \$docTypeC は等しいか？: " . (compareDocumentTypes($docTypeA, $docTypeC) ? "はい" : "いいえ") . PHP_EOL; // 期待値: いいえ (false) 67 68echo PHP_EOL . "◆ ケース3: 比較対象が null の場合 (isset() の利用例) ◆" . PHP_EOL; 69// compareDocumentTypes 関数内で isset() によって $nullNode が null であることが検出され、 70// isEqualNode は呼び出されずに false が返されます。 71echo " \$docTypeA と null は等しいか？: " . (compareDocumentTypes($docTypeA, $nullNode) ? "はい" : "いいえ") . PHP_EOL; // 期待値: いいえ (false) 72 73echo PHP_EOL . "◆ ケース4: DocumentType と DocumentType 以外の Dom\\Node を比較 ◆" . PHP_EOL; 74// docTypeA (DocumentType) と bodyNode (Element) はノードの種類が異なるため、等しくないと判断されます。 75echo " \$docTypeA と \$bodyNode は等しいか？: " . (compareDocumentTypes($docTypeA, $bodyNode) ? "はい" : "いいえ") . PHP_EOL; // 期待値: いいえ (false) 76
Dom\DocumentType::isEqualNodeメソッドは、PHP 8で利用できるDOM拡張機能の一部であり、二つのノードが同等であるかを比較するために使用します。このメソッドはDom\Nodeクラスを継承しているため、Dom\DocumentTypeオブジェクトから呼び出すことができます。
引数 $otherNode には、比較対象となるDom\Node型のオブジェクト、またはnullを指定できます。メソッドは比較の結果をbool値で返し、ノードが等しい場合はtrue、それ以外の場合はfalseとなります。ここでいう「等しい」とは、ノードの型、名前、ローカル名、名前空間URI、接頭辞、公開識別子、システム識別子といった、ノードの基本的な識別情報が一致することを意味し、子ノードや属性の内容は比較対象外です。
サンプルコードでは、比較対象のノードがnullである可能性を考慮し、isset()関数で事前に確認してからメソッドを呼び出す方法を示しています。isset()は、変数が存在し、かつnull以外の値を持っている場合にtrueを返すため、これによってnullに対してメソッドを呼び出すことを避け、安全にコードを実行できます。
具体的な実行例では、同じHTML5のDOCTYPEを持つ二つのDom\DocumentTypeオブジェクトは「等しい」と判定されtrueが返されます。しかし、HTML5とHTML 4.01 Strictのように異なる仕様のDOCTYPE、あるいはnull、さらにはbody要素のような異なる種類のDom\Nodeとは「等しくない」と判定されfalseが返されることが確認できます。このメソッドは、ノードの基本的なメタ情報を基にした厳密な比較を行う際に非常に有用です。
PHP 8のDom\DocumentType::isEqualNodeメソッドを利用する際、引数にnullが渡される可能性があるため、メソッド呼び出し前にisset()で必ずオブジェクトの存在を確認してください。これを怠ると、nullに対するメソッド呼び出しで実行時エラーが発生する恐れがあります。isEqualNodeは、ノードの型、名前、DocumentType特有の公開・システム識別子など、ノード自身の基本的なプロパティのみを比較します。子ノードや属性の比較は行われませんのでご注意ください。また、Dom\DocumentTypeとDom\Elementのような異なる種類のノードを比較すると、ノードの型が異なるため常にfalseが返されます。これらの特性を理解し、安全かつ意図した比較が行えるように注意してください。