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

Copy
1<?php
2
3/**
4 * Dom\Attr::lookupNamespaceURI() の使用例。
5 * XML名前空間のURIを検索する方法を示します。
6 * 特に、プレフィックスなしのデフォルト名前空間（XMLにおける「ルート」のような名前空間）と、
7 * 特定のプレフィックスを持つ名前空間の検索に焦点を当てます。
8 */
9function demonstrateLookupNamespaceURI(): void
10{
11    // 名前空間を含むXML文字列を定義
12    $xmlString = <<<XML
13<root xmlns="http://example.com/default-namespace" xmlns:app="http://example.com/application-namespace">
14    <element app:id="123" data-info="some data">
15        <child app:setting="value" />
16    </element>
17</root>
18XML;
19
20    // DOMDocumentオブジェクトを作成し、XMLをロード
21    $dom = new DOMDocument();
22    $dom->loadXML($xmlString);
23
24    // 'element'タグの最初の要素を取得
25    $element = $dom->getElementsByTagName('element')->item(0);
26
27    if (!$element) {
28        echo "エラー: 'element'要素がXMLに見つかりません。\n";
29        return;
30    }
31
32    echo "--- 'element'要素の属性を調査 ---\n";
33
34    // 1. プレフィックス付き属性 'app:id' の名前空間URIを検索
35    // PHP 8では、DOMAttrクラスはDom\Attrとして名前空間が付けられたクラスになり、
36    // DOMElement::getAttributeNode()はDom\Attrのインスタンスを返します。
37    $appIdAttr = $element->getAttributeNode('app:id'); 
38    if ($appIdAttr instanceof Dom\Attr) {
39        // 'app' プレフィックスに対応する名前空間URIを検索
40        $namespaceURI = $appIdAttr->lookupNamespaceURI('app');
41        echo "属性 'app:id' の 'app' プレフィックスの名前空間URI: " . ($namespaceURI ?? 'null') . "\n";
42    } else {
43        echo "属性 'app:id' が見つからないか、Dom\\Attrインスタンスではありません。\n";
44    }
45
46    // 2. プレフィックスなし属性 'data-info' の名前空間URIを検索
47    //    XMLのデフォルト名前空間が適用されるか確認します。
48    $dataInfoAttr = $element->getAttributeNode('data-info'); 
49    if ($dataInfoAttr instanceof Dom\Attr) {
50        // 引数にnullを渡すと、その属性が属する要素のスコープにおけるデフォルト名前空間URIを検索します。
51        // この場合、<root>要素で定義されたデフォルト名前空間に属します。
52        $namespaceURI = $dataInfoAttr->lookupNamespaceURI(null);
53        echo "属性 'data-info' のデフォルト（null）プレフィックスの名前空間URI: " . ($namespaceURI ?? 'null') . "\n";
54    } else {
55        echo "属性 'data-info' が見つからないか、Dom\\Attrインスタンスではありません。\n";
56    }
57    
58    // 3. 存在しないプレフィックスを指定した場合
59    if ($appIdAttr instanceof Dom\Attr) {
60        $nonExistentNamespaceURI = $appIdAttr->lookupNamespaceURI('unknown');
61        echo "存在しないプレフィックス 'unknown' の名前空間URI: " . ($nonExistentNamespaceURI ?? 'null') . "\n";
62    }
63}
64
65// 関数を実行してDom\Attr::lookupNamespaceURI()の動作を確認
66demonstrateLookupNamespaceURI();

Dom\Attr::lookupNamespaceURI()は、XMLの属性に設定された名前空間のURIを検索するメソッドです。

このメソッドは引数として$prefixを受け取ります。引数に'app'のような文字列を指定すると、そのプレフィックスに対応する名前空間URIを返します。もし引数にnullを指定した場合、その属性が属する要素のスコープで定義されているデフォルトの名前空間URIを検索します。これはXMLのルート要素などで定義される、プレフィックスを持たない名前空間を特定する際に特に有用です。

