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

Copy
1<?php
2
3/**
4 * Dom\XMLDocument::getElementsByTagNameNS の使用例
5 *
6 * この関数は、XMLドキュメントから指定された名前空間URIとローカル名を持つ
7 * すべての要素（Dom\Elementオブジェクト）を Dom\NodeList として取得する方法を示します。
8 * システムエンジニアを目指す初心者の方にも理解しやすいよう、XMLの読み込みから
9 * 検索、結果の表示までを簡潔にまとめています。
10 */
11function exampleGetElementsByTagNameNS(): void
12{
13    // 1. サンプルXMLデータの準備
14    // 名前空間 (xmlns と xmlns:data) を含むXML文字列を定義します。
15    $xmlString = <<<XML
16<?xml version="1.0" encoding="UTF-8"?>
17<bookstore xmlns="http://example.com/ns/main" xmlns:data="http://example.com/ns/metadata">
18    <book id="bk101">
19        <title>XML Basics</title>
20        <data:author>John Doe</data:author>
21        <price>29.99</price>
22    </book>
23    <book id="bk102">
24        <title>PHP for Beginners</title>
25        <data:author>Jane Smith</data:author>
26        <price>39.99</price>
27    </book>
28    <book id="bk103">
29        <!-- 名前空間を持たないauthorタグ -->
30        <author>Unknown Author</author>
31    </book>
32</bookstore>
33XML;
34
35    // 2. Dom\XMLDocument オブジェクトの作成とXMLのロード
36    // Dom\XMLDocument は、XMLドキュメントをオブジェクトとして操作するためのクラスです。
37    $dom = new Dom\XMLDocument();
38    // loadXML() メソッドでXML文字列を解析し、ドキュメントオブジェクトに読み込みます。
39    $dom->loadXML($xmlString);
40
41    // 3. getElementsByTagNameNS メソッドの呼び出し (名前空間とローカル名を指定)
42    // 検索したい名前空間URIとローカル名（タグ名）を指定します。
43    // ここでは、名前空間 'http://example.com/ns/metadata' に属する 'author' タグを持つ要素を探します。
44    $targetNamespaceURI = 'http://example.com/ns/metadata';
45    $targetLocalName = 'author';
46
47    echo "--- 検索条件: 名前空間URI = '{$targetNamespaceURI}', ローカル名 = '{$targetLocalName}' ---\n";
48
49    // getElementsByTagNameNS は Dom\NodeList オブジェクトを返します。
50    // Dom\NodeList は、見つかった要素のコレクションです。
51    $authors = $dom->getElementsByTagNameNS($targetNamespaceURI, $targetLocalName);
52
53    // 4. 検索結果の処理と表示
54    if ($authors->count() > 0) {
55        echo "見つかった著者名:\n";
56        // NodeList をループして、各 Dom\Element オブジェクトにアクセスします。
57        foreach ($authors as $authorElement) {
58            // getTextContent() メソッドで要素のテキスト内容を取得します。
59            echo "- " . $authorElement->getTextContent() . "\n";
60        }
61    } else {
62        echo "指定された名前空間とローカル名に一致する要素は見つかりませんでした。\n";
63    }
64
65    echo "\n"; // 結果を見やすくするための区切り
66
67    // 5. 別の検索例: 名前空間を持たない要素を検索する (名前空間URIに null を指定)
68    // getElementsByTagNameNS の最初の引数 $namespace は ?string 型なので null を指定できます。
69    // null を指定すると、名前空間を持たない（接頭辞なしの）要素を検索します。
70    $targetNamespaceURI_null = null;
71    $targetLocalName_noNs = 'author';
72
73    echo "--- 検索条件: 名前空間URI = null (名前空間なし), ローカル名 = '{$targetLocalName_noNs}' ---\n";
74
75    $noNsAuthors = $dom->getElementsByTagNameNS($targetNamespaceURI_null, $targetLocalName_noNs);
76
77    if ($noNsAuthors->count() > 0) {
78        echo "見つかった名前空間を持たない著者名:\n";
79        foreach ($noNsAuthors as $authorElement) {
80            echo "- " . $authorElement->getTextContent() . "\n";
81        }
82    } else {
83        echo "名前空間を持たない '{$targetLocalName_noNs}' 要素は見つかりませんでした。\n";
84    }
85}
86
87// 関数を実行します。
88exampleGetElementsByTagNameNS();
89
90?>

Dom\XMLDocument::getElementsByTagNameNSメソッドは、XMLドキュメントの中から特定の名前空間に属し、かつ指定されたタグ名を持つ要素を効率的に検索するために使用されます。このサンプルコードでは、まず名前空間を含むXML文字列を準備し、Dom\XMLDocumentオブジェクトとして読み込みます。

getElementsByTagNameNSメソッドを呼び出す際、最初の引数$namespaceには検索したい要素の名前空間URI（例: "http://example.com/ns/metadata"）を文字列で指定します。二番目の引数`$localName`には、検索したいタグのローカル名、つまり接頭辞を含まない本来のタグ名（例: "author"）を文字列で指定します。このメソッドは、条件に合致するすべての要素をDom\NodeListオブジェクトとして返します。Dom\NodeListは見つかった要素の集合体であり、繰り返し処理を行うことで各要素にアクセスし、getTextContent()などでその内容を取得できます。

