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

Copy
1<?php
2
3/**
4 * Dom\Node::lookupNamespaceURI メソッドの使用例を示します。
5 * XMLドキュメントのルート要素から名前空間URIを検索する方法を実演します。
6 *
7 * システムエンジニアを目指す初心者の方へ:
8 * このコードは、XMLドキュメント内で定義されている名前空間（namespace）が、
9 * どのURI（識別子）に対応するかを調べる方法を示しています。
10 * 'ルート'要素とはXMLの一番外側の要素のことです。
11 * 名前空間はXML要素の衝突を防ぎ、意味を明確にするために使われます。
12 */
13function demonstrateLookupNamespaceURI(): void
14{
15    // 名前空間を持つシンプルなXML文字列を定義します。
16    // xmlns="..." はデフォルト名前空間、xmlns:pref="..." は "pref" プレフィックスの名前空間を定義します。
17    $xmlString = <<<XML
18<?xml version="1.0" encoding="UTF-8"?>
19<root xmlns="http://example.com/default/namespace" xmlns:pref="http://example.com/prefixed/namespace">
20    <child pref:item="value">これは子要素です</child>
21</root>
22XML;
23
24    // DOMDocumentオブジェクトを作成し、XML文字列をロードします。
25    // これにより、XMLドキュメントをPHPで操作できるようになります。
26    $dom = new DOMDocument();
27    $dom->loadXML($xmlString);
28
29    // ドキュメントのルート要素を取得します。
30    // この要素はDom\NodeのサブクラスであるDom\Elementのインスタンスです。
31    // ここから名前空間の解決を行います。
32    $rootElement = $dom->documentElement;
33
34    echo "--- Dom\\Node::lookupNamespaceURI の使用例 ---\n";
35    echo "対象のノード: <" . $rootElement->nodeName . ">\n\n";
36
37    // 1. デフォルト名前空間 (プレフィックスなし) のURIを検索します。
38    // lookupNamespaceURIの引数に null または空文字列を渡すと、
39    // そのノードで有効なデフォルト名前空間が検索されます。
40    $defaultNamespaceUri = $rootElement->lookupNamespaceURI(null);
41    echo "プレフィックスなし (デフォルト) の名前空間URI: " . ($defaultNamespaceUri ?? "見つかりません") . "\n";
42
43    // 2. 特定のプレフィックス ("pref") に対応する名前空間URIを検索します。
44    // XML内で 'pref' が定義されているため、そのURIが返されます。
45    $prefixedNamespaceUri = $rootElement->lookupNamespaceURI('pref');
46    echo "プレフィックス 'pref' の名前空間URI: " . ($prefixedNamespaceUri ?? "見つかりません") . "\n";
47
48    // 3. 存在しないプレフィックス ("unknown") の名前空間URIを検索します。
49    // このXML内では 'unknown' というプレフィックスは定義されていないため、null が返されます。
50    $unknownNamespaceUri = $rootElement->lookupNamespaceURI('unknown');
51    echo "プレフィックス 'unknown' の名前空間URI: " . ($unknownNamespaceUri ?? "見つかりません") . "\n";
52}
53
54// 上記の関数を実行して、Dom\Node::lookupNamespaceURIの動作を確認します。
55demonstrateLookupNamespaceURI();

PHPのDom\Node::lookupNamespaceURIメソッドは、XMLドキュメント内で定義された名前空間のURIを検索するために使用されます。名前空間とは、XML要素の名前が衝突するのを防ぎ、その要素の意味を明確にするための仕組みです。このサンプルコードでは、XMLドキュメントの一番外側にある「ルート要素」から名前空間URIを検索する例を示しています。

このメソッドは、引数として$prefixという文字列を受け取ります。$prefixにnullまたは空文字列を指定すると、そのノードで有効なデフォルトの名前空間URIが検索されます。例えば、XMLでxmlns="http://example.com/default"と定義されていれば、"http://example.com/default"が返されます。特定のプレフィックス（例: "pref"）を指定すると、xmlns:pref="http://example.com/prefixed"のように定義された名前空間URIが見つかれば、そのURIが戻り値として返されます。もし指定されたプレフィックスに対応する名前空間が見つからない場合は、戻り値としてnullが返されます。

