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

Copy
1<?php
2
3/**
4 * DOMDocument::lookupNamespaceURI メソッドの使用例を示します。
5 * このメソッドは、指定されたプレフィックスに対応する名前空間URIを検索します。
6 * 特に、null または空文字列をプレフィックスとして渡すと、
7 * XMLドキュメントのデフォルトの名前空間URIを検索します。
8 * これは、名前空間を明示的に指定しない「ルート」の名前空間の概念に近いです。
9 */
10function demonstrateLookupNamespaceURI(): void
11{
12    // XML ドキュメントを定義します。
13    // - ルート要素にはデフォルトの名前空間 (xmlns="...") が定義されています。
14    // - 'pref' というプレフィックスを持つ名前空間 (xmlns:pref="...") も定義されています。
15    $xmlString = <<<XML
16<?xml version="1.0" encoding="UTF-8"?>
17<root xmlns="http://www.example.com/default/namespace" xmlns:pref="http://www.example.com/prefix/namespace">
18    <child>デフォルト名前空間の要素</child>
19    <pref:anotherChild>プレフィックス付き名前空間の要素</pref:anotherChild>
20</root>
21XML;
22
23    // DOMDocument オブジェクトを作成します。
24    $dom = new DOMDocument();
25
26    // XML 文字列をロードします。失敗した場合は処理を終了します。
27    if (!$dom->loadXML($xmlString)) {
28        echo "エラー: XMLのロードに失敗しました。\n";
29        return;
30    }
31
32    // ドキュメントのルート要素を取得します。
33    // lookupNamespaceURI は DOMNode のメソッドなので、通常は要素に対して呼び出します。
34    $rootElement = $dom->documentElement;
35
36    if ($rootElement === null) {
37        echo "エラー: ルート要素が見つかりませんでした。\n";
38        return;
39    }
40
41    echo "--- DOMDocument::lookupNamespaceURI の使用例 ---\n\n";
42
43    // 1. デフォルトの名前空間URIを検索します (プレフィックスに null を指定)。
44    // これは <root xmlns="..."> で定義されたURIに対応します。
45    $defaultNamespaceUriNull = $rootElement->lookupNamespaceURI(null);
46    echo "プレフィックスが null の場合 (デフォルトの名前空間): \n";
47    echo "  URI: " . ($defaultNamespaceUriNull ?? "(見つかりませんでした)") . "\n";
48    echo "  期待値: http://www.example.com/default/namespace\n\n";
49
50    // 2. プレフィックスに空文字列を指定した場合も、デフォルトの名前空間URIを検索します。
51    $defaultNamespaceUriEmpty = $rootElement->lookupNamespaceURI('');
52    echo "プレフィックスが空文字列の場合 (デフォルトの名前空間): \n";
53    echo "  URI: " . ($defaultNamespaceUriEmpty ?? "(見つかりませんでした)") . "\n";
54    echo "  期待値: http://www.example.com/default/namespace\n\n";
55
56    // 3. 'pref' プレフィックスの名前空間URIを検索します。
57    // これは <root xmlns:pref="..."> で定義されたURIに対応します。
58    $prefNamespaceUri = $rootElement->lookupNamespaceURI('pref');
59    echo "プレフィックス 'pref' の名前空間: \n";
60    echo "  URI: " . ($prefNamespaceUri ?? "(見つかりませんでした)") . "\n";
61    echo "  期待値: http://www.example.com/prefix/namespace\n\n";
62
63    // 4. 存在しないプレフィックスの名前空間URIを検索します。
64    // この場合、`null` が返されます。
65    $nonExistentNamespaceUri = $rootElement->lookupNamespaceURI('nonexistent');
66    echo "存在しないプレフィックス 'nonexistent' の名前空間: \n";
67    echo "  URI: " . ($nonExistentNamespaceUri ?? "(見つかりませんでした)") . "\n";
68    echo "  期待値: (null)\n";
69}
70
71// 上記のデモンストレーション関数を実行します。
72demonstrateLookupNamespaceURI();

DOMDocument::lookupNamespaceURIメソッドは、XMLドキュメント内の要素に適用されている名前空間のURI（Uniform Resource Identifier）を検索する際に使用します。

このメソッドは、引数として検索したい名前空間のプレフィックスを文字列で受け取ります。特に重要な点として、引数にnullまたは空文字列''を指定すると、その要素に定義されている「デフォルトの名前空間」のURIが返されます。これは、XMLドキュメントにおいてプレフィックスを明示しない要素が所属する、いわば「ルート」の名前空間を特定する概念に近いものです。

