【PHP8.x】DOMDocument::namespaceURIプロパティの使い方

Copy
1<?php
2
3/**
4 * XMLドキュメント内の名前空間URIを取得するサンプルコード。
5 *
6 * このコードは、PHPのDOMDocument拡張機能を使用してXMLドキュメントを解析し、
7 * その中のXML要素が持つ名前空間URI (namespaceURI) を取得する方法を示します。
8 *
9 * 【キーワード「php namespaceとは」について】
10 * PHPの「namespace」キーワード（例: `namespace App\Model;`）は、PHPコード内で
11 * クラス、関数、定数などの名前の衝突を防ぎ、コードを論理的に整理するための仕組みです。
12 *
13 * 一方、このサンプルコードで扱うXMLの名前空間（namespaceURI）は、XMLドキュメント内で
14 * 要素名や属性名が衝突するのを防ぐために使われるURIベースの識別子です。
15 * これらは「名前空間」という同じ言葉を使いますが、それぞれ異なる目的と文脈で利用されます。
16 *
17 * 【リファレンス情報「DOMDocument::namespaceURI」について】
18 * 提供されたリファレンス情報では「所属クラス: DOMDocument」とありますが、
19 * 実際には`DOMDocument`クラス自体に`namespaceURI`プロパティは存在しません。
20 * `namespaceURI`プロパティは、XMLドキュメント内の個々の要素 (`DOMElement`) や属性 (`DOMAttr`)
21 * など、`DOMNode`を継承するオブジェクトが持ちます。
22 * このサンプルコードでは、`DOMDocument`を使ってXMLをロードした後、
23 * ドキュメントのルート要素（`DOMElement`型）から`namespaceURI`を取得する例を示します。
24 */
25function getXmlElementNamespaceUri(): void
26{
27    // 名前空間を含むXML文字列を定義
28    $xmlString = <<<XML
29<?xml version="1.0" encoding="UTF-8"?>
30<root xmlns="http://example.com/ns/default" xmlns:pref="http://example.com/ns/prefix">
31    <element1>これはデフォルト名前空間の要素です</element1>
32    <pref:element2>これは'pref'プレフィックス付き名前空間の要素です</pref:element2>
33    <noNsElement>これは名前空間を持たない要素です</noNsElement>
34</root>
35XML;
36
37    // DOMDocumentオブジェクトを初期化
38    $dom = new DOMDocument();
39    // XMLを整形して出力する場合に備え、formatOutputをtrueに設定
40    $dom->formatOutput = true;
41
42    // XML文字列をロード
43    // ロードが成功したかを確認します。
44    if (!$dom->loadXML($xmlString)) {
45        echo "XMLのロードに失敗しました。\n";
46        // エラー詳細が必要な場合は libxml_get_errors() を使用
47        return;
48    }
49
50    echo "--- XML 名前空間の調査 ---\n\n";
51
52    // 1. ドキュメントのルート要素の名前空間URIを取得
53    // DOMDocumentのdocumentElementプロパティは、ドキュメントのルート要素をDOMElementオブジェクトとして返します。
54    $rootElement = $dom->documentElement;
55
56    if ($rootElement instanceof DOMElement) {
57        echo "ルート要素 ('" . $rootElement->nodeName . "') の情報:\n";
58        // namespaceURIプロパティはstringまたはnullを返すため、null合体演算子 (??) で 'なし' を表示
59        echo "  名前空間URI: " . ($rootElement->namespaceURI ?? 'なし') . "\n";
60        echo "  テキストコンテンツ: " . $rootElement->textContent . "\n\n";
61    } else {
62        echo "エラー: ルート要素が見つかりませんでした。\n\n";
63    }
64
65    // 2. XPathを使って個々の要素の名前空間URIを取得する例
66    // DOMXPathは、XMLドキュメントから特定の要素を検索するために使われます。
67    $xpath = new DOMXPath($dom);
68
69    // デフォルト名前空間の要素を検索する場合、XPathではプレフィックスを割り当てる必要があります。
70    // ここでは 'def' というプレフィックスを割り当てて検索します。
71    $xpath->registerNamespace('def', 'http://example.com/ns/default');
72    $elementsInDefaultNs = $xpath->query('//def:element1');
73
74    if ($elementsInDefaultNs && $elementsInDefaultNs->length > 0) {
75        /** @var DOMElement $element */
76        $element = $elementsInDefaultNs->item(0);
77        echo "デフォルト名前空間内の要素 ('" . $element->nodeName . "') の情報:\n";
78        echo "  名前空間URI: " . ($element->namespaceURI ?? 'なし') . "\n";
79        echo "  テキストコンテンツ: " . $element->textContent . "\n\n";
80    }
81
82    // 'pref'プレフィックス付き名前空間の要素を検索
83    // XPathでは、XML内で定義されたプレフィックスをそのまま使用できます。
84    $elementsInPrefixedNs = $xpath->query('//pref:element2');
85
86    if ($elementsInPrefixedNs && $elementsInPrefixedNs->length > 0) {
87        /** @var DOMElement $element */
88        $element = $elementsInPrefixedNs->item(0);
89        echo "プレフィックス付き名前空間内の要素 ('" . $element->nodeName . "') の情報:\n";
90        echo "  名前空間URI: " . ($element->namespaceURI ?? 'なし') . "\n";
91        echo "  テキストコンテンツ: " . $element->textContent . "\n\n";
92    }
93
94    // 名前空間を持たない要素を検索
95    $noNsElements = $xpath->query('//noNsElement');
96
97    if ($noNsElements && $noNsElements->length > 0) {
98        /** @var DOMElement $element */
99        $element = $noNsElements->item(0);
100        echo "名前空間を持たない要素 ('" . $element->nodeName . "') の情報:\n";
101        echo "  名前空間URI: " . ($element->namespaceURI ?? 'なし') . " (nullの場合は「なし」と表示されます)\n";
102        echo "  テキストコンテンツ: " . $element->textContent . "\n";
103    }
104}
105
106// 関数を実行して結果を表示
107getXmlElementNamespaceUri();

