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

Copy
1<?php
2
3/**
4 * DOMTextノードのnamespaceURIプロパティの使用例を示します。
5 *
6 * この関数は、XML名前空間を持つDOM要素とその子テキストノードを作成し、
7 * テキストノードのnamespaceURIプロパティを取得して表示します。
8 *
9 * XML名前空間（xmlns）は、XMLドキュメント内で要素名や属性名の衝突を避けるための仕組みです。
10 * DOMText::namespaceURIは、テキストノードが属する親要素の名前空間URIを返します。
11 * PHPコードにおける名前空間（`namespace MyNamespace;`）とは異なる概念です。
12 */
13function demonstrateDomTextNamespaceURI(): void
14{
15    // DOMDocumentオブジェクトを作成
16    $dom = new DOMDocument('1.0', 'UTF-8');
17    $dom->formatOutput = true; // 出力を整形する
18
19    // XML名前空間URIとプレフィックスを定義
20    $namespaceUri = 'http://example.com/my-xml-namespace';
21    $prefix = 'my';
22
23    // 名前空間を持つルート要素を作成（例: <my:root xmlns:my="http://example.com/my-xml-namespace">）
24    // createElementNS は名前空間を持つ要素を作成する際に使用します。
25    $rootElement = $dom->createElementNS($namespaceUri, $prefix . ':root');
26    $dom->appendChild($rootElement);
27
28    // テキストノードを作成し、ルート要素に追加
29    $textContent = 'これは名前空間を持つ要素内のテキストです。';
30    $textNode = $dom->createTextNode($textContent);
31    $rootElement->appendChild($textNode);
32
33    // ドキュメント全体のXML構造を表示
34    echo "--- 生成されたXMLドキュメント ---" . PHP_EOL;
35    echo $dom->saveXML() . PHP_EOL;
36
37    // テキストノードのnamespaceURIプロパティを取得して表示
38    echo "--- DOMText::namespaceURI の確認 ---" . PHP_EOL;
39    echo "DOMText ノードのテキスト内容: " . $textNode->nodeValue . PHP_EOL;
40    // namespaceURI が null の場合は 'null (名前空間なし)' と表示する
41    echo "DOMText ノードの namespaceURI: " . ($textNode->namespaceURI ?? 'null (名前空間なし)') . PHP_EOL;
42
43    echo PHP_EOL;
44
45    // 比較のために、名前空間を持たない要素とテキストノードを作成
46    $noNsElement = $dom->createElement('noNamespaceElement');
47    $noNsTextContent = 'これは名前空間を持たない要素内のテキストです。';
48    $noNsTextNode = $dom->createTextNode($noNsTextContent);
49    $noNsElement->appendChild($noNsTextNode);
50
51    echo "--- 名前空間を持たないDOMText::namespaceURI の比較 ---" . PHP_EOL;
52    echo "名前空間を持たないDOMText ノードのテキスト内容: " . $noNsTextNode->nodeValue . PHP_EOL;
53    echo "名前空間を持たないDOMText ノードの namespaceURI: " . ($noNsTextNode->namespaceURI ?? 'null (名前空間なし)') . PHP_EOL;
54}
55
56// 関数を実行
57demonstrateDomTextNamespaceURI();

PHPのDOMText::namespaceURIプロパティは、XMLドキュメント内のテキストノードがどのXML名前空間に属しているかを示すURIを取得するために使われます。ここで言うXML名前空間は、XMLドキュメント内で要素名や属性名の衝突を避け、データの意味を明確にする仕組みであり、PHPのコードで利用するnamespace MyNamespace;のようなPHP言語の名前空間とは異なる概念です。

このプロパティは引数を取らず、テキストノードが属する親要素に名前空間が定義されている場合に、その名前空間のURIを表す文字列（string）を返します。たとえば、<prefix:element xmlns:prefix="http://example.com">テキスト</prefix:element>のような要素内のテキストノードであれば、"http://example.com"というURIが返されます。

もしテキストノードが名前空間を持たない親要素に属している場合や、親要素に名前空間が定義されていない場合は、このプロパティはnullを返します。サンプルコードでは、名前空間を持つ要素内のテキストノードからURIを取得する例と、名前空間を持たない要素内のテキストノードがnullを返す例が示されており、それぞれの挙動を比較して理解することができます。これにより、テキストノードがXML名前空間とどのように関連しているかをプログラムで判断できるようになります。

