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

Copy
1<?php
2
3/**
4 * XMLドキュメント内のDOM要素の名前空間URIを取得する方法を示します。
5 *
6 * この関数は、XMLにおける「名前空間（namespace）」の概念を理解するのに役立ちます。
7 * PHP言語自体の「namespace」機能とは異なりますが、名前の衝突を避けるための同様の目的を持ちます。
8 */
9function demonstrateDomElementNamespaceURI(): void
10{
11    // 名前空間を持つXML文字列を定義します。
12    // 'xmlns:ex' は 'http://example.com/ns' というURIを 'ex' というプレフィックスに関連付けています。
13    $xmlString = <<<XML
14<root xmlns:ex="http://example.com/ns">
15    <ex:item>これは名前空間を持つ要素です。</ex:item>
16    <simpleItem>これは名前空間を持たない要素です。</simpleItem>
17</root>
18XML;
19
20    // DOMDocumentオブジェクトを作成し、XML文字列をロードします。
21    $dom = new DOMDocument();
22    // loadXML()はXML文字列をパースし、DOMDocumentオブジェクトにノード構造を構築します。
23    $dom->loadXML($xmlString);
24
25    // DOMXPathオブジェクトを作成し、XML要素を効率的に検索できるようにします。
26    $xpath = new DOMXPath($dom);
27    // XPathで名前空間プレフィックスを使用するには、registerNamespace()でURIとプレフィックスを関連付ける必要があります。
28    $xpath->registerNamespace('ex', 'http://example.com/ns');
29
30    // 名前空間を持つ要素をXPathで検索します。
31    // '//ex:item' は、'ex'名前空間に属する'item'要素をドキュメント全体から検索します。
32    $namespacedItems = $xpath->query('//ex:item');
33
34    if ($namespacedItems instanceof DOMNodeList && $namespacedItems->length > 0) {
35        /** @var DOMElement $namespacedElement */
36        // 最初の要素を取得します。
37        $namespacedElement = $namespacedItems->item(0);
38
39        // DOMElement::namespaceURI プロパティは、要素が属する名前空間のURIを返します。
40        // このURIはXMLのxmlns属性で定義されたものです。
41        echo "名前空間を持つ要素 '<{$namespacedElement->nodeName}>' の namespaceURI: "
42            . $namespacedElement->namespaceURI . "\n";
43    }
44
45    // 名前空間を持たない要素をXPathで検索します。
46    // '//simpleItem' は、名前空間に属さない'simpleItem'要素を検索します。
47    $simpleItems = $xpath->query('//simpleItem');
48
49    if ($simpleItems instanceof DOMNodeList && $simpleItems->length > 0) {
50        /** @var DOMElement $simpleElement */
51        // 最初の要素を取得します。
52        $simpleElement = $simpleItems->item(0);
53
54        // 名前空間を持たない要素の場合、namespaceURIプロパティは null を返します。
55        echo "名前空間を持たない要素 '<{$simpleElement->nodeName}>' の namespaceURI: "
56            . ($simpleElement->namespaceURI ?? 'null') . "\n";
57    }
58}
59
60// 関数を実行して、DOMElement::namespaceURIプロパティの動作を確認します。
61demonstrateDomElementNamespaceURI();

DOMElement::namespaceURI プロパティは、XMLドキュメント内のDOM要素がどの名前空間に属しているかを示すURI（Uniform Resource Identifier）を取得するために利用されます。

XMLにおける「名前空間」とは、異なるアプリケーションや仕様で同じ名前の要素や属性が使われた場合に、名前の衝突を避けるための仕組みです。これは、PHP言語自体のコードを整理するために使う「namespace」機能とは別の、XML文書独自の概念です。

このプロパティは引数を取りません。戻り値は string または null です。要素が特定の名前空間に属している場合、その名前空間のURIが文字列として返されます。もし要素がどの名前空間にも属していない場合、このプロパティは null を返します。

