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

Copy
1<?php
2
3// このサンプルコードはPHP 8以降のDom拡張を使用しています。
4
5// サンプルとなるXML文字列を定義します。
6// 複数の名前空間（プレフィックス付きとデフォルト）が含まれています。
7$xmlString = <<<XML
8<root xmlns="http://example.com/default" xmlns:a="http://example.com/a">
9  <child1>
10    <a:grandchild1/>
11  </child1>
12  <child2>
13    <grandchild2/> <!-- この要素は親要素のデフォルト名前空間に属します -->
14    <a:anotherGrandchild/>
15  </child2>
16  <siblingElement xmlns:b="http://example.com/b">
17    <b:deepChild/>
18  </siblingElement>
19</root>
20XML;
21
22// Dom\Document オブジェクトを新しく作成します。
23$document = new Dom\Document();
24
25try {
26    // XML文字列をDom\Documentオブジェクトにロードします。
27    // PHP 8では、XMLの構文エラーが発生した場合、Dom\XmlError例外がスローされます。
28    $document->loadXML($xmlString);
29} catch (Dom\XmlError $e) {
30    // XMLロード中のエラーを捕捉し、エラーメッセージを表示してプログラムを終了します。
31    echo "XMLのロード中にエラーが発生しました: " . $e->getMessage() . "\n";
32    exit(1);
33}
34
35// ドキュメントのルート要素 (最上位の要素) をDom\Element型として取得します。
36// getDescendantNamespacesメソッドは、この要素のすべての子孫要素から名前空間を探します。
37$rootElement = $document->documentElement;
38
39// Dom\Element::getDescendantNamespaces() メソッドを呼び出します。
40// このメソッドは、現在の要素（この場合はルート要素）の子孫要素によって使用されている
41// すべての名前空間のURIと、それに対応するプレフィックスのペアを配列として返します。
42// 戻り値の配列は、キーが名前空間プレフィックス、値が名前空間URIの連想配列です。
43$descendantNamespaces = $rootElement->getDescendantNamespaces();
44
45echo "ルート要素 '{$rootElement->tagName}' の子孫から見つかった名前空間:\n";
46
47// 取得した名前空間の配列をループして、プレフィックスとURIを表示します。
48foreach ($descendantNamespaces as $prefix => $uri) {
49    // デフォルト名前空間（プレフィックスが指定されていない名前空間）の場合、
50    // プレフィックスのキーは空文字列 ('') になります。
51    $displayPrefix = $prefix === '' ? '[デフォルト名前空間]' : "{$prefix}";
52    echo "  プレフィックス: {$displayPrefix}, URI: {$uri}\n";
53}
54

このPHPのサンプルコードは、XMLドキュメント内で使用されている名前空間の情報を取得する方法を示しています。具体的には、Dom\ElementクラスのgetDescendantNamespacesメソッドを利用し、特定の要素の子孫が使用する名前空間のURIとプレフィックスを一覧で取得します。

まず、複数の名前空間を含むXML文字列をDom\Documentオブジェクトに読み込みます。これにより、XMLデータが操作可能な形式になります。エラーが発生した場合はDom\XmlError例外で適切に処理されます。

次に、ドキュメントの最上位にあるルート要素を取得し、そのDom\Elementインスタンスに対してgetDescendantNamespacesメソッドを呼び出します。このメソッドは引数を必要とせず、現在の要素だけでなく、その子孫要素がXML内で使用しているすべての名前空間の情報を収集します。

メソッドの戻り値は配列です。この配列は連想配列として構成されており、キーには名前空間のプレフィックス（例えばaやb）が、値には対応する名前空間のURI（例えばhttp://example.com/a）が格納されます。もし、プレフィックスが指定されていない「デフォルト名前空間」が見つかった場合は、そのプレフィックスは空文字列（''）として配列のキーになります。

この機能を使うことで、複雑なXML構造から利用されている名前空間を簡単に把握し、XMLデータをプログラムで効率的に処理するための手助けとなります。