このサンプルコードは、PHP 8のDOMDocument拡張機能を利用し、XMLドキュメント内の要素が持つ名前空間URIを取得する方法を、システムエンジニアを目指す初心者向けに紹介しています。namespaceURIとは、XMLの要素や属性がどの名前空間に属しているかを識別するためのURI文字列のことです。

「php namespaceとは」というキーワードについて、PHPコードで使われるnamespaceキーワード（例: namespace App\Model;）は、PHPのクラスや関数などの名前が衝突するのを防ぎ、コードを整理するための仕組みです。これに対し、XMLの名前空間（namespaceURI）は、XMLドキュメント内で要素名や属性名が衝突するのを避けるために使われる、URIで識別される仕組みであり、両者は異なる目的で使われる概念です。

リファレンス情報ではDOMDocumentクラスにnamespaceURIプロパティが所属するとされていますが、実際にはXML内の個々の要素（DOMElementオブジェクト）や属性がこのプロパティを持ちます。このプロパティは引数を取らず、戻り値として名前空間URIを文字列（string）で返します。もし要素が名前空間を持たない場合はnullが返されます。

サンプルコードでは、名前空間が定義されたXML文字列をDOMDocumentに読み込みます。その後、ドキュメントのルート要素や、XPathを使って検索した特定の要素からnamespaceURIプロパティにアクセスし、その要素がどの名前空間に属しているか、あるいは名前空間を持たないかを確認して表示しています。これにより、XMLの名前空間の仕組みと、PHPでそれを扱う方法を具体的に理解できます。

