【PHP8.x】XMLReader::namespaceURIプロパティの使い方

Copy
1<?php
2
3/**
4 * XMLReader::namespaceURI プロパティの使用例を示します。
5 * この関数は、名前空間を持つXMLドキュメントを読み込み、
6 * 各要素の名前空間URIを表示します。
7 */
8function demonstrateXmlNamespaceUri(): void
9{
10    // 名前空間を持つXML文字列を定義します。
11    // 'xmlns="..."' はデフォルト名前空間、'xmlns:prefix="..."' はプレフィックス付き名前空間を定義します。
12    $xmlString = <<<XML
13<?xml version="1.0" encoding="UTF-8"?>
14<root xmlns="http://example.com/ns/default"
15      xmlns:ex1="http://example.com/ns/extension1"
16      xmlns:ex2="http://example.com/ns/extension2">
17    <elementA>
18        <!-- デフォルト名前空間に属する要素 -->
19        <childA>Child A Value</childA>
20    </elementA>
21    <ex1:elementB>
22        <!-- "ex1" プレフィックスに紐付けられた名前空間に属する要素 -->
23        <ex1:childB>Child B Value</ex1:childB>
24    </ex1:elementB>
25    <ex2:elementC>
26        <!-- "ex2" プレフィックスに紐付けられた名前空間に属する要素 -->
27        <childC>Child C Value</childC>
28    </ex2:elementC>
29</root>
30XML;
31
32    $reader = new XMLReader();
33
34    // XML文字列をXMLReaderに読み込ませます。
35    if (!$reader->xml($xmlString)) {
36        echo "XMLの読み込みに失敗しました。\n";
37        return;
38    }
39
40    echo "XMLReader::namespaceURI の使用例:\n";
41    echo "--------------------------------------------------------\n";
42    echo str_pad("Node Type", 15) . str_pad("Name", 20) . "Namespace URI\n";
43    echo "--------------------------------------------------------\n";
44
45    // XMLドキュメントをノードごとに読み進めます。
46    while ($reader->read()) {
47        // ノードタイプをより読みやすい文字列に変換します (PHP 8のmatch式を使用)。
48        $nodeTypeName = match ($reader->nodeType) {
49            XMLReader::ELEMENT        => 'ELEMENT',
50            XMLReader::TEXT           => 'TEXT',
51            XMLReader::WHITESPACE     => 'WHITESPACE',
52            XMLReader::CDATA          => 'CDATA',
53            XMLReader::COMMENT        => 'COMMENT',
54            XMLReader::PI             => 'PI', // Processing Instruction (処理命令)
55            XMLReader::DOC_TYPE       => 'DOCTYPE',
56            XMLReader::END_ELEMENT    => 'END_ELEMENT',
57            default                   => 'OTHER',
58        };
59
60        // 要素ノード（開始タグまたは終了タグ）およびテキストノードの場合に情報を表示します。
61        // namespaceURIプロパティは、現在のノードの名前空間URIを返します。
62        // 名前空間がない場合は空文字列を返します。
63        if (in_array($reader->nodeType, [XMLReader::ELEMENT, XMLReader::END_ELEMENT, XMLReader::TEXT])) {
64            $namespaceUri = $reader->namespaceURI;
65            echo str_pad($nodeTypeName, 15) . str_pad($reader->name, 20) . ($namespaceUri ?: "(なし)") . "\n";
66        }
67    }
68
69    // XMLReaderオブジェクトを閉じ、リソースを解放します。
70    $reader->close();
71    echo "--------------------------------------------------------\n";
72}
73
74// 関数を実行します。
75demonstrateXmlNamespaceUri();

PHPのXMLReader::namespaceURIプロパティは、PHP 8でXMLドキュメントを読み込む際に、現在注目している要素や属性などのノードが「名前空間」に属している場合、そのURI（Uniform Resource Identifier）を取得するために使用します。

XMLにおける名前空間とは、異なるXMLスキーマ間で同じ名前の要素や属性が重複しても、それぞれを明確に区別するための仕組みです。例えば、<name>というタグが「人の名前」を表す場合と「製品の名前」を表す場合、それぞれ異なる名前空間を定義することで、混同せずに処理できるようになります。名前空間はURIによって一意に識別されます。

このプロパティには引数はなく、現在のノードの名前空間URIを文字列（string）として返します。もし現在のノードが名前空間に属していない場合は、空文字列を返します。

