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

Copy
1<?php
2
3/**
4 * XMLReader::lookupNamespace メソッドの使用例。
5 * 指定された名前空間プリフィックスに対応するURIを検索します。
6 * プリフィックスが見つからない場合、null を返します。
7 */
8function demonstrateXmlReaderLookupNamespace(): void
9{
10    // 名前空間を含むXMLデータを用意
11    $xmlString = <<<XML
12<root xmlns:myPrefix="http://example.com/myNamespace" xmlns:other="http://example.com/otherNamespace">
13    <myPrefix:element1>Content from myPrefix</myPrefix:element1>
14    <other:element2>Content from other</other:element2>
15</root>
16XML;
17
18    $reader = new XMLReader();
19
20    // XML文字列を読み込む
21    if (!$reader->XML($xmlString)) {
22        echo "エラー: XMLの読み込みに失敗しました。\n";
23        return;
24    }
25
26    // XMLReaderは現在参照しているノードの情報を使って名前空間を検索します。
27    // ルート要素に名前空間が定義されているため、ルート要素まで読み進めます。
28    // `read()`がfalseを返すか、要素ノードに到達するまでループします。
29    while ($reader->read() && $reader->nodeType !== XMLReader::ELEMENT) {
30        // 要素ノードに到達するまで読み進めます
31    }
32
33    // 現在のノードが要素ノードであるか確認
34    if ($reader->nodeType === XMLReader::ELEMENT) {
35        echo "現在の要素ノード: " . $reader->name . "\n\n";
36
37        // 存在するプリフィックス 'myPrefix' の名前空間URIを検索
38        $existingPrefix = 'myPrefix';
39        $namespaceUri = $reader->lookupNamespace($existingPrefix);
40        echo "プリフィックス '{$existingPrefix}' の名前空間URI:\n";
41        var_dump($namespaceUri); // http://example.com/myNamespace が出力される
42
43        echo "\n";
44
45        // 存在する別のプリフィックス 'other' の名前空間URIを検索
46        $anotherExistingPrefix = 'other';
47        $namespaceUri = $reader->lookupNamespace($anotherExistingPrefix);
48        echo "プリフィックス '{$anotherExistingPrefix}' の名前空間URI:\n";
49        var_dump($namespaceUri); // http://example.com/otherNamespace が出力される
50
51        echo "\n";
52
53        // 存在しないプリフィックス 'notFound' の名前空間URIを検索
54        // このケースが「php namespace not found」の状況を示します。
55        $notFoundPrefix = 'notFound';
56        $namespaceUri = $reader->lookupNamespace($notFoundPrefix);
57        echo "プリフィックス '{$notFoundPrefix}' の名前空間URI (見つからない場合):\n";
58        var_dump($namespaceUri); // null が出力される (見つからないため)
59    } else {
60        echo "エラー: XML内に要素ノードが見つかりませんでした。\n";
61    }
62
63    // XMLReaderを閉じることでリソースを解放します
64    $reader->close();
65}
66
67// 関数を実行して動作を確認
68demonstrateXmlReaderLookupNamespace();

PHPのXMLReaderクラスに属するlookupNamespaceメソッドは、XML文書内で使用されている名前空間のURI（Uniform Resource Identifier）を、指定したプリフィックスから見つけ出すために利用されます。引数には検索したい名前空間の$prefix（文字列）を指定します。戻り値は、対応するURIが見つかった場合はそのURI（文字列）、見つからなかった場合はnullが返されます。

このサンプルコードでは、まず名前空間が定義されたXMLデータを用意し、XMLReaderオブジェクトで読み込みます。lookupNamespaceメソッドは、現在XMLReaderが参照しているノードのコンテキストに基づいて検索を行うため、XML文書のルート要素まで読み進める必要があります。

コード内では、「myPrefix」や「other」といった存在するプリフィックスを指定すると、それぞれに対応するURIが正しく取得される様子が示されています。一方、「notFound」のようにXML内に定義されていないプリフィックスを指定した場合、戻り値はnullとなります。これは、キーワードにある「php namespace not found」のような状況を示し、目的の名前空間が見つからなかったことを意味します。このメソッドを使うことで、XMLデータを処理する際に、名前空間の解決を簡単に行うことができます。