Copy
1<?php
2
3/**
4 * XMLドキュメント内の要素から名前空間URIを取得し、その動作を示す関数です。
5 * DOMDocument クラスが持つ DOMNode::namespaceURI プロパティの使用例を示します。
6 *
7 * @param string $xmlString 処理するXML文字列
8 */
9function demonstrateDOMNamespaceURI(string $xmlString): void
10{
11    // 新しい DOMDocument オブジェクトを作成
12    $dom = new DOMDocument();
13
14    // XML文字列をロードします。
15    // エラーが発生した場合、loadXML() は false を返します。
16    if (!$dom->loadXML($xmlString)) {
17        echo "エラー: XMLの読み込みに失敗しました。\n";
18        return;
19    }
20
21    // DOMXPath オブジェクトを作成し、XPathクエリを使用して特定の要素を検索できるようにします。
22    $xpath = new DOMXPath($dom);
23
24    echo "--- DOMNode::namespaceURI プロパティのデモンストレーション ---\n\n";
25
26    // 1. デフォルト名前空間を持つ要素の namespaceURI を取得する例
27    // XPathでデフォルト名前空間の要素を正確に選択するには、名前空間を登録する必要があります。
28    $defaultNsUri = 'http://example.com/default-ns';
29    $xpath->registerNamespace('d', $defaultNsUri); // 'd' というプレフィックスでデフォルト名前空間を登録
30
31    $child1Element = $xpath->query('//d:child1')->item(0);
32    if ($child1Element instanceof DOMElement) {
33        echo "要素 '<child1>' (デフォルト名前空間: '$defaultNsUri') の namespaceURI:\n";
34        echo "  " . ($child1Element->namespaceURI ?? "null (名前空間なし)") . "\n\n";
35    }
36
37    // 2. プレフィックス付き名前空間を持つ要素の namespaceURI を取得する例
38    $prefixNsUri = 'http://example.com/prefix-ns';
39    $xpath->registerNamespace('p', $prefixNsUri); // 'p' というプレフィックスでカスタム名前空間を登録
40
41    $child2Element = $xpath->query('//p:child2')->item(0);
42    if ($child2Element instanceof DOMElement) {
43        echo "要素 '<prefix:child2>' (プレフィックス付き名前空間: '$prefixNsUri') の namespaceURI:\n";
44        echo "  " . ($child2Element->namespaceURI ?? "null (名前空間なし)") . "\n\n";
45    }
46
47    // 3. 名前空間を明示的に解除した要素の namespaceURI を取得する例
48    // xmlns="" はその要素とその子孫要素から名前空間を解除します。
49    $child3Element = $xpath->query('//child3')->item(0); // 名前空間が解除されているためプレフィックスなしで検索
50    if ($child3Element instanceof DOMElement) {
51        echo "要素 '<child3>' (xmlns=\"\" で名前空間解除) の namespaceURI:\n";
52        echo "  " . ($child3Element->namespaceURI ?? "null (名前空間なし)") . "\n\n";
53    }
54
55    // 4. DOMDocument オブジェクト自体の namespaceURI
56    // DOMDocument オブジェクト自身は、特定の名前空間に属さないため通常 null を返します。
57    echo "DOMDocument オブジェクト自体の namespaceURI:\n";
58    echo "  " . ($dom->namespaceURI ?? "null (名前空間なし)") . "\n\n";
59
60    echo "-----------------------------------------------------\n";
61}
62
63// サンプルとして使用するXML文字列
64// root要素にデフォルト名前空間を定義し、異なる名前空間を持つ子要素を含めます。
65$sampleXml = <<<XML
66<root xmlns="http://example.com/default-ns">
67    <child1>これはデフォルト名前空間に属する要素です。</child1>
68    <prefix:child2 xmlns:prefix="http://example.com/prefix-ns">
69        これは 'prefix' というプレフィックス付き名前空間に属する要素です。
70    </prefix:child2>
71    <child3 xmlns="">これは名前空間が明示的に解除された要素です。</child3>
72</root>
73XML;
74
75// 関数を実行して、DOMNode::namespaceURI の動作を確認します。
76demonstrateDOMNamespaceURI($sampleXml);
77

PHPのDOMNode::namespaceURIプロパティは、XMLドキュメント内の特定の要素がどの名前空間に属しているかを示すURI（Uniform Resource Identifier）を取得するために使用されます。名前空間とは、XML要素の名前が重複した際に、異なるものとして区別するための仕組みです。

このプロパティは引数を取らず、要素が属する名前空間のURIを文字列型で返します。もし要素がどの名前空間にも属さない場合はnullが戻り値となります。

提供されたサンプルコードでは、DOMDocumentクラスを用いてXML文字列をロードし、DOMXPathで特定の要素を検索しています。そして、各要素に対してnamespaceURIプロパティを適用し、その値を出力しています。具体的には、デフォルト名前空間を持つ要素、プレフィックス付き名前空間を持つ要素、さらにはxmlns=""で名前空間が明示的に解除された要素のURIを取得する例を示しています。名前空間を解除された要素や、DOMDocumentオブジェクト自身のように名前空間に属さないものからはnullが返される様子も確認できます。このプロパティを理解することで、XMLドキュメント内で特定の名前空間に属する要素を正確に識別し、処理する能力を身につけることができます。