提供されたサンプルコードでは、複数の名前空間が定義されたXML文字列をXMLReaderで読み込み、各ノードのタイプ、名前、そしてnamespaceURIプロパティが返す名前空間URIを表示しています。これにより、XML内の各要素がどの名前空間に属しているかを明確に確認できる様子が示されています。XMLドキュメントを解析し、特定の名前空間に属する要素だけを抽出したり、異なる名前空間の要素を区別して処理したりする際に非常に役立ちます。

Copy
1<?php
2
3/**
4 * XMLReader を使用して、XMLドキュメント内の要素の名前空間URIを読み取るサンプル関数です。
5 * システムエンジニアを目指す初心者向けに、XMLにおける名前空間の概念と
6 * XMLReader::namespaceURI プロパティの基本的な使い方を示します。
7 */
8function demonstrateXmlNamespaceUriReading(): void
9{
10    // 1. 名前空間を含むXMLデータを用意します。
11    // 'library' と 'book' はそれぞれ異なる名前空間に属しています。
12    // 'magazine' は名前空間を持っていません。
13    $xmlString = <<<XML
14<?xml version="1.0" encoding="UTF-8"?>
15<library xmlns="http://example.com/ns/library">
16    <book xmlns:b="http://example.com/ns/book" b:id="123">
17        <b:title>PHP Programming</b:title>
18        <b:author>Jane Doe</b:author>
19    </book>
20    <magazine>
21        <title>Tech Weekly</title>
22    </magazine>
23</library>
24XML;
25
26    // 2. XMLReader オブジェクトを初期化します。
27    $reader = new XMLReader();
28
29    // 3. XML文字列をリーダーにロードします。
30    // 成功した場合はtrue、失敗した場合はfalseを返します。
31    if (!$reader->XML($xmlString)) {
32        echo "XMLデータのロードに失敗しました。\n";
33        return;
34    }
35
36    echo "--- XML 名前空間URIの読み取り開始 --- \n";
37
38    // 4. XMLノードを一つずつ読み進めます。
39    // read() メソッドは次のノードに移動し、読み込むノードがある限りtrueを返します。
40    while ($reader->read()) {
41        // 現在のノードが要素であるかチェックします。
42        // XMLReader::ELEMENT は要素ノードを表す定数です。
43        if ($reader->nodeType === XMLReader::ELEMENT) {
44            echo "要素名: " . $reader->name;
45
46            // namespaceURI プロパティを使用して、現在の要素の名前空間URIを取得します。
47            // 名前空間を持たない要素の場合、このプロパティは空の文字列を返します。
48            $namespaceUri = $reader->namespaceURI;
49
50            if (!empty($namespaceUri)) {
51                echo ", 名前空間URI: " . $namespaceUri . "\n";
52            } else {
53                echo ", 名前空間URI: (なし)\n";
54            }
55        }
56    }
57
58    // 5. XMLReader リソースを閉じます。
59    // これにより、関連するリソースが解放されます。
60    $reader->close();
61
62    echo "--- XML 名前空間URIの読み取り完了 --- \n";
63}
64
65// 上記で定義した関数を実行します。
66demonstrateXmlNamespaceUriReading();
67

XMLドキュメントにおいて、同じ名前の要素が異なる意味を持つ場合に衝突を防ぐために「名前空間」という仕組みが使われます。XMLReaderクラスは、このXMLドキュメントを効率的に順次読み込むためのPHPの機能です。

XMLReader::namespaceURIプロパティは、現在XMLReaderが読み込んでいるXML要素の名前空間URIを文字列として取得するために使用されます。このプロパティは引数を取らず、要素に名前空間が定義されている場合はそのURIを文字列で返します。もし名前空間が定義されていない要素の場合には、空の文字列が戻り値として返されます。

提供されたサンプルコードでは、名前空間を含むXMLデータを用意し、XMLReaderオブジェクトにロードしています。reader->read()メソッドでXMLノードを一つずつ読み進めながら、現在のノードがXML要素であるかを確認します。要素であれば、reader->nameで要素名を取得し、続けてreader->namespaceURIプロパティを用いてその要素の名前空間URIを取得しています。名前空間URIが存在すればそれを表示し、なければ「(なし)」と表示することで、XMLドキュメント内の各要素がどの名前空間に属しているかを具体的に示しています。最後にreader->close()でリソースを解放しています。