Copy
1<?php
2
3/**
4 * XMLReader::lookupNamespace() メソッドを使用して、XMLの名前空間を検索するサンプルコード。
5 *
6 * この関数は、XMLドキュメント内のプレフィックスに対応する名前空間URIを特定する方法を示します。
7 * 特に、キーワード「ルートの名前空間」に関連して、デフォルト名前空間（プレフィックスが空文字列の場合）の
8 * 検索方法も示します。
9 */
10function demonstrateXmlNamespaceLookup(): void
11{
12    // 名前空間を持つシンプルなXMLデータを作成
13    // - <root>要素にはデフォルト名前空間 (http://example.com/default) が定義されています。
14    // - 'pref' プレフィックスには名前空間 (http://example.com/prefix) が定義されています。
15    $xmlString = <<<XML
16<?xml version="1.0" encoding="UTF-8"?>
17<root xmlns="http://example.com/default" xmlns:pref="http://example.com/prefix">
18    <element1>Default Namespace Content</element1>
19    <pref:element2>Prefix Namespace Content</pref:element2>
20</root>
21XML;
22
23    // XMLReaderインスタンスを作成
24    $reader = new XMLReader();
25
26    // 文字列からXMLを読み込む
27    if (!$reader->xml($xmlString)) {
28        echo "XMLの読み込みに失敗しました。\n";
29        return;
30    }
31
32    // XMLデータを読み進め、最初の要素ノード（通常はルート要素）に到達します。
33    // XMLReaderはストリームパーサなので、read()を呼び出して次のノードに進みます。
34    // XML宣言やコメントなどの非要素ノードをスキップします。
35    while ($reader->read() && $reader->nodeType !== XMLReader::ELEMENT) {
36        // 何もしません。ループによって要素ノードまで読み進めます。
37    }
38
39    // 現在のノードがルート要素であることを確認します。
40    if ($reader->nodeType === XMLReader::ELEMENT && $reader->name === 'root') {
41        echo "現在、ルート要素 '<{$reader->name}>' にいます。\n\n";
42
43        // lookupNamespace('') を使用して、プレフィックスが空文字列（''）の場合の
44        // デフォルト名前空間URIを検索します。
45        // これは「ルートの名前空間」や「プレフィックスなしの名前空間」を探す場合によく使われます。
46        $defaultNamespaceUri = $reader->lookupNamespace('');
47        echo "デフォルト名前空間URI (prefix=''): " . (is_null($defaultNamespaceUri) ? "null (見つかりませんでした)" : $defaultNamespaceUri) . "\n";
48
49        // 'pref' というプレフィックスに対応する名前空間URIを検索します。
50        $prefixNamespaceUri = $reader->lookupNamespace('pref');
51        echo "プレフィックス 'pref' の名前空間URI: " . (is_null($prefixNamespaceUri) ? "null (見つかりませんでした)" : $prefixNamespaceUri) . "\n";
52
53        // 存在しないプレフィックスを検索した場合、nullが返されます。
54        $nonExistentNamespaceUri = $reader->lookupNamespace('xyz');
55        echo "プレフィックス 'xyz' の名前空間URI: " . (is_null($nonExistentNamespaceUri) ? "null (見つかりませんでした)" : $nonExistentNamespaceUri) . "\n";
56
57    } else {
58        echo "ルート要素が見つかりませんでした。\n";
59    }
60
61    // XMLReaderをクローズし、リソースを解放します。
62    $reader->close();
63}
64
65// 関数を実行してサンプルコードの動作を確認
66demonstrateXmlNamespaceLookup();

PHP 8のXMLReader::lookupNamespaceメソッドは、XMLドキュメント内の指定されたプレフィックスに対応する名前空間URIを検索するために使用されます。XMLReaderはXMLをストリーム形式で読み込むため、read()メソッドで目的のノードに移動してからこのメソッドを呼び出します。

引数string $prefixには、検索したい名前空間のプレフィックス（例: 'pref'）を文字列で渡します。特に、空文字列''を渡すと、現在の要素に適用されているデフォルトの名前空間（プレフィックスを持たない名前空間）のURIを取得できます。これは「ルートの名前空間」としてXMLドキュメントの主要な名前空間を特定する際に重要です。

このメソッドは、対応する名前空間URIが見つかればその文字列を返します。もし指定されたプレフィックスに対応する名前空間が現在のノードのスコープで見つからない場合は、戻り値としてnullを返します。

サンプルコードでは、まずXMLのルート要素に移動した後、lookupNamespace('')でデフォルト名前空間のURIを取得し、次にlookupNamespace('pref')で特定のプレフィックス'pref'の名前空間URIを取得しています。また、存在しないプレフィックスを指定した場合にnullが返される挙動も確認できます。この機能により、XMLデータを扱う際に名前空間を正確に識別し、コンテンツを適切に処理することが可能になります。