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

Copy
1<?php
2
3// XMLドキュメント文字列を定義します。
4// <root>要素は、デフォルト名前空間(xmlns)と、'pref'プレフィックス付き名前空間(xmlns:pref)を定義しています。
5$xmlString = <<<XML
6<?xml version="1.0" encoding="UTF-8"?>
7<root xmlns="http://example.com/default_ns" xmlns:pref="http://example.com/prefix_ns">
8    <element1>
9        <textNode>これはデフォルト名前空間内のテキストです。</textNode>
10    </element1>
11    <pref:element2>
12        <pref:textNode>これは'pref'名前空間内のテキストです。</pref:textNode>
13    </pref:element2>
14    <element3>
15        <!-- このテキストノードの親要素は、ルート要素からデフォルト名前空間を継承しています。 -->
16        <textNodeWithoutSpecificPrefix>これもデフォルト名前空間内のテキストです。</textNodeWithoutSpecificPrefix>
17    </element3>
18</root>
19XML;
20
21// DOMDocumentオブジェクトを作成し、上記で定義したXML文字列をロードします。
22$dom = new DOMDocument();
23$dom->loadXML($xmlString);
24
25// DOMXPathオブジェクトを作成し、XPathクエリを使って特定のノードを簡単に検索できるようにします。
26$xpath = new DOMXPath($dom);
27
28echo "--- DOMText::lookupNamespaceURI の使用例 ---\n\n";
29
30// 例1: デフォルト名前空間に属する要素内のテキストノードを検索します。
31// このテキストノードの親要素 (<textNode>、<element1>) はデフォルト名前空間に属しています。
32$nodeList1 = $xpath->query('//element1/textNode/text()');
33if ($nodeList1->length > 0) {
34    /** @var DOMText $textNode1 */
35    $textNode1 = $nodeList1->item(0);
36    echo "■ 検索対象テキストノード: \"{$textNode1->nodeValue}\" (親要素はデフォルト名前空間)\n";
37
38    // プレフィックスが null の場合:
39    // これは、このテキストノードのスコープ（親要素やその祖先を含む）で定義されている
40    // デフォルトの名前空間URIを検索します。XMLのルート要素で定義されているデフォルト名前空間が見つかります。
41    $defaultNamespaceUriNull = $textNode1->lookupNamespaceURI(null);
42    echo "  lookupNamespaceURI(null) (デフォルト名前空間): " . ($defaultNamespaceUriNull ?: "見つかりません") . "\n";
43
44    // プレフィックスが空文字列 '' の場合:
45    // null と同様に、デフォルトの名前空間URIを検索します。
46    $defaultNamespaceUriEmpty = $textNode1->lookupNamespaceURI('');
47    echo "  lookupNamespaceURI('') (デフォルト名前空間): " . ($defaultNamespaceUriEmpty ?: "見つかりません") . "\n";
48
49    // 'pref'プレフィックスで検索:
50    // このテキストノードの親要素では'pref'は直接定義されていませんが、
51    // XMLのルート要素で定義されているため、その名前空間URIが見つかります。
52    $prefNamespaceUriFromRoot = $textNode1->lookupNamespaceURI('pref');
53    echo "  lookupNamespaceURI('pref') (ルート要素で定義): " . ($prefNamespaceUriFromRoot ?: "見つかりません") . "\n";
54
55    // 存在しないプレフィックスで検索:
56    // どの祖先要素にも'nonexistent'プレフィックスは定義されていないため、nullが返されます。
57    $nonExistentNamespaceUri = $textNode1->lookupNamespaceURI('nonexistent');
58    echo "  lookupNamespaceURI('nonexistent'): " . ($nonExistentNamespaceUri ?: "見つかりません") . "\n";
59    echo "\n";
60}
61
62// 例2: 'pref'プレフィックスの名前空間に属する要素内のテキストノードを検索します。
63// このテキストノードの親要素 (<pref:textNode>、<pref:element2>) は'pref'名前空間に属しています。
64$nodeList2 = $xpath->query('//pref:element2/pref:textNode/text()');
65if ($nodeList2->length > 0) {
66    /** @var DOMText $textNode2 */
67    $textNode2 = $nodeList2->item(0);
68    echo "■ 検索対象テキストノード: \"{$textNode2->nodeValue}\" (親要素は'pref'名前空間)\n";
69
70    // プレフィックスが null の場合:
71    // このノードの親要素自体はデフォルト名前空間を定義していませんが、
72    // XMLの祖先である<root>要素がデフォルト名前空間を定義しているため、そのURIが返されます。
73    $defaultNamespaceUriPrefContext = $textNode2->lookupNamespaceURI(null);
74    echo "  lookupNamespaceURI(null) (ルート要素で定義されたデフォルト名前空間): " . ($defaultNamespaceUriPrefContext ?: "見つかりません") . "\n";
75
76    // 'pref'プレフィックスで検索:
77    // このノードの親要素、またはその祖先（ルート要素）で'pref'プレフィックスが定義されているため、そのURIが返されます。
78    $prefNamespaceUriPrefContext = $textNode2->lookupNamespaceURI('pref');
79    echo "  lookupNamespaceURI('pref'): " . ($prefNamespaceUriPrefContext ?: "見つかりません") . "\n";
80    echo "\n";
81}
82
83?>

