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

Copy
1<?php
2
3/**
4 * DOMDocument::getElementsByTagNameNS を使用して、指定された名前空間と
5 * ローカル名を持つXML要素を検索するサンプル関数。
6 *
7 * システムエンジニアを目指す初心者の方へ:
8 * この関数は、XMLファイル（または文字列）から特定のタグ名の要素を
9 * 取得する方法を示します。特に、XMLの名前空間という仕組みが使われている場合に
10 * どのように要素を探すかを理解するのに役立ちます。
11 */
12function searchXmlElementsByNamespace(): void
13{
14    // 検索対象となるXML文字列を定義します。
15    // ここでは、'book' と 'cd' という2つの異なる名前空間（xmlns属性で定義）を
16    // 持つ要素を含むサンプルXMLを作成しています。
17    $xmlString = <<<XML
18<root xmlns:book="http://example.com/books" xmlns:cd="http://example.com/cds">
19    <item>
20        <book:title>PHPによるWeb開発</book:title>
21        <book:author>山田 太郎</book:author>
22        <price>3500</price>
23    </item>
24    <item>
25        <title>JavaScript入門</title> <!-- これは名前空間なしの 'title' 要素です -->
26        <book:title>PHPとデータベース</book:title>
27        <author>鈴木 花子</author>
28        <cd:title>クラシック音楽集</cd:title> <!-- これは 'cd' 名前空間の 'title' 要素です -->
29        <price>2800</price>
30    </item>
31</root>
32XML;
33
34    // DOMDocumentオブジェクトを作成します。
35    // これがXML文書を操作するための主要なクラスです。
36    $dom = new DOMDocument();
37
38    // XML文字列をロードします。
39    // loadXML() は成功した場合に true を、失敗した場合に false を返します。
40    if (!$dom->loadXML($xmlString)) {
41        echo "エラー: XMLのロードに失敗しました。XML形式が正しいか確認してください。\n";
42        return;
43    }
44
45    echo "--- 名前空間 'http://example.com/books' 内の 'title' 要素を検索 ---\n";
46
47    // getElementsByTagNameNS メソッドを使用して、特定の名前空間とローカル名を持つ要素を取得します。
48    // 第1引数: 名前空間のURI（上記XMLで 'book' プレフィックスに紐づけられたURI）
49    // 第2引数: 要素のローカル名（プレフィックスを含まないタグ名）
50    $bookTitles = $dom->getElementsByTagNameNS('http://example.com/books', 'title');
51
52    // 取得したノードリスト（DOMNodeList）をループして、各要素の内容を表示します。
53    // DOMNodeList は見つかったすべての要素を含むコレクションです。
54    if ($bookTitles->length > 0) {
55        echo "見つかった 'book:title' 要素の数: " . $bookTitles->length . "\n";
56        foreach ($bookTitles as $titleNode) {
57            echo "  - 内容: " . $titleNode->nodeValue . "\n"; // nodeValue で要素のテキストコンテンツを取得
58        }
59    } else {
60        echo "指定された名前空間とローカル名を持つ要素は見つかりませんでした。\n";
61    }
62
63    echo "\n--- 名前空間なしの 'title' 要素を検索 ---\n";
64
65    // 名前空間を持たない（no-namespace）'title' 要素を検索するには、
66    // getElementsByTagNameNS の第1引数に null を指定します。
67    $noNamespaceTitles = $dom->getElementsByTagNameNS(null, 'title');
68
69    if ($noNamespaceTitles->length > 0) {
70        echo "見つかった名前空間なしの 'title' 要素の数: " . $noNamespaceTitles->length . "\n";
71        foreach ($noNamespaceTitles as $titleNode) {
72            echo "  - 内容: " . $titleNode->nodeValue . "\n";
73        }
74    } else {
75        echo "名前空間なしの 'title' 要素は見つかりませんでした。\n";
76    }
77}
78
79// 上で定義した関数を実行します。
80searchXmlElementsByNamespace();

このサンプルコードは、PHPのDOMDocumentクラスが提供するgetElementsByTagNameNSメソッドを使用して、XML文書内から特定の名前空間とローカル名を持つ要素を検索する方法を示しています。まず、DOMDocumentオブジェクトにXML文字列をロードし、XML構造を操作できるように準備します。

getElementsByTagNameNSメソッドは、XMLの名前空間を考慮して要素を探す際に非常に役立ちます。第1引数には検索したい要素の名前空間URIを指定し、第2引数にはプレフィックスを含まない要素のローカル名を指定します。例えば、book:titleのような要素であれば、第1引数にbookプレフィックスが定義しているURI、第2引数にtitleを指定します。名前空間を持たない要素を検索したい場合は、第1引数にnullを指定します。

このメソッドは、条件に合致するすべての要素をDOMNodeListという形式で返します。DOMNodeListは、見つかった要素のコレクションであり、ループ処理を使って各要素の内容（nodeValue）にアクセスできます。サンプルコードでは、まずhttp://example.com/books名前空間内のtitle要素を検索し、次に名前空間を持たないtitle要素を検索して、それぞれの内容を表示しています。これにより、XML文書から目的のデータを効率的に抽出する基本的な手順を理解できます。