Copy
1<?php
2
3// 複数の名前空間を持つXML文字列を定義します。
4// これにはデフォルト名前空間、プレフィックス付き名前空間、子孫要素で定義される名前空間が含まれます。
5$xmlString = <<<XML
6<?xml version="1.0" encoding="UTF-8"?>
7<root xmlns="http://example.com/ns/default"
8      xmlns:ex="http://example.com/ns/extra">
9  <child1 ex:attribute="value">
10    <!-- この要素で新しい名前空間 'sub' を定義 -->
11    <sub:grandchild xmlns:sub="http://example.com/ns/sub-child"/>
12  </child1>
13  <child2>
14    <!-- この要素で新しい名前空間 'an' を定義 -->
15    <anotherChild xmlns:an="http://example.com/ns/another-child">
16      <an:item/>
17    </anotherChild>
18  </child2>
19</root>
20XML;
21
22// DOMDocumentオブジェクトを作成し、XMLを読み込みます。
23$dom = new DOMDocument();
24// XMLのパースエラーを抑制し、代わりに警告として扱います。
25// error_reporting(E_ERROR | E_PARSE); を設定すると、XMLの形式エラーは警告として出力されます。
26// loadXML() は成功時にtrueを返しますが、ここでは簡略化のため戻り値チェックは省略します。
27$dom->loadXML($xmlString);
28
29// DOMXPathオブジェクトを作成し、XPathクエリを使用して要素を検索できるようにします。
30$xpath = new DOMXPath($dom);
31
32// ルート要素<root>を取得します。
33// query('/root') は DOMNodeList を返し、item(0) で最初の要素を取得します。
34$rootElement = $xpath->query('/root')->item(0);
35
36// 取得した要素が Dom\Element のインスタンスであるかを確認します。
37// PHP 8以降では、DOMNodeListから取得したXML要素は Dom\Element のインスタンスになります。
38if ($rootElement instanceof Dom\Element) {
39    // get_class() 関数を使用して、要素の正確なクラス名を表示します。
40    echo "取得した要素のクラス名: " . get_class($rootElement) . "\n\n";
41
42    // Dom\Element::getDescendantNamespaces() メソッドを使用して、
43    // この要素（$rootElement）の子孫要素で定義されているすべての名前空間の情報を取得します。
44    // 戻り値は連想配列で、キーは名前空間プレフィックス、値は名前空間URIです。
45    $descendantNamespaces = $rootElement->getDescendantNamespaces();
46
47    echo "子孫要素に定義されている名前空間:\n";
48    if (empty($descendantNamespaces)) {
49        echo "  - 子孫要素に名前空間は見つかりませんでした。\n";
50    } else {
51        // 取得した名前空間のリストをループして表示します。
52        foreach ($descendantNamespaces as $prefix => $uri) {
53            // デフォルト名前空間（プレフィックスがない場合）を分かりやすく表示します。
54            $displayPrefix = $prefix === '' ? '[デフォルト]' : $prefix;
55            echo "  - プレフィックス: '{$displayPrefix}', URI: '{$uri}'\n";
56        }
57    }
58} else {
59    // 要素が期待される Dom\Element のインスタンスでない場合のメッセージです。
60    echo "エラー: ルート要素が見つからないか、Dom\\Elementのインスタンスではありません。\n";
61}
62
63?>

このサンプルコードは、PHP 8で導入されたDom\ElementクラスのgetDescendantNamespacesメソッドの利用方法を説明しています。このメソッドは、特定のXML要素が持つ「子孫要素」に定義されている名前空間の情報をすべて取得するために使用されます。引数は必要なく、戻り値としては連想配列が返されます。この連想配列では、キーが名前空間のプレフィックス（デフォルト名前空間の場合は空文字列）、値が名前空間のURIとなります。

サンプルでは、デフォルト名前空間、プレフィックス付き名前空間、そして子孫要素内で新たに定義される名前空間を含む複雑なXML文字列を準備しています。DOMDocumentとDOMXPathを用いてXMLを読み込み、ルート要素である<root>を取得しています。取得した要素がDom\Elementのインスタンスであることを確認した後、getDescendantNamespacesメソッドを呼び出し、その結果を順に表示しています。これにより、sub:grandchild要素で定義されたsub名前空間や、an:anotherChild要素で定義されたan名前空間など、ルート要素の子孫で定義されている名前空間情報が正確に取得され、プレフィックスとURIの形式で出力されることがわかります。また、get_class関数を使ってオブジェクトの正確なクラス名を確認する方法も示されています。