【PHP8.x】Dom\HTMLDocument::getElementsByTagNameNS()メソッドの使い方
getElementsByTagNameNSメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
getElementsByTagNameNSメソッドは、指定された名前空間URIとローカル名を持つすべての要素を、ドキュメント内で発見順にNodeListとして返すメソッドです。このメソッドは、名前空間を考慮した要素の検索を行う際に非常に役立ちます。
具体的には、第一引数に名前空間URI、第二引数にローカル名を文字列として指定します。名前空間URIは、XML名前空間を識別するためのURIであり、ローカル名は要素のタグ名です。例えば、http://www.w3.org/1999/xhtmlという名前空間URIとpというローカル名を指定した場合、HTMLドキュメント内のすべての<p>要素（名前空間が指定されている場合）がNodeListとして返されます。
getElementsByTagNameNSメソッドは、特にXMLやXHTMLといった名前空間を使用するドキュメントを扱う際に有効です。HTML5では、要素が特定の名前空間に属している場合があるため、このメソッドを使用することで、特定の名前空間に属する要素のみを効率的に抽出できます。
返されるNodeListは、ドキュメント内の要素のライブなコレクションです。つまり、NodeListの内容は、ドキュメントの構造が変更されると自動的に更新されます。これは、NodeListを操作する際に、ドキュメントの変更がNodeListに反映されることを意味します。
このメソッドは、DOMDocumentクラスやHTMLElementクラスなど、DOMNodeを継承するクラスのインスタンスから呼び出すことができます。呼び出し元のノードをルートとして、そのノードの子孫要素から検索を行います。名前空間URIにnullまたは空文字列を指定した場合、名前空間を持たない要素が検索されます。ローカル名に*を指定した場合、すべてのローカル名を持つ要素が検索されます。両方に*を指定した場合、すべての要素が返されます。
構文(syntax)
1DOMHTMLDocument::getElementsByTagNameNS( ?string $namespaceURI, string $localName ): DOMNodeList
引数(parameters)
?string $namespace, string $localName
- ?string $namespace: 名前空間を指定する文字列。NULLの場合、名前空間は考慮されません。
- string $localName: 検索する要素のローカル名を指定する文字列。
戻り値(return)
Dom\HTMLCollection
指定された名前空間に属する、すべての子孫要素のコレクションを返します。
サンプルコード
PHP: getElementsByTagNameNS で要素を検索する
1<?php 2 3/** 4 * Dom\HTMLDocument::getElementsByTagNameNS メソッドの使用例。 5 * 特定の名前空間とタグ名を持つ要素をHTMLドキュメントから検索します。 6 * 7 * @param string $html HTMLドキュメントの文字列。 8 * @return void 9 */ 10function demonstrateGetElementsByTagNameNS(string $html): void 11{ 12 // 1. Dom\HTMLDocument オブジェクトを作成し、HTMLを読み込みます。 13 $document = new Dom\HTMLDocument(); 14 $document->loadHTML($html); 15 16 echo "--- 'p' タグ (名前空間指定なし) の検索 ---\n"; 17 // HTML要素は通常、特定の名前空間に属さないか、暗黙のHTML名前空間に属すると見なされます。 18 // ここでは名前空間を null に指定し、"p" タグを検索します。 19 $paragraphs = $document->getElementsByTagNameNS(null, 'p'); 20 21 if ($paragraphs->count() > 0) { 22 echo "見つかった 'p' 要素の数: " . $paragraphs->count() . "\n"; 23 foreach ($paragraphs as $index => $paragraph) { 24 echo " [{$index}] テキストコンテンツ: " . $paragraph->textContent . "\n"; 25 } 26 } else { 27 echo "'p' 要素は見つかりませんでした。\n"; 28 } 29 echo "\n"; 30 31 echo "--- 'circle' タグ (SVG 名前空間) の検索 ---\n"; 32 // SVG要素は 'http://www.w3.org/2000/svg' 名前空間に属します。 33 // 明示的にSVG名前空間と "circle" タグを指定して検索します。 34 $svgNamespaceUri = 'http://www.w3.org/2000/svg'; 35 $circles = $document->getElementsByTagNameNS($svgNamespaceUri, 'circle'); 36 37 if ($circles->count() > 0) { 38 echo "見つかった 'circle' 要素の数: " . $circles->count() . "\n"; 39 foreach ($circles as $index => $circle) { 40 echo " [{$index}] タグ名: " . $circle->nodeName . ", 属性 'fill': " . $circle->getAttribute('fill') . "\n"; 41 } 42 } else { 43 echo "'circle' 要素は見つかりませんでした。\n"; 44 } 45 echo "\n"; 46 47 echo "--- 存在しないタグ ('nonexistent') の検索 ---\n"; 48 // 存在しないタグを検索した場合、空の Dom\HTMLCollection が返されます。 49 $nonExistentElements = $document->getElementsByTagNameNS(null, 'nonexistent'); 50 if ($nonExistentElements->count() > 0) { 51 echo "見つかった 'nonexistent' 要素の数: " . $nonExistentElements->count() . "\n"; 52 } else { 53 echo "'nonexistent' 要素は見つかりませんでした。\n"; 54 } 55} 56 57// この関数で利用するHTMLドキュメント文字列を定義します。 58// SVG要素を含めることで、名前空間の異なる要素の検索を示します。 59$sampleHtml = <<<HTML 60<!DOCTYPE html> 61<html> 62<head> 63 <title>DOM getElementsByTagNameNS の例</title> 64</head> 65<body> 66 <h1>PHP Dom\HTMLDocument::getElementsByTagNameNS を使った要素検索</h1> 67 <p>これは最初の段落です。</p> 68 <svg xmlns="http://www.w3.org/2000/svg" width="120" height="120"> 69 <circle cx="60" cy="60" r="50" stroke="blue" stroke-width="2" fill="yellow" /> 70 </svg> 71 <p>これは2番目の段落です。</p> 72 <div> 73 <span>一般的な span 要素です。</span> 74 </div> 75</body> 76</html> 77HTML; 78 79// サンプルコードを実行します。 80demonstrateGetElementsByTagNameNS($sampleHtml);
PHPのDom\HTMLDocument::getElementsByTagNameNSメソッドは、HTMLドキュメントの中から特定の名前空間とタグ名を持つ要素を効率的に検索するための機能です。このメソッドは、第一引数に検索したい要素が属する名前空間のURI（Uniform Resource Identifier）を、第二引数にその要素のタグ名（ローカル名）を受け取ります。例えば、通常のHTML要素を検索する場合は名前空間にnullを指定し、'p'タグを探すといった使い方をします。SVGなどの特定のXML名前空間に属する要素を検索する場合は、その名前空間のURIを正確に指定する必要があります。
メソッドは検索条件に合致するすべての要素をDom\HTMLCollectionオブジェクトとして返します。このコレクションは、見つかった要素をリストとして扱い、ループ処理で一つずつアクセスすることができます。もし該当する要素が一つも見つからなかった場合でも、エラーになることなく、要素を含まない空のDom\HTMLCollectionが返されるため、安全に要素の有無を確認できます。
サンプルコードでは、Dom\HTMLDocumentに読み込んだHTMLから、まず名前空間がnullの'p'タグを検索しています。次に、SVGの名前空間URIを指定して'circle'タグを検索し、それぞれ見つかった要素の情報を表示しています。これにより、名前空間の有無によって検索方法が異なることと、結果の扱い方が具体的に示されています。
このメソッドでは、検索対象の要素がどの「名前空間」に属しているかを正しく指定することが非常に重要です。一般的なHTML要素を探す場合は、最初の引数にnullを指定してください。しかし、SVGやMathMLなどの特定のXML名前空間を持つ要素を探す際には、'http://www.w3.org/2000/svg'のように、その要素が属する正確な名前空間URIを文字列で指定する必要があります。この指定を誤ると、目的の要素が見つからないため注意が必要です。また、検索の結果、要素が見つからなかった場合でもエラーにはならず、空のDom\HTMLCollectionオブジェクトが返されます。そのため、返されたコレクションに対してcount()メソッドを使用し、要素が実際に存在するかを確認してから処理を進めることで、安全かつ意図通りの動作を実現できます。
PHP DOM getElementsByTagNameNSによる要素検索
1<?php 2 3/** 4 * Dom\HTMLDocument::getElementsByTagNameNS メソッドの使用例 5 * 6 * このスクリプトは、PHPのDom拡張機能を使用してHTMLドキュメントをパースし、 7 * 特定の名前空間とタグ名を持つ要素を検索する方法を示します。 8 * システムエンジニアを目指す初心者向けに、SVG要素と標準HTML要素の両方を例にとり、 9 * getElementsByTagNameNS の使い方を簡潔に解説します。 10 */ 11 12// 検索対象となるHTMLコンテンツを文字列として定義します。 13// SVG要素を含めることで、名前空間を持つ要素の検索例を示します。 14$htmlContent = <<<'HTML' 15<!DOCTYPE html> 16<html> 17<head> 18 <title>DOM getElementsByTagNameNS Example</title> 19</head> 20<body> 21 <h1>Welcome to the DOM Example</h1> 22 <p>This is a standard HTML paragraph element.</p> 23 24 <div id="container"> 25 <!-- SVG要素は 'http://www.w3.org/2000/svg' 名前空間に属します --> 26 <svg xmlns="http://www.w3.org/2000/svg" width="200" height="100"> 27 <circle cx="50" cy="50" r="40" stroke="black" stroke-width="3" fill="red" /> 28 <rect x="110" y="10" width="80" height="80" fill="blue" /> 29 </svg> 30 </div> 31 32 <p class="footer">Another paragraph at the end.</p> 33</body> 34</html> 35HTML; 36 37// Dom\HTMLDocument オブジェクトを新しく作成します。 38// これがHTMLドキュメント全体を表すルートノードになります。 39$document = new Dom\HTMLDocument(); 40 41// 定義したHTML文字列をドキュメントにロードします。 42// loadHTML() メソッドは、HTMLコンテンツをパースし、DOMツリーを構築します。 43$document->loadHTML($htmlContent); 44 45echo "--- SVGの名前空間に属する 'circle' 要素を検索 ---\n"; 46 47// SVG要素の名前空間URIを定義します。 48// getElementsByTagNameNS の第一引数に渡します。 49$svgNamespaceUri = 'http://www.w3.org/2000/svg'; 50// 検索するローカル名（タグ名）を定義します。 51// getElementsByTagNameNS の第二引数に渡します。 52$tagNameToFind = 'circle'; 53 54// getElementsByTagNameNS メソッドを使用して、指定された名前空間とタグ名を持つ要素を検索します。 55// 戻り値は Dom\HTMLCollection オブジェクトで、検索結果の要素が格納されています。 56$circles = $document->getElementsByTagNameNS($svgNamespaceUri, $tagNameToFind); 57 58// 検索結果をループして、見つかった要素の情報を表示します。 59if ($circles->count() > 0) { 60 echo "見つかった '{$svgNamespaceUri}' 名前空間内の '{$tagNameToFind}' 要素の数: " . $circles->count() . "\n"; 61 foreach ($circles as $index => $circleElement) { 62 // 各要素は Dom\Element のインスタンスです。 63 if ($circleElement instanceof Dom\Element) { 64 echo " [{$index}] タグ名: " . $circleElement->tagName; 65 echo ", 属性 'fill': " . $circleElement->getAttribute('fill') . "\n"; 66 } 67 } 68} else { 69 echo "指定された名前空間とタグ名を持つ '{$tagNameToFind}' 要素は見つかりませんでした。\n"; 70} 71 72echo "\n--- 名前空間を指定しない（HTMLのデフォルト） 'p' 要素を検索 ---\n"; 73 74// 標準的なHTML要素は通常、特定の名前空間に属さないため、 75// getElementsByTagNameNS の第一引数には null を指定します。 76$tagNameToFindHtml = 'p'; 77 78$paragraphs = $document->getElementsByTagNameNS(null, $tagNameToFindHtml); 79 80if ($paragraphs->count() > 0) { 81 echo "見つかった名前空間なしの '{$tagNameToFindHtml}' 要素の数: " . $paragraphs->count() . "\n"; 82 foreach ($paragraphs as $index => $paragraphElement) { 83 if ($paragraphElement instanceof Dom\Element) { 84 echo " [{$index}] タグ名: " . $paragraphElement->tagName; 85 // textContent は要素の内部テキストを取得します。 86 echo ", 内容: '" . trim($paragraphElement->textContent) . "'\n"; 87 } 88 } 89} else { 90 echo "指定されたタグ名を持つHTML要素は見つかりませんでした。\n"; 91} 92 93?>
PHPのDom\HTMLDocument::getElementsByTagNameNSメソッドは、HTMLドキュメントの中から、指定された「名前空間」と「タグ名」を持つすべての要素を検索するための機能です。ウェブページに含まれる様々な種類の要素（例えば標準HTML要素やSVGなどのXMLベースの要素）を特定する際に役立ちます。
このメソッドの第一引数$namespaceには、検索対象の名前空間URIを文字列で指定します。例えば、SVG要素を検索する場合には'http://www.w3.org/2000/svg'のようなURIを渡します。もし標準的なHTML要素のように、特定の名前空間に属さない要素を検索したい場合は、nullを指定します。第二引数$localNameには、検索したいタグの名前を文字列で指定します。
メソッドの戻り値はDom\HTMLCollectionというオブジェクトです。これは、検索条件に一致したすべての要素をまとめたリストのようなもので、見つかった要素の数を確認したり、それぞれの要素に対して繰り返し処理を行ったりすることができます。
サンプルコードでは、まずHTMLコンテンツをDom\HTMLDocumentにロードし、getElementsByTagNameNSを使って具体的な検索を行っています。一つ目の例では、SVGの名前空間を指定してcircleタグの要素を検索し、その数や属性を表示しています。二つ目の例では、名前空間にnullを指定して標準HTMLのpタグの要素を検索し、その内容を表示しています。これにより、名前空間の指定方法と検索結果の取得方法を理解できます。
getElementsByTagNameNSメソッドは、名前空間を持つXMLやHTMLドキュメントから要素を検索する際に用います。第一引数の$namespaceには、要素が属する名前空間のURIを正確に指定することが重要です。標準的なHTML要素は名前空間を持たないため、それらを検索する際には$namespaceにnullを指定してください。空文字列を指定すると意図しない結果となる場合があります。
メソッドの戻り値はDom\HTMLCollectionオブジェクトであり、要素が見つからない場合は空のコレクションが返されます。そのため、count()メソッドで要素の有無を確認してからループ処理を行うと安全です。また、loadHTMLメソッドはHTMLの構文エラーによって失敗する可能性があるため、実運用ではエラーハンドリングを適切に行うことを検討してください。大規模なドキュメントに対して頻繁に検索を行う場合は、パフォーマンスへの影響も考慮が必要です。