Copy
1<?php
2
3/**
4 * DOMDocument::getElementsByTagNameNS メソッドの使用例を示します。
5 * 特定の名前空間URIとローカル名を持つXML要素を検索します。
6 *
7 * このスクリプトは、異なる名前空間に属する書籍や著者の情報を含むXMLデータから、
8 * 指定された条件に合致する要素を抽出する方法を実演します。
9 */
10
11// 検索対象となるXMLデータをヒアドキュメント形式で定義します。
12// ここでは 'book' と 'author' という2つの名前空間プレフィックスを使用し、
13// それぞれ異なるURIにマッピングしています。
14$xmlString = <<<XML
15<?xml version="1.0" encoding="UTF-8"?>
16<catalog xmlns:book="http://example.com/namespaces/book"
17         xmlns:author="http://example.com/namespaces/author">
18    <book:item id="1">
19        <book:title>PHPプログラミング入門</book:title>
20        <author:name>山田 太郎</author:name>
21        <book:price>3500</book:price>
22    </book:item>
23    <book:item id="2">
24        <book:title>JavaScript実践ガイド</book:title>
25        <author:name>田中 花子</author:name>
26        <book:price>2800</book:price>
27    </book:item>
28    <book:item id="3">
29        <book:title>ウェブ開発の基礎</book:title>
30        <!-- この書籍には著者情報がありません -->
31        <book:price>3000</book:price>
32    </book:item>
33</catalog>
34XML;
35
36// DOMDocumentオブジェクトを新しく作成します。
37$dom = new DOMDocument();
38
39// XML文字列をDOMDocumentにロードします。
40// ロードに失敗した場合はエラーメッセージを表示して終了します。
41if ($dom->loadXML($xmlString) === false) {
42    echo "エラー: XMLデータのロードに失敗しました。\n";
43    exit(1);
44}
45
46// 検索したい要素の名前空間URIとローカル名を指定します。
47// 例1: "http://example.com/namespaces/book" 名前空間に属する "title" 要素を検索
48$bookNamespaceURI = 'http://example.com/namespaces/book';
49$titleLocalName = 'title';
50
51echo "--- 検索例 1: 書籍のタイトルを検索 ---\n";
52echo "検索条件: 名前空間URI='{$bookNamespaceURI}', ローカル名='{$titleLocalName}'\n\n";
53
54// getElementsByTagNameNS メソッドを呼び出し、指定された条件に合致する要素をすべて取得します。
55// 戻り値はDOMNodeListオブジェクトで、これはDOMElementオブジェクトのコレクションです。
56$bookTitles = $dom->getElementsByTagNameNS($bookNamespaceURI, $titleLocalName);
57
58// 取得したDOMNodeListをループ処理し、各要素のテキストコンテンツを表示します。
59if ($bookTitles->length > 0) {
60    echo "見つかった書籍タイトル一覧:\n";
61    foreach ($bookTitles as $titleNode) {
62        // DOMElementオブジェクトはtextContentプロパティで要素のテキスト内容にアクセスできます。
63        echo "- " . $titleNode->textContent . "\n";
64    }
65} else {
66    echo "指定された条件に一致する書籍タイトルは見つかりませんでした。\n";
67}
68
69// 例2: "http://example.com/namespaces/author" 名前空間に属する "name" 要素を検索
70$authorNamespaceURI = 'http://example.com/namespaces/author';
71$authorLocalName = 'name';
72
73echo "\n--- 検索例 2: 著者の名前を検索 ---\n";
74echo "検索条件: 名前空間URI='{$authorNamespaceURI}', ローカル名='{$authorLocalName}'\n\n";
75
76$authorNames = $dom->getElementsByTagNameNS($authorNamespaceURI, $authorLocalName);
77
78if ($authorNames->length > 0) {
79    echo "見つかった著者名一覧:\n";
80    foreach ($authorNames as $authorNode) {
81        echo "- " . $authorNode->textContent . "\n";
82    }
83} else {
84    echo "指定された条件に一致する著者名は見つかりませんでした。\n";
85}
86
87// 例3: 存在しない名前空間/ローカル名で検索した場合
88$nonExistentNamespaceURI = 'http://example.com/namespaces/nonexistent';
89$nonExistentLocalName = 'data';
90
91echo "\n--- 検索例 3: 存在しない要素を検索 ---\n";
92echo "検索条件: 名前空間URI='{$nonExistentNamespaceURI}', ローカル名='{$nonExistentLocalName}'\n\n";
93
94$nonExistentNodes = $dom->getElementsByTagNameNS($nonExistentNamespaceURI, $nonExistentLocalName);
95
96if ($nonExistentNodes->length > 0) {
97    echo "見つかった要素一覧:\n";
98    foreach ($nonExistentNodes as $node) {
99        echo "- " . $node->textContent . "\n";
100    }
101} else {
102    echo "指定された条件に一致する要素は見つかりませんでした。\n";
103}
104
105?>

DOMDocument::getElementsByTagNameNSメソッドは、PHPでXML文書を扱う際に、特定の名前空間URIとローカル名を持つ要素をすべて検索するための重要な機能です。このメソッドは、XMLファイルや文字列からロードされたDOMDocumentオブジェクトに対して使用され、XML内の構造化されたデータを効率的に抽出するのに役立ちます。

メソッドの引数として、まず$namespaceには検索したい要素の名前空間URIを指定します。これはXML内で定義されたプレフィックスではなく、完全なURIで指定する必要がある点に注意が必要です。$localNameには、名前空間に属する要素のローカル名（プレフィックスを含まないタグ名）を指定します。これらの情報に基づいてXMLツリー全体を探索し、条件に合致するすべての要素をまとめて取得します。

戻り値はDOMNodeListオブジェクトで、これは見つかったDOMElementオブジェクトのコレクションです。見つかった要素は、このDOMNodeListをループ処理することで一つずつ取り出し、その内容（例えばtextContentプロパティ）にアクセスできます。名前空間を考慮することで、同じローカル名を持つ要素であっても異なる名前空間に属していれば区別して検索できるため、複雑なXML構造から正確な情報を抽出する際に非常に有効です。サンプルコードでは、書籍と著者の異なる名前空間を持つXMLデータから、それぞれのタイトルや名前を抽出する具体的な例を示しています。