例えば、xmlns="http://example.com/default"のように定義されたデフォルト名前空間を持つXML要素に対し、lookupNamespaceURI(null)やlookupNamespaceURI('')を呼び出すと、http://example.com/defaultというURIが取得できます。また、xmlns:pref="http://example.com/prefix"のように特定のプレフィックスprefが定義されている場合は、lookupNamespaceURI('pref')でそのURIを取得できます。

指定されたプレフィックスに対応する名前空間が見つからない場合は、戻り値としてnullが返されます。このメソッドを使うことで、XMLドキュメントの構造をプログラムで解析し、各XML要素がどの名前空間に属しているかを正確に判別できるようになります。

Copy
1<?php
2
3/**
4 * DOMDocument::lookupNamespaceURI メソッドの使用例。
5 * 指定されたプレフィックスに対応する名前空間URIを検索します。
6 * 特に、存在しないプレフィックスの場合に null が返される挙動を示し、
7 * 「php namespace not found」の状況を理解するのに役立ちます。
8 */
9function demonstrateLookupNamespaceURI(): void
10{
11    // 名前空間を持つ簡単なXML文字列を定義
12    $xmlString = <<<XML
13<root xmlns:myns="http://example.com/myns">
14    <myns:element>Hello Namespace!</myns:element>
15</root>
16XML;
17
18    // DOMDocumentインスタンスを作成
19    $dom = new DOMDocument();
20
21    // XML文字列をDOMDocumentにロード
22    // LIBXML_NOERROR と LIBXML_NOWARNING は、パース時の警告やエラーを抑制します。
23    // 実運用ではエラーハンドリングを適切に行うことを推奨します。
24    $dom->loadXML($xmlString, LIBXML_NOERROR | LIBXML_NOWARNING);
25
26    echo "--- 存在するプレフィックスの検索 ---\n";
27    $existingPrefix = 'myns';
28    $uriForExistingPrefix = $dom->lookupNamespaceURI($existingPrefix);
29
30    if ($uriForExistingPrefix !== null) {
31        echo "プレフィックス '{$existingPrefix}' の名前空間URI: {$uriForExistingPrefix}\n";
32    } else {
33        echo "エラー: プレフィックス '{$existingPrefix}' の名前空間URIが見つかりませんでした。\n";
34    }
35
36    echo "\n--- 存在しないプレフィックスの検索 ---\n";
37    $nonExistentPrefix = 'nonexistent';
38    $uriForNonExistentPrefix = $dom->lookupNamespaceURI($nonExistentPrefix);
39
40    if ($uriForNonExistentPrefix !== null) {
41        echo "エラー: プレフィックス '{$nonExistentPrefix}' の名前空間URI: {$uriForNonExistentPrefix}\n";
42    } else {
43        echo "プレフィックス '{$nonExistentPrefix}' の名前空間URIは見つかりませんでした。\n";
44        echo "この場合、lookupNamespaceURI() は null を返します。\n";
45        echo "これは「php namespace not found」の一般的なシナリオを示します。\n";
46    }
47
48    echo "\n--- デフォルト名前空間 (nullプレフィックス) の検索 ---\n";
49    // `null` を渡すと、デフォルト名前空間のURIを検索します。
50    // このXMLにはデフォルト名前空間がないため、nullが返されます。
51    $defaultNamespaceURI = $dom->lookupNamespaceURI(null);
52
53    if ($defaultNamespaceURI !== null) {
54        echo "デフォルト名前空間のURI: {$defaultNamespaceURI}\n";
55    } else {
56        echo "デフォルト名前空間は見つかりませんでした。\n";
57    }
58}
59
60// 関数の実行
61demonstrateLookupNamespaceURI();

PHP 8のDOMDocument::lookupNamespaceURIメソッドは、XML文書内で指定されたプレフィックスに対応する名前空間URIを検索するために使用されます。引数$prefixには検索したい名前空間のプレフィックスを文字列で渡します。もしデフォルトの名前空間URIを検索したい場合は、nullを渡します。

このメソッドの戻り値は、名前空間URIが見つかればそのURIを表す文字列、見つからなければnullを返します。サンプルコードでは、まず存在するプレフィックス「myns」に対して正しいURIが取得できることを示しています。

次に、XML文書内に存在しないプレフィックス「nonexistent」を検索すると、メソッドはnullを返します。このnullの返り値は、指定されたプレフィックスに対応する名前空間が見つからなかったことを意味し、「php namespace not found」という状況の典型的な例となります。このように、nullが返されるかどうかで、目的の名前空間が存在するかどうかを判断できます。デフォルト名前空間についても、XMLに定義がなければnullが返されます。