DOMText::lookupNamespaceURIは、XMLドキュメント内のテキストノードに対して、指定したプレフィックスに対応する名前空間URIを検索するメソッドです。

このメソッドは、$prefix引数に文字列でプレフィックスを受け取ります。nullまたは空文字列''を指定した場合は、デフォルト名前空間のURIを検索します。指定されたプレフィックスに対応する名前空間URIを、現在のテキストノードからその親要素、さらに祖先要素へと遡り、最初に見つかった宣言から取得します。この検索範囲にはXMLのルート要素で定義されている名前空間も含まれます。

検索の結果、対応する名前空間が見つかった場合はそのURIを文字列で返します。指定されたプレフィックスが見つからなかった場合や、対応する名前空間が定義されていない場合はnullを返します。

サンプルコードでは、XML内の様々なテキストノードを対象にこのメソッドを使用しています。テキストノード自体に名前空間の宣言はありませんが、その親要素やXMLのルート要素で定義された名前空間をlookupNamespaceURIで正しく取得できることが確認できます。例えば、nullや空文字列を引数に渡すと、ルート要素で定義されたデフォルトの名前空間URIが取得されます。また、特定のプレフィックス名を指定すれば、そのプレフィックスに対応する名前空間URIが返されますが、存在しないプレフィックスを指定するとnullが返る挙動も示されています。このメソッドは、XML文書で名前空間を扱う際に、特定のプレフィックスがどのURIに紐づいているかを確認するのに役立ちます。