サンプルコードでは、デフォルト名前空間、"pref"というプレフィックスの名前空間、そして存在しない"unknown"プレフィックスの名前空間をそれぞれ検索し、その結果を出力しています。これにより、名前空間の定義状況に応じて異なるURIが返されることや、見つからない場合にはnullとなる挙動が確認できます。

Copy
1<?php
2
3// DOMDocument クラスを使用して新しい XML ドキュメントを作成します。
4$dom = new DOMDocument('1.0', 'UTF-8');
5// 出力時にXMLを整形するための設定
6$dom->formatOutput = true;
7
8// ルート要素を作成し、デフォルトの名前空間と 'my' プレフィックスの名前空間を定義します。
9// createElementNS(名前空間URI, 要素名, [プレフィックス])
10$root = $dom->createElementNS('http://example.com/default-ns', 'root');
11
12// 'my' というプレフィックスに 'http://example.com/my-ns' という名前空間URIを関連付けます。
13// setAttributeNS(名前空間URI, 属性名, 値)
14// 属性名 'xmlns:my' はXML名前空間の定義方法です。
15$root->setAttributeNS('http://www.w3.org/2000/xmlns/', 'xmlns:my', 'http://example.com/my-ns');
16$dom->appendChild($root);
17
18// 現在のXML構造を表示
19echo "--- 生成されたXMLドキュメント ---\n";
20echo $dom->saveXML();
21echo "---------------------------------\n\n";
22
23// Dom\Node::lookupNamespaceURI() メソッドを使用して名前空間URIを検索します。
24
25// 存在するプレフィックス 'my' の名前空間URIを検索します。
26$existingPrefix = 'my';
27$uriForExistingPrefix = $root->lookupNamespaceURI($existingPrefix);
28
29echo "プレフィックス '{$existingPrefix}' の名前空間URI: ";
30if ($uriForExistingPrefix !== null) {
31    echo $uriForExistingPrefix . "\n";
32} else {
33    // このパスは通常、このケースでは実行されません。
34    echo "見つかりません（予期せぬ結果）\n";
35}
36
37// 存在しないプレフィックス 'nonexistent' の名前空間URIを検索します。
38// これはキーワード「php namespace not found」の状況をシミュレートします。
39$nonExistingPrefix = 'nonexistent';
40$uriForNonExistingPrefix = $root->lookupNamespaceURI($nonExistingPrefix);
41
42echo "プレフィックス '{$nonExistingPrefix}' の名前空間URI: ";
43if ($uriForNonExistingPrefix === null) {
44    // プレフィックスが見つからない場合、null が返されます。
45    echo "見つかりません (null が返されました)\n";
46    echo "これは、指定されたプレフィックス '{$nonExistingPrefix}' に対応する名前空間が、\n";
47    echo "このノードのスコープ（およびその親）で見つからなかったことを意味します。\n";
48} else {
49    // このパスは通常、このケースでは実行されません。
50    echo $uriForNonExistingPrefix . " (予期せぬ結果)\n";
51}
52
53?>

PHPのDom\Node::lookupNamespaceURI()メソッドは、XMLドキュメント内の特定のノードを基準として、指定されたプレフィックスに関連付けられた名前空間URIを検索するために使用されます。XMLにおいて、名前空間は要素や属性の衝突を防ぎ、意味を明確にする役割を持ちます。

このメソッドは、引数として検索したいプレフィックスを文字列で受け取ります。例えば、myというプレフィックスが指定された場合、そのプレフィックスが定義されている名前空間URIを探します。

戻り値は、名前空間URIが見つかった場合にはそのURIを示す文字列、見つからなかった場合にはnullとなります。サンプルコードでは、まずmyという存在するプレフィックスを検索し、定義されたURI「http://example.com/my-ns」が正しく取得されることを示しています。次に、`nonexistent`という存在しないプレフィックスを検索すると、メソッドは`null`を返します。この`null`という戻り値が、指定されたプレフィックスに対応する名前空間が現在のノードのスコープで「見つからなかった」ことを意味し、「php namespace not found」という状況を表しています。この機能は、XML構造を解析する際に、要素や属性がどの名前空間に属しているかを確認する上で非常に役立ちます。