【PHP8.x】Dom\HTMLElement::getElementsByTagNameNS()メソッドの使い方
getElementsByTagNameNSメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
getElementsByTagNameNSメソッドは、Dom\HTMLElementクラスに属し、HTMLやXMLドキュメント内で指定された名前空間URIとローカル名を持つ子孫要素のリストを取得するために使用されるメソッドです。
このメソッドは、名前空間を使用する複雑なドキュメント構造をプログラム的に解析する際に活用されます。第一引数には検索したい要素の名前空間URIを文字列で指定します。例えば、SVG要素であればhttp://www.w3.org/2000/svgといったURIです。全ての子孫要素を対象とする場合は*（アスタリスク）を指定できます。第二引数には検索したい要素のローカル名を文字列で指定します。例えば、pathやrectといったタグ名です。こちらも全てのローカル名を対象とする場合は*を指定できます。
メソッドは、該当する要素のリストをDom\HTMLCollectionオブジェクトとして返します。このコレクションはライブコレクションであり、元となるドキュメントツリーに変更が加えられると、その変更が自動的に反映されます。
システムエンジニアを目指す初心者の方々にとって、Webアプリケーション開発においてHTMLドキュメント内に埋め込まれたSVGなどのXML名前空間を持つコンテンツから、特定の要素を効率的に抽出し操作する場面で非常に役立ちます。これにより、名前空間を持つ要素の検索と動的な操作を正確かつ簡潔に行うことができます。
構文(syntax)
1<?php 2$domDocument = new Dom\Document(); 3$domDocument->loadHTML('<html xmlns:prefix="http://example.com/namespace-uri"><body><prefix:element-name></prefix:element-name></body></html>'); 4 5$domHTMLElementContext = $domDocument->getElementsByTagName('body')->item(0); 6 7$targetNamespaceURI = 'http://example.com/namespace-uri'; 8$targetLocalName = 'element-name'; 9 10$resultingDomHTMLCollection = $domHTMLElementContext->getElementsByTagNameNS($targetNamespaceURI, $targetLocalName); 11?>
引数(parameters)
?string $namespace, string $localName
- ?string $namespace: 対象の要素のXML名前空間URIを指定します。省略可能で、指定しない場合は名前空間を考慮しません。
- string $localName: 検索したい要素のローカル名（名前空間プレフィックスを含まない名前）を指定します。
戻り値(return)
Dom\NodeList
指定された名前空間に一致する要素のリストを Dom\NodeList オブジェクトとして返します。
サンプルコード
PHP Dom::getElementsByTagNameNSで要素を検索する
1<?php 2 3/** 4 * PHP 8の Dom\HTMLElement::getElementsByTagNameNS メソッドの使用例を示します。 5 * 指定されたHTML文字列から、名前空間とローカル名に基づいて要素を検索します。 6 * 7 * システムエンジニアを目指す初心者向けに、DOM操作の基本と名前空間の概念を 8 * 簡潔に理解できるよう設計されています。 9 * 10 * @return void 11 */ 12function exampleGetElementsByTagNameNS(): void 13{ 14 // 検索対象となるHTML文字列。SVGやカスタム名前空間の要素を含めます。 15 $htmlString = <<<HTML 16<!DOCTYPE html> 17<html xmlns="http://www.w3.org/1999/xhtml"> 18<head> 19 <title>PHP Dom\HTMLElement::getElementsByTagNameNS サンプル</title> 20</head> 21<body> 22 <h1>要素検索のデモンストレーション</h1> 23 <p>これは標準的なHTMLの段落です。</p> 24 25 <!-- SVG要素は 'http://www.w3.org/2000/svg' 名前空間に属します --> 26 <svg xmlns="http://www.w3.org/2000/svg" width="100" height="100"> 27 <circle cx="50" cy="50" r="40" stroke="black" stroke-width="3" fill="red" /> 28 <rect x="10" y="10" width="80" height="80" fill="blue" /> 29 </svg> 30 31 <!-- カスタム名前空間を持つ要素の例 --> 32 <div xmlns:app="http://example.com/myapp"> 33 <app:data id="item1">データ1</app:data> 34 <app:data id="item2">データ2</app:data> 35 <p>この段落はカスタム名前空間のdiv内にありますが、名前空間はデフォルトです。</p> 36 </div> 37 38 <p xmlns="http://www.w3.org/1999/xhtml">これは明示的にXHTML名前空間を指定した段落です。</p> 39</body> 40</html> 41HTML; 42 43 // DOMDocument オブジェクトを初期化し、HTML文字列をロードします。 44 // loadHTML() は非整形式HTMLで警告を発することがあるため、@で抑制しています。 45 $dom = new DOMDocument(); 46 @$dom->loadHTML($htmlString); 47 48 // Dom\HTMLElement::getElementsByTagNameNS を呼び出すための HTMLElement インスタンスを取得します。 49 // ここでは<body>要素を検索の起点とします。DOMDocument::getElementsByTagName は DOMNodeList を返します。 50 // item(0) で最初の要素を取得します。 51 $bodyElement = $dom->getElementsByTagName('body')->item(0); 52 53 // 取得した要素が Dom\HTMLElement のインスタンスであることを確認します。 54 // PHP 8 では、DOMElement の子孫として Dom\HTMLElement が提供されます。 55 if (!$bodyElement instanceof \Dom\HTMLElement) { 56 echo "エラー: body要素がDom\\HTMLElementインスタンスとして認識されませんでした。\n"; 57 echo "このサンプルコードは、PHP 8環境でDom拡張が有効であることを前提としています。\n"; 58 return; 59 } 60 61 echo "--- Dom\\HTMLElement::getElementsByTagNameNS の検索結果 ---\n\n"; 62 63 // 1. SVG 名前空間から 'rect' 要素を検索する例 64 $namespaceSvg = 'http://www.w3.org/2000/svg'; 65 $localNameRect = 'rect'; 66 echo "◆ SVG名前空間 ('{$namespaceSvg}') の '{$localNameRect}' 要素を検索:\n"; 67 $svgRects = $bodyElement->getElementsByTagNameNS($namespaceSvg, $localNameRect); 68 // 検索結果 (Dom\NodeList) をループして各要素の情報を表示 69 foreach ($svgRects as $rect) { 70 echo " - 見つかった要素: <{$rect->tagName}> (名前空間URI: {$rect->namespaceURI})\n"; 71 echo " 属性: x=\"{$rect->getAttribute('x')}\", y=\"{$rect->getAttribute('y')}\", fill=\"{$rect->getAttribute('fill')}\"\n"; 72 } 73 if ($svgRects->count() === 0) { 74 echo " - 見つかりませんでした。\n"; 75 } 76 echo "\n"; 77 78 // 2. カスタム名前空間から 'data' 要素を検索する例 79 $namespaceApp = 'http://example.com/myapp'; 80 $localNameData = 'data'; 81 echo "◆ カスタム名前空間 ('{$namespaceApp}') の '{$localNameData}' 要素を検索:\n"; 82 $appDataElements = $bodyElement->getElementsByTagNameNS($namespaceApp, $localNameData); 83 foreach ($appDataElements as $data) { 84 echo " - 見つかった要素: <{$data->tagName}> (名前空間URI: {$data->namespaceURI})\n"; 85 echo " 属性: id=\"{$data->getAttribute('id')}\", テキスト: \"{$data->textContent}\"\n"; 86 } 87 if ($appDataElements->count() === 0) { 88 echo " - 見つかりませんでした。\n"; 89 } 90 echo "\n"; 91 92 // 3. 名前空間なし (null) の 'p' 要素を検索する例 93 // HTML要素は通常、明示的な名前空間を持たないか、XHTML名前空間に属します。 94 // ここでは第一引数に 'null' を指定して、名前空間が明示的に定義されていない要素を検索します。 95 $localNameP = 'p'; 96 echo "◆ 名前空間なし (null) の '{$localNameP}' 要素を検索:\n"; 97 $paragraphsNoNS = $bodyElement->getElementsByTagNameNS(null, $localNameP); 98 foreach ($paragraphsNoNS as $p) { 99 echo " - 見つかった要素: <{$p->tagName}> (名前空間URI: " . ($p->namespaceURI ?? "なし") . ")\n"; 100 echo " テキスト: \"{$p->textContent}\"\n"; 101 } 102 if ($paragraphsNoNS->count() === 0) { 103 echo " - 見つかりませんでした。\n"; 104 } 105 echo "\n"; 106 107 // 4. すべての名前空間 ('*') から 'h1' 要素を検索する例 108 // 第一引数に '*' を指定すると、名前空間の有無にかかわらずローカル名が一致する要素を検索します。 109 $localNameH1 = 'h1'; 110 echo "◆ すべての名前空間 ('*') の '{$localNameH1}' 要素を検索:\n"; 111 $h1Elements = $bodyElement->getElementsByTagNameNS('*', $localNameH1); 112 foreach ($h1Elements as $h1) { 113 echo " - 見つかった要素: <{$h1->tagName}> (名前空間URI: " . ($h1->namespaceURI ?? "なし") . ")\n"; 114 echo " テキスト: \"{$h1->textContent}\"\n"; 115 } 116 if ($h1Elements->count() === 0) { 117 echo " - 見つかりませんでした。\n"; 118 } 119 echo "\n"; 120 121 // 5. 存在しない名前空間/要素の検索例 122 $nonExistentNamespace = 'http://nonexistent.com'; 123 $nonExistentLocalName = 'unknown'; 124 echo "◆ 存在しない名前空間 ('{$nonExistentNamespace}') の '{$nonExistentLocalName}' 要素を検索:\n"; 125 $nonExistent = $bodyElement->getElementsByTagNameNS($nonExistentNamespace, $nonExistentLocalName); 126 if ($nonExistent->count() === 0) { 127 echo " - 見つかりませんでした。\n"; 128 } else { 129 echo " - 予期せぬ要素が見つかりました。\n"; 130 } 131 echo "\n"; 132} 133 134// サンプル関数の実行 135exampleGetElementsByTagNameNS();
「Dom\HTMLElement::getElementsByTagNameNS」は、PHPでHTMLやXMLドキュメントを操作する際に、特定の名前空間とタグ名（ローカル名）を持つ要素を検索するためのメソッドです。このメソッドは、Dom\HTMLElementクラスに属し、指定した要素の子孫の中から条件に合致する要素を効率的に見つけ出します。
第一引数$namespaceには検索したい要素の名前空間URIを指定します。例えば、SVG要素であれば「http://www.w3.org/2000/svg」といったURIです。名前空間を持たない要素を検索したい場合は`null`を、名前空間を問わず検索したい場合は`*`を指定できます。第二引数`$localName`には、検索したい要素のタグ名、例えば「rect」や「data」などを指定します。こちらも`*`を指定すると、すべてのローカル名に一致する要素を検索します。
このメソッドは検索に成功すると、見つかった要素の集合をDom\NodeListオブジェクトとして返します。このDom\NodeListは、繰り返し処理を使って各要素にアクセスできます。サンプルコードでは、SVGの<rect>要素やカスタム名前空間を持つ<app:data>要素、さらには名前空間が指定されていない<p>要素など、多様なケースで要素を検索し、その結果を表示しています。名前空間を意識したDOM操作は、複雑なドキュメント構造を扱う上で非常に重要です。
Dom\HTMLElement::getElementsByTagNameNS は、特定の名前空間に属する要素を検索する際に用います。第一引数 $namespace には、http://www.w3.org/2000/svg のような名前空間URIを正確に指定することが重要です。null を渡すと名前空間を持たない要素を、* を渡すとすべての名前空間の要素を検索します。HTMLでは要素の名前空間が検索結果に大きく影響するため、nullや*の使い分けにご注意ください。返される Dom\NodeList は要素のコレクションであり、ループで一つずつ取り出して処理します。また、DOMDocument::loadHTML() での警告抑制は、本番環境では適切なエラーハンドリングに置き換えることを推奨します。
PHP DOM名前空間指定要素検索
1<?php 2 3/** 4 * HTMLドキュメント内の特定名前空間に属する要素を検索するサンプルコードです。 5 * 6 * この関数は、Dom\HTMLElement::getElementsByTagNameNS メソッドを使用して、 7 * HTMLドキュメント内に埋め込まれたSVG要素などの、 8 * 特定の名前空間（Namespace URI）とローカル名（Local Name）を持つ要素を 9 * 検索する方法をシステムエンジニアを目指す初心者向けに示します。 10 */ 11function findSvgElementsInHtml(): void 12{ 13 // 検索対象となるHTMLコンテンツを定義します。 14 // ここでは、HTMLドキュメント内にSVG要素を埋め込んでいます。 15 // SVG要素は 'http://www.w3.org/2000/svg' 名前空間に属します。 16 $htmlContent = <<<'HTML' 17<!DOCTYPE html> 18<html> 19<head> 20 <title>DOM getElementsByTagNameNS Example</title> 21</head> 22<body> 23 <h1>SVG 要素の検索</h1> 24 <div id="main-content"> 25 <p>この段落の下にSVG要素があります。</p> 26 <!-- SVG要素の定義: xmlns属性で名前空間を指定 --> 27 <svg width="300" height="200" xmlns="http://www.w3.org/2000/svg"> 28 <circle cx="50" cy="50" r="40" fill="red" /> 29 <rect x="100" y="20" width="150" height="80" fill="blue" /> 30 </svg> 31 <p>別の段落。</p> 32 </div> 33 <div id="another-svg-container"> 34 <svg width="100" height="100" xmlns="http://www.w3.org/2000/svg"> 35 <circle cx="50" cy="50" r="40" fill="green" /> 36 </svg> 37 </div> 38</body> 39</html> 40HTML; 41 42 // Dom\Document オブジェクトを作成し、HTMLコンテンツを読み込みます。 43 $dom = new Dom\Document(); 44 // HTMLのパースエラーを抑制するためにlibxmlのエラー処理を一時的に無効にします。 45 // 実際のアプリケーションでは、より詳細なエラーハンドリングを推奨します。 46 libxml_use_internal_errors(true); 47 $dom->loadHTML($htmlContent); 48 libxml_use_internal_errors(false); 49 50 // ドキュメントのルート要素（`<html>`タグ）を取得します。 51 // Dom\Document::documentElement は Dom\HTMLElement のインスタンスであり、 52 // ここからgetElementsByTagNameNSメソッドを呼び出します。 53 $htmlElement = $dom->documentElement; 54 55 if (!$htmlElement) { 56 echo "エラー: ドキュメントのルート要素を取得できませんでした。\n"; 57 return; 58 } 59 60 echo "名前空間 'http://www.w3.org/2000/svg' に属する 'circle' 要素を検索しています...\n"; 61 62 // Dom\HTMLElement::getElementsByTagNameNS メソッドを呼び出します。 63 // 第一引数に名前空間URI (SVGの場合 'http://www.w3.org/2000/svg')、 64 // 第二引数に検索したいタグのローカル名 ('circle') を指定します。 65 $svgNamespace = 'http://www.w3.org/2000/svg'; 66 $tagNameToSearch = 'circle'; 67 $circles = $htmlElement->getElementsByTagNameNS($svgNamespace, $tagNameToSearch); 68 69 // 見つかった要素の数を表示します。 70 echo "見つかった '{$tagNameToSearch}' 要素の数: " . $circles->count() . "個\n"; 71 72 // 見つかった各要素の情報を表示します。 73 if ($circles->count() > 0) { 74 foreach ($circles as $index => $circle) { 75 // $circle は Dom\Element (Dom\HTMLElementを継承) のインスタンスです。 76 if ($circle instanceof Dom\Element) { 77 echo " - {$tagNameToSearch} #" . ($index + 1) . ":\n"; 78 echo " タグ名: " . $circle->tagName . "\n"; 79 echo " 名前空間URI: " . $circle->namespaceURI . "\n"; 80 // 属性値の取得例 81 echo " 塗りつぶし色 (fill): " . ($circle->getAttribute('fill') ?: 'N/A') . "\n"; 82 echo " 中心X座標 (cx): " . ($circle->getAttribute('cx') ?: 'N/A') . "\n"; 83 } 84 } 85 } else { 86 echo "指定された名前空間とタグ名を持つ '{$tagNameToSearch}' 要素は見つかりませんでした。\n"; 87 } 88 89 echo "\n----------------------------------------\n"; 90 echo "名前空間 'http://www.w3.org/2000/svg' に属する 'rect' 要素を検索しています...\n"; 91 92 // 別のタグ名 ('rect') で再度検索してみます。 93 $tagNameToSearch = 'rect'; 94 $rects = $htmlElement->getElementsByTagNameNS($svgNamespace, $tagNameToSearch); 95 96 echo "見つかった '{$tagNameToSearch}' 要素の数: " . $rects->count() . "個\n"; 97 if ($rects->count() > 0) { 98 foreach ($rects as $index => $rect) { 99 if ($rect instanceof Dom\Element) { 100 echo " - {$tagNameToSearch} #" . ($index + 1) . ":\n"; 101 echo " タグ名: " . $rect->tagName . "\n"; 102 echo " 名前空間URI: " . $rect->namespaceURI . "\n"; 103 echo " 塗りつぶし色 (fill): " . ($rect->getAttribute('fill') ?: 'N/A') . "\n"; 104 echo " 幅 (width): " . ($rect->getAttribute('width') ?: 'N/A') . "\n"; 105 } 106 } 107 } else { 108 echo "指定された名前空間とタグ名を持つ '{$tagNameToSearch}' 要素は見つかりませんでした。\n"; 109 } 110} 111 112// 上記の関数を実行します。 113findSvgElementsInHtml();
このPHPサンプルコードは、Dom\HTMLElementクラスが提供するgetElementsByTagNameNSメソッドの利用方法を、システムエンジニアを目指す初心者の方に向けて解説しています。このメソッドは、HTMLドキュメント内に埋め込まれたSVGやMathMLといった、特定の「名前空間（Namespace URI）」を持つ要素を、そのローカル名（タグ名）で効率的に検索する際に役立ちます。
メソッドの第一引数には検索したい要素の名前空間URI（?string $namespace）を、第二引数にはその名前空間に属する要素のローカル名（string $localName）を指定します。例えば、SVG要素を検索する場合は、名前空間URIとしてhttp://www.w3.org/2000/svgを指定します。メソッドの戻り値はDom\NodeListオブジェクトで、これは検索条件に一致したすべての要素のコレクションを返します。
サンプルコードでは、まずHTMLコンテンツをDom\Documentオブジェクトに読み込み、そのルート要素である<html>タグからgetElementsByTagNameNSメソッドを呼び出しています。具体的には、HTML内に埋め込まれたSVGの<circle>要素や<rect>要素を、指定されたSVGの名前空間とそれぞれのタグ名で検索しています。検索結果として得られたDom\NodeListから、見つかった要素の総数や、各要素のタグ名、名前空間URI、さらには属性値などを取得し、コンソールに表示しています。このメソッドは、複雑なXML名前空間を持つドキュメント構造から特定の要素を抽出する際に、非常に強力なツールとなります。
getElementsByTagNameNSメソッドは、特にHTML内に埋め込まれたSVGのような、特定の名前空間を持つ要素を検索する際に役立ちます。第一引数には要素の所属する名前空間のURIを正確に指定する必要があり、誤ったURIや存在しない名前空間を指定すると要素は見つかりません。第二引数には検索したい要素のタグ名を指定します。HTMLのパースにはDom\Document::loadHTMLを使用しますが、この際に発生する可能性のあるエラーを適切に処理するため、libxml_use_internal_errorsのような一時的な抑制ではなく、エラーログの確認や例外処理の導入を検討してください。戻り値は常にDom\NodeListオブジェクトであり、要素が見つからなかった場合でも空のリストが返されるため、結果のcount()メソッドで要素の有無を確認してから処理を進めるのが安全です。