また、$namespace引数にnullを指定すると、XMLドキュメント内で名前空間に属さない要素、つまり名前空間の接頭辞を持たない要素を検索できます。これにより、異なる条件での柔軟な要素検索が可能です。この機能は、XML構造を解析し、特定の情報を抽出するシステム開発で頻繁に活用されます。

Copy
1<?php
2
3// XML文字列を定義します。名前空間（デフォルトおよびプレフィックス付き）を含む要素があります。
4$xmlString = <<<'XML'
5<?xml version="1.0" encoding="UTF-8"?>
6<root xmlns="http://example.com/default-ns">
7    <item>Default Item</item>
8    <book xmlns:b="http://example.com/book-ns">
9        <b:title>PHP Programming</b:title>
10        <b:author>John Doe</b:author>
11        <price>4500</price> <!-- この <price> 要素は親のデフォルト名前空間 (http://example.com/default-ns) に属します -->
12    </book>
13    <magazine>
14        <title>Web Tech News</title> <!-- この <title> 要素は親のデフォルト名前空間 (http://example.com/default-ns) に属します -->
15    </magazine>
16</root>
17XML;
18
19// Dom\XMLDocument オブジェクトを作成します。
20$document = new Dom\XMLDocument();
21
22// XML文字列をロードします。失敗した場合はエラーメッセージを表示して終了します。
23if (!$document->loadXML($xmlString)) {
24    echo "XMLのロードに失敗しました。\n";
25    exit(1);
26}
27
28// --- 例1: 特定の名前空間を持つ要素を検索 ---
29echo "--- 名前空間 'http://example.com/book-ns' の 'title' 要素を検索 ---\n";
30// 指定された名前空間URI (http://example.com/book-ns) とローカル名 (title) に一致する要素を検索します。
31// この例では、<b:title>PHP Programming</b:title> が該当します。
32$bookTitles = $document->getElementsByTagNameNS('http://example.com/book-ns', 'title');
33
34// 検索結果をループして、要素のテキストコンテンツを表示します。
35if ($bookTitles->count() > 0) {
36    foreach ($bookTitles as $titleNode) {
37        echo "見つかったタイトル (book-ns): " . $titleNode->textContent . "\n";
38    }
39} else {
40    echo "指定された名前空間とローカル名に一致する要素は見つかりませんでした。\n";
41}
42
43echo "\n"; // 出力を見やすくするための改行
44
45// --- 例2: デフォルト名前空間を持つ要素を検索 ---
46echo "--- デフォルト名前空間 'http://example.com/default-ns' の 'title' 要素を検索 ---\n";
47// デフォルト名前空間URI (http://example.com/default-ns) とローカル名 (title) に一致する要素を検索します。
48// この例では、<magazine>内の<title>Web Tech News</title> が該当します。
49$magazineTitles = $document->getElementsByTagNameNS('http://example.com/default-ns', 'title');
50
51// 検索結果をループして、要素のテキストコンテンツを表示します。
52if ($magazineTitles->count() > 0) {
53    foreach ($magazineTitles as $titleNode) {
54        echo "見つかったタイトル (default-ns): " . $titleNode->textContent . "\n";
55    }
56} else {
57    echo "指定されたデフォルト名前空間とローカル名に一致する要素は見つかりませんでした。\n";
58}

Dom\XMLDocument::getElementsByTagNameNSメソッドは、XMLドキュメント内から指定された**名前空間（namespace）とタグのローカル名（localName）**に基づいて要素を検索します。これは、XMLにおいて同じタグ名が異なる意味を持つ場合に、名前空間によってそれらを厳密に区別したいときに非常に役立ちます。

第一引数$namespaceには、検索対象となる要素が属する名前空間のURI（URLのような一意な識別子）を文字列で指定します。もし名前空間が指定されていない要素を探したい場合は、この引数をnullに設定します。第二引数$localNameには、タグのプレフィックスを含まない純粋なタグ名（例えば、<b:title>であればtitle）を文字列で指定してください。

このメソッドの戻り値はDom\NodeListオブジェクトです。これは、検索条件に合致したすべての要素がリスト形式で格納されたコレクションで、見つかった要素を順に処理する際に利用できます。もし条件に一致する要素が一つもなかった場合でも、空のDom\NodeListオブジェクトが返されます。

サンプルコードでは、名前空間が定義されたXML文字列を読み込み、このメソッドの具体的な使い方を示しています。最初の例では、http://example.com/book-nsという特定の名前空間に属するtitle要素を検索し、<b:title>要素を正確に見つけ出しています。次の例では、XMLルート要素で定義されたデフォルトの名前空間http://example.com/default-nsに属するtitle要素を検索し、<magazine>内のtitle要素を区別して取得しています。このように、getElementsByTagNameNSはXMLの名前空間を考慮した、より精密な要素の特定を可能にする強力なツールです。