Copy
1<?php
2
3namespace App\DomExamples; // PHPの名前空間を定義
4
5use DOMDocument; // XMLドキュメントを扱うためのクラスをuse
6use DOMXPath;    // XPathクエリを扱うためのクラスをuse
7use DOMText;     // DOMツリー内のテキストノードを表現するクラスをuse
8
9/**
10 * DOMText::namespaceURI プロパティの使用例を示すクラスです。
11 * PHPのnamespaceとuseキーワードの基本的な使い方も合わせて示します。
12 */
13class DomTextNamespaceUriExample
14{
15    /**
16     * 指定されたXML文字列からDOMTextノードを見つけ、その内容とnamespaceURIを表示します。
17     *
18     * DOMText::namespaceURI は、XMLの仕様により、テキストノードがXML名前空間に直接属さないため、
19     * 通常は null を返します（リファレンス情報にある 'string|null' の 'null' の部分）。
20     *
21     * @param string $xmlString 処理するXML文字列
22     */
23    public function demonstrateNamespaceUri(string $xmlString): void
24    {
25        $dom = new DOMDocument();
26        // XML文字列を読み込みます。
27        // LIBXML_NOCDATA フラグは、CDATAセクションをテキストノードとして扱わないようにしますが、
28        // 今回の例では必須ではありません。デフォルトの振る舞いを確認します。
29        @$dom->loadXML($xmlString); // エラーが出ても処理を続行するため @ を使用
30
31        $xpath = new DOMXPath($dom);
32        // XML文書内のすべてのテキストノードを選択します。
33        // XPathの '//text()' は、あらゆる場所にあるテキストノードを意味します。
34        $textNodes = $xpath->query('//text()');
35
36        echo "DOMText::namespaceURI プロパティのデモンストレーション:\n";
37        echo "---------------------------------------------------\n";
38
39        foreach ($textNodes as $node) {
40            // DOMXPath::query は DOMNode のインスタンスを返します。
41            // DOMText::namespaceURI にアクセスするには、そのノードが DOMText インスタンスである必要があります。
42            if ($node instanceof DOMText) {
43                echo "テキストノードの内容: '" . $node->nodeValue . "'\n";
44
45                // DOMText::namespaceURI はstringまたはnullを返しますが、
46                // テキストノードの場合、一般的に null が返されます。
47                // nullの場合に "null (名前空間なし)" と表示します。
48                echo "namespaceURI: " . ($node->namespaceURI ?? "null (名前空間なし)") . "\n";
49                echo "---------------------------------------------------\n";
50            }
51        }
52    }
53}
54
55// ここからサンプルコードの実行部分です。
56// グローバルスコープから、App\DomExamples名前空間のDomTextNamespaceUriExampleクラスをuseして利用します。
57use App\DomExamples\DomTextNamespaceUriExample;
58
59// テスト用のXML文字列を定義します。
60// ここでは、ルート要素に名前空間を定義していますが、
61// DOMText::namespaceURI は通常 null を返すことを確認します。
62$xmlContent = <<<XML
63<root xmlns="http://example.com/my-namespace">
64    <item>
65        Hello <name>World</name>! This is a simple text example.
66    </item>
67    <data>
68        Another piece of text.
69    </data>
70</root>
71XML;
72
73// DomTextNamespaceUriExampleクラスのインスタンスを作成します。
74$example = new DomTextNamespaceUriExample();
75
76// demonstrateNamespaceUriメソッドを呼び出して、DOMText::namespaceURIの挙動を確認します。
77$example->demonstrateNamespaceUri($xmlContent);

DOMText::namespaceURIプロパティは、XMLドキュメント内のテキストノードが属する名前空間のURIを取得します。このプロパティは引数を取らず、戻り値として文字列（名前空間URI）またはnullを返します。しかし、XMLの仕様上、テキストノードは直接名前空間に属することがないため、このプロパティは通常nullを返します。

サンプルコードでは、PHPの名前空間（namespace）とuseキーワードを用いて、コードの整理と可読性向上を図っています。DOMDocumentクラスでXML文字列を読み込み、DOMXPathを使って文書内のすべてのテキストノード（//text()）を検索しています。その後、見つかった各DOMTextノードに対して、その内容（nodeValue）とnamespaceURIプロパティの値を表示しています。

出力結果からもわかるように、テキストノードのnamespaceURIはすべてnullとなっています。これは、たとえ親要素に名前空間が定義されていても、テキストデータ自体は特定の名前空間に直接関連付けられないというXMLの原則に基づいています。??演算子（null合体演算子）は、namespaceURIがnullの場合に「null (名前空間なし)」と表示するために使用されており、より分かりやすい出力となっています。このコードは、DOMText::namespaceURIプロパティの基本的な振る舞いと、PHPにおけるXML操作の基礎を示しています。