Copy
1<?php
2
3/**
4 * DOMText::lookupNamespaceURI メソッドの使用例を示します。
5 *
6 * この関数は、XMLドキュメント内のテキストノードに対して
7 * 指定されたプレフィックスに対応する名前空間URIを検索します。
8 * 特に、名前空間が見つからない場合の挙動（nullを返す）に焦点を当て、
9 * 「php namespace not found」の状況を具体的に示します。
10 */
11function demonstrateLookupNamespaceURI(): void
12{
13    // サンプルXML文字列を定義
14    // prefix_a とデフォルトの名前空間を定義しています。
15    $xmlString = <<<XML
16<?xml version="1.0" encoding="UTF-8"?>
17<root xmlns:prefix_a="http://example.com/ns/a" xmlns="http://example.com/ns/default">
18    <prefix_a:element>
19        <child>Text within prefix_a:element.</child>
20    </prefix_a:element>
21    <element_no_prefix>
22        <child>Text within an element without a specific prefix.</child>
23    </element_no_prefix>
24    <plain>Simple plain text.</plain>
25</root>
26XML;
27
28    // DOMDocument オブジェクトを作成し、XMLをロードします。
29    $dom = new DOMDocument();
30    $dom->loadXML($xmlString);
31
32    // XPath オブジェクトを作成します。これにより、XML内の特定のノードを簡単に検索できます。
33    $xpath = new DOMXPath($dom);
34
35    echo "--- DOMText::lookupNamespaceURI の使用例 ---\n";
36
37    // ケース1: 名前空間が定義されているプレフィックスを検索
38    // 'prefix_a:element' 内のテキストノードを取得します。
39    $nodeList = $xpath->query('//prefix_a:element/child/text()');
40    if ($nodeList->length > 0) {
41        /** @var DOMText $textNode */
42        $textNode = $nodeList->item(0);
43        echo "\n[ケース1: 'prefix_a' の名前空間検索]\n";
44        echo "ターゲットテキストノード: \"" . $textNode->nodeValue . "\"\n";
45        $uri = $textNode->lookupNamespaceURI('prefix_a');
46        echo "lookupNamespaceURI('prefix_a') の結果: " . ($uri ?? 'NULL (見つかりません)') . "\n";
47        if ($uri === 'http://example.com/ns/a') {
48            echo "  -> 期待通りのURIが見つかりました。\n";
49        }
50    }
51
52    // ケース2: デフォルト名前空間を検索 (プレフィックスは null または空文字列)
53    // デフォルト名前空間に属する要素内のテキストノードを取得します。
54    $nodeList = $xpath->query('//element_no_prefix/child/text()');
55    if ($nodeList->length > 0) {
56        /** @var DOMText $textNode */
57        $textNode = $nodeList->item(0);
58        echo "\n[ケース2: デフォルト名前空間の検索 (プレフィックスなし)]\n";
59        echo "ターゲットテキストノード: \"" . $textNode->nodeValue . "\"\n";
60        // デフォルト名前空間は null を引数に指定することで検索できます。
61        $uri = $textNode->lookupNamespaceURI(null);
62        echo "lookupNamespaceURI(null) の結果: " . ($uri ?? 'NULL (見つかりません)') . "\n";
63        if ($uri === 'http://example.com/ns/default') {
64            echo "  -> 期待通りのデフォルトURIが見つかりました。\n";
65        }
66    }
67
68    // ケース3: 存在しないプレフィックスを検索 (「php namespace not found」の状況)
69    // 任意のテキストノードを取得し、XML内で定義されていないプレフィックスを検索します。
70    $nodeList = $xpath->query('//plain/text()');
71    if ($nodeList->length > 0) {
72        /** @var DOMText $textNode */
73        $textNode = $nodeList->item(0);
74        echo "\n[ケース3: 存在しないプレフィックス 'prefix_not_found' の検索]\n";
75        echo "ターゲットテキストノード: \"" . $textNode->nodeValue . "\"\n";
76        $uri = $textNode->lookupNamespaceURI('prefix_not_found');
77        echo "lookupNamespaceURI('prefix_not_found') の結果: " . ($uri ?? 'NULL (見つかりません)') . "\n";
78        if ($uri === null) {
79            echo "  -> 名前空間URIが見つかりませんでした。これは期待通りの挙動です。\n";
80            echo "     このケースがキーワード「php namespace not found」に該当します。\n";
81        }
82    }
83
84    // ケース4: XML全体で未定義のプレフィックスを検索 (「php namespace not found」のもう一つの例)
85    // 別のテキストノードから、全く定義されていないプレフィックスを検索します。
86    $nodeList = $xpath->query('//prefix_a:element/child/text()'); // 任意のテキストノードを使用
87    if ($nodeList->length > 0) {
88        /** @var DOMText $textNode */
89        $textNode = $nodeList->item(0);
90        echo "\n[ケース4: XML全体で未定義のプレフィックス 'another_non_existent_prefix' の検索]\n";
91        echo "ターゲットテキストノード: \"" . $textNode->nodeValue . "\"\n";
92        $uri = $textNode->lookupNamespaceURI('another_non_existent_prefix');
93        echo "lookupNamespaceURI('another_non_existent_prefix') の結果: " . ($uri ?? 'NULL (見つかりません)') . "\n";
94        if ($uri === null) {
95            echo "  -> 名前空間URIが見つかりませんでした。これも「php namespace not found」の状況です。\n";
96        }
97    }
98}
99
100// 関数を実行して結果を表示します。
101demonstrateLookupNamespaceURI();

DOMText::lookupNamespaceURIは、XMLドキュメント内のテキストノードを基準として、指定されたプレフィックスに対応する名前空間URIを検索するためのPHPメソッドです。

このメソッドの引数$prefixには、検索したい名前空間のプレフィックスを文字列で渡します。もし要素にプレフィックスが付いていないデフォルト名前空間を調べたい場合はnullを指定します。戻り値は、対応する名前空間URIが見つかればそのURIを表す文字列を返し、見つからなかった場合はnullを返します。

サンプルコードでは、まずXML文字列をDOMDocumentに読み込み、DOMXPathを使って特定のテキストノード（DOMTextオブジェクト）を取得しています。 コードの最初のケースでは、XMLに定義されているprefix_aを指定し、その名前空間URIが正しく取得されることを示しています。次に、引数にnullを渡してデフォルト名前空間のURIを取得できることも確認できます。 最も注目すべきは、XML内で定義されていない存在しないプレフィックス（例: 'prefix_not_found'）を指定した場合です。このとき、lookupNamespaceURIメソッドはnullを返します。このnullの戻り値は、キーワードである「php namespace not found」の状況を具体的に示しており、指定したプレフィックスに対応する名前空間URIが見つからなかったことを意味します。このメソッドを使うことで、XMLの名前空間情報を正確に確認し、名前空間の有無を確実に判断できます。