メソッドは、対応する名前空間URIが見つかればその文字列を返し、見つからなかった場合はnullを返します。PHP 8以降では、このメソッドはDom\Attrクラスのインスタンスに対して呼び出されます。

提供されたサンプルコードでは、app:id属性から'app'プレフィックスの名前空間URIを検索する例や、data-info属性からnullを指定してデフォルト名前空間URIを検索する例を通じて、このメソッドの具体的な挙動を示しています。これにより、XMLデータ内の名前空間の解決方法を実践的に学ぶことができます。

Copy
1<?php
2
3/**
4 * Dom\Attr::lookupNamespaceURI の使用例を示します。
5 * このメソッドは、XMLドキュメント内の属性に指定されたプレフィックスに対応する
6 * 名前空間URIを検索します。
7 *
8 * キーワード「php namespace not found」について:
9 * このメソッドはPHPのコードにおける名前空間（例: `namespace MyProject;`）ではなく、
10 * XMLの名前空間（例: `xmlns:prefix="http://example.com/uri"`）を扱います。
11 * 指定されたプレフィックスに対応するXML名前空間が見つからない場合、nullが返されます。
12 *
13 * @return void
14 */
15function demonstrateDomAttrLookupNamespaceURI(): void
16{
17    // 名前空間を含むXMLドキュメントを定義します。
18    // 'myns' と 'some' というプレフィックスで名前空間を宣言しています。
19    $xmlString = <<<XML
20<root xmlns:myns="http://example.com/myns">
21    <element myns:data="value" plainAttr="some_value">
22        <childElement some:id="123" xmlns:some="http://example.com/some"/>
23    </element>
24</root>
25XML;
26
27    // DOMDocument オブジェクトを作成し、XMLをロードします。
28    $dom = new DOMDocument();
29    // XMLをパースする際に、エラーが発生しないように設定することが望ましいです。
30    // loadXMLは成功した場合true、失敗した場合falseを返します。
31    if (!$dom->loadXML($xmlString)) {
32        echo "XMLのロードに失敗しました。\n";
33        return;
34    }
35
36    // XPath オブジェクトを作成し、XMLドキュメント内の特定のノードを検索するために使用します。
37    $xpath = new DOMXPath($dom);
38
39    echo "--- 既存のプレフィックスを持つ属性の名前空間URIを検索 --- \n";
40    // XPathを使用して 'myns:data' 属性ノードを取得します。
41    // queryメソッドはDOMNodeListを返すため、item(0)で最初の要素を取得します。
42    $mynsAttrNode = $xpath->query('//element/@myns:data')->item(0);
43
44    // 取得したノードが Dom\Attr のインスタンスであることを確認します。
45    if ($mynsAttrNode instanceof Dom\Attr) {
46        echo "属性名: " . $mynsAttrNode->name . "\n";
47        // 'myns' プレフィックスの名前空間URIを検索します。
48        // この属性は親要素で 'myns' プレフィックスが定義されているため、URIが返されます。
49        $namespaceURI = $mynsAttrNode->lookupNamespaceURI('myns');
50        echo "  プレフィックス 'myns' の名前空間URI: " . ($namespaceURI ?? 'null (見つかりません)') . "\n\n";
51
52        // nullプレフィックス（デフォルトの名前空間）を検索します。
53        // このXMLではデフォルトの名前空間が定義されていないため、nullが返されます。
54        $defaultNamespace = $mynsAttrNode->lookupNamespaceURI(null);
55        echo "  nullプレフィックス（デフォルト）の名前空間URI: " . ($defaultNamespace ?? 'null (見つかりません)') . "\n\n";
56    } else {
57        echo "属性 'myns:data' が見つかりませんでした。\n\n";
58    }
59
60    echo "--- プレフィックスを持たない属性、または未定義のプレフィックスを検索 --- \n";
61    // 'plainAttr' 属性ノードを取得します（これはプレフィックスを持ちません）。
62    $plainAttrNode = $xpath->query('//element/@plainAttr')->item(0);
63
64    if ($plainAttrNode instanceof Dom\Attr) {
65        echo "属性名: " . $plainAttrNode->name . "\n";
66        // 存在しないプレフィックス 'nonexistent' の名前空間URIを検索します。
67        // このプレフィックスはXMLドキュメント内で定義されていないため、nullが返されます。
68        $nonExistentURI = $plainAttrNode->lookupNamespaceURI('nonexistent');
69        echo "  プレフィックス 'nonexistent' の名前空間URI: " . ($nonExistentURI ?? 'null (見つかりません)') . "\n\n";
70    } else {
71        echo "属性 'plainAttr' が見つかりませんでした。\n\n";
72    }
73
74    echo "--- 異なるスコープで定義されたプレフィックスを検索 --- \n";
75    // childElement内の 'some:id' 属性ノードを取得します。
76    // 'some' プレフィックスは 'childElement' の直上で宣言されています。
77    $childAttrNode = $xpath->query('//childElement/@some:id')->item(0);
78
79    if ($childAttrNode instanceof Dom\Attr) {
80        echo "属性名: " . $childAttrNode->name . "\n";
81        // 'some' プレフィックスの名前空間URIを検索します。
82        // これは 'childElement' のスコープで定義されているため、URIが返されます。
83        $someNamespaceURI = $childAttrNode->lookupNamespaceURI('some');
84        echo "  プレフィックス 'some' の名前空間URI: " . ($someNamespaceURI ?? 'null (見つかりません)') . "\n\n";
85
86        // 'myns' プレフィックスは 'childElement' のスコープでは直接定義されていません。
87        // しかし、'root' 要素で定義されているため、親をたどって解決されます。
88        $mynsFromChild = $childAttrNode->lookupNamespaceURI('myns');
89        echo "  プレフィックス 'myns' の名前空間URI (childElementから): " . ($mynsFromChild ?? 'null (見つかりません)') . "\n\n";
90
91        // 存在しないプレフィックス 'another' を検索すると、nullが返されます。
92        $anotherNamespace = $childAttrNode->lookupNamespaceURI('another');
93        echo "  プレフィックス 'another' の名前空間URI (childElementから): " . ($anotherNamespace ?? 'null (見つかりません)') . "\n\n";
94    } else {
95        echo "属性 'some:id' が見つかりませんでした。\n\n";
96    }
97}
98
99// サンプルコードを実行します。
100demonstrateDomAttrLookupNamespaceURI();

Dom\Attr::lookupNamespaceURIは、XMLドキュメント内の属性（Dom\Attrオブジェクト）から、指定されたプレフィックスに対応するXML名前空間URIを検索するメソッドです。引数$prefixには検索したい名前空間のプレフィックスを文字列で指定し、nullを渡すとデフォルトの名前空間を検索します。名前空間が見つかれば対応するURIが文字列で返され、見つからなければnullが返されます。ここでいう名前空間は、PHPコードで使うnamespaceキーワードで定義するPHPの名前空間とは異なり、xmlns:prefix="http://example.com/uri"のようにXMLドキュメント内で定義されるXMLの名前空間を扱います。

このサンプルコードでは、名前空間を定義したXML文字列をDOMDocumentに読み込み、DOMXPathを使用して特定の属性ノードを取得しています。例えば、myns:dataという属性から'myns'プレフィックスの名前空間URIを検索すると、XML内で定義されているhttp://example.com/mynsが取得できます。一方、XML内に存在しないプレフィックスを検索したり、デフォルトの名前空間が定義されていない状態でnullを指定したりした場合には、nullが返されることが確認できます。属性が宣言されている要素だけでなく、親要素で定義された名前空間も適切に解決される挙動も理解できます。