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

getDocNamespacesメソッドは、SimpleXMLIteratorオブジェクトが指すXMLドキュメント内で宣言されている名前空間の情報を取得するメソッドです。XMLの名前空間は、異なるXML語彙の要素名や属性名の衝突を避けるために利用されます。このメソッドは、現在のXML要素のコンテキストで宣言されている名前空間を、プレフィックスをキー、URIを値とする連想配列として返します。

このメソッドは二つのオプション引数を持っています。$recursive引数（デフォルトはfalse）がtrueの場合、現在の要素だけでなくその子孫要素で宣言されている名前空間も再帰的に検索し取得します。$from_root引数（デフォルトはtrue）がfalseの場合、ドキュメントのルート要素で宣言されている名前空間は検索対象から除外され、現在の要素とその親要素で宣言されている名前空間のみが返されます。

このメソッドは、XMLドキュメント内の名前空間構造を把握し、特定の名前空間に属する要素を効率的に処理する際に役立ちます。

Copy
1<?php
2$xmlString = '<root xmlns:ex="http://example.com/ns"><ex:child /></root>';
3$iterator = new SimpleXMLIterator($xmlString);
4$namespaces = $iterator->getDocNamespaces();

bool $recursive = false, bool $from_root = true

• bool $recursive = false: XMLドキュメント内のすべての名前空間を再帰的に取得するかどうかを指定します。trueを指定すると、子要素の名前空間も取得します。
• bool $from_root = true: ルート要素から名前空間を取得するかどうかを指定します。trueを指定すると、ドキュメントのルート要素から取得します。falseを指定すると、現在の要素から取得します。

array

SimpleXMLIterator::getDocNamespacesメソッドは、XMLドキュメントのドキュメントスコープの名前空間を配列として返します。この配列は、名前空間のURIをキー、名前空間のプレフィックスを値として持ちます。