サンプルコードでは、名前空間（ex:item）を持つ要素と、名前空間を持たない要素（simpleItem）を含むXML文書を例に挙げています。名前空間を持つ要素に対して namespaceURI プロパティを参照すると、XML内で定義されたURI (http://example.com/ns) が取得されます。一方、名前空間を持たない要素に対して同じプロパティを参照すると null が返されることが確認でき、プロパティの挙動が明確に示されています。このプロパティは、XMLドキュメントの内容を正確に解析し、操作する際に重要な役割を果たします。

Copy
1<?php
2
3// PHP 8 の DOMElement::namespaceURI プロパティの使用例を示します。
4// キーワード「php namespace use」に基づき、使用するクラスを use ステートメントで明示します。
5
6use DOMDocument; // XMLドキュメント操作のためにDOMDocumentクラスをインポートします。
7use DOMElement;  // DOM要素の型ヒントのためにDOMElementクラスをインポートします。
8
9/**
10 * XMLから特定のDOM要素の名前空間URIを取得し、表示します。
11 * DOMElement::namespaceURI は、要素の名前空間URIを文字列で返します。
12 * 名前空間が存在しない場合は null を返します。
13 *
14 * @param string $xmlString 処理対象のXML文字列。
15 */
16function displayElementNamespaceUris(string $xmlString): void
17{
18    echo "--- XML Namespace URI の取得 ---" . PHP_EOL;
19    echo "処理対象XML:\n" . $xmlString . PHP_EOL . PHP_EOL;
20
21    // DOMDocumentオブジェクトを作成し、XML文字列をロードします。
22    // @ を付けて XML の解析エラーに関する警告を非表示にしています（実運用ではより詳細なエラーハンドリングを推奨）。
23    $dom = new DOMDocument();
24    @$dom->loadXML($xmlString);
25
26    // 名前空間を持つ要素 '<ns:data>' を取得します。
27    // getElementsByTagNameNS は指定された名前空間URIとローカル名で要素を検索します。
28    $elementsWithNs = $dom->getElementsByTagNameNS('http://example.com/ns', 'data');
29    if ($elementsWithNs->length > 0) {
30        // 最初の要素を取得します。
31        /** @var DOMElement $element */
32        $element = $elementsWithNs->item(0);
33        // DOMElement::namespaceURI プロパティの値を出力します。
34        // null の場合は '[名前空間なし]' と表示します。
35        echo "要素 '<ns:data>' の名前空間URI: " . ($element->namespaceURI ?? '[名前空間なし]') . PHP_EOL;
36    } else {
37        echo "要素 '<ns:data>' が見つかりませんでした。" . PHP_EOL;
38    }
39
40    // 名前空間を持たない要素 '<item>' を取得します。
41    // getElementsByTagName は名前空間に関わらずローカル名で要素を検索します。
42    $elementsWithoutNs = $dom->getElementsByTagName('item');
43    if ($elementsWithoutNs->length > 0) {
44        // 最初の要素を取得します。
45        /** @var DOMElement $element */
46        $element = $elementsWithoutNs->item(0);
47        // 名前空間を持たない要素の場合、namespaceURI は null を返します。
48        echo "要素 '<item>' の名前空間URI: " . ($element->namespaceURI ?? '[名前空間なし]') . PHP_EOL;
49    } else {
50        echo "要素 '<item>' が見つかりませんでした。" . PHP_EOL;
51    }
52
53    echo PHP_EOL;
54}
55
56// サンプルXMLデータ
57$sampleXml = <<<XML
58<?xml version="1.0" encoding="UTF-8"?>
59<root xmlns:ns="http://example.com/ns">
60    <ns:data id="1">
61        <value>Hello Namespace</value>
62    </ns:data>
63    <item id="2">
64        <value>No Namespace</value>
65    </item>
66</root>
67XML;
68
69// 関数を実行して名前空間URIを表示します。
70displayElementNamespaceUris($sampleXml);

PHP 8のDOMElement::namespaceURIプロパティは、XML文書内の特定のDOM要素が持つ名前空間URIを取得するために使用されます。このプロパティは引数を取らず、戻り値として要素の名前空間URIを文字列で返すか、要素が名前空間を持たない場合はnullを返します。

提供されたサンプルコードでは、まずuseステートメントを使用してDOMDocumentとDOMElementクラスをインポートし、コードの可読性を高めています。次に、DOMDocumentクラスのloadXML()メソッドを用いてXML文字列をロードし、その構造を操作可能なオブジェクトとして扱います。

コード内では、名前空間を持つ<ns:data>要素と、名前空間を持たない<item>要素の二つを例に、namespaceURIの挙動を示しています。<ns:data>要素に対してnamespaceURIプロパティにアクセスすると、定義された名前空間URIであるhttp://example.com/nsという文字列が取得されます。一方、<item>要素のように名前空間が明示されていない場合、namespaceURIプロパティはnullを返します。サンプルコードでは、このnullの場合に'[名前空間なし]'と表示するように??演算子を用いて処理しており、XML要素の名前空間の有無に応じた正確なURIの取得方法を理解できます。