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

getDocNamespacesメソッドは、SimpleXMLElementオブジェクトが表すXML要素に関連付けられた名前空間の情報を取得するメソッドです。XMLにおける名前空間は、要素や属性の名前が重複するのを防ぎ、異なるXML語彙を組み合わせる際にその意味を明確にするための仕組みです。このメソッドは、そうした名前空間の定義情報を連想配列として返します。

返される連想配列のキーは名前空間のプレフィックス（例: "soap"）、値はその名前空間を識別するためのURI（例: "http://schemas.xmlsoap.org/soap/envelope/"）です。デフォルトでは、現在のXML要素のスコープで有効な名前空間が取得されます。

引数として、名前空間の取得範囲を制御できます。最初の引数であるrecursiveにtrueを設定すると、現在の要素だけでなく、その子孫要素で宣言されている名前空間もすべて取得します。二番目の引数であるfrom_rootにtrueを設定すると、現在の要素自身で明示的に宣言されている名前空間のみを取得します。これにより、親要素から継承された名前空間ではなく、その要素固有の宣言に絞って情報を得ることが可能です。

これらの引数を適切に使うことで、特定のXML要素が使用している名前空間、あるいはドキュメント全体で定義されているすべての名前空間を柔軟に調べることができます。XMLデータをプログラムで解析し、特定の名前空間を持つ要素や属性を操作する際に非常に役立ちます。

Copy
1<?php
2
3$sxe = new SimpleXMLElement('<element xmlns:myprefix="http://example.com"/>');
4
5// SimpleXMLElement::getDocNamespaces メソッドの構文
6$namespaces = $sxe->getDocNamespaces(true, true);
7
8?>

?bool $recursive = false, ?bool $from_root = true

• bool $recursive = false: XMLドキュメントのルート要素だけでなく、すべての子要素で名前空間を再帰的に検索するかどうかを指定します。trueに設定すると、すべての子要素が検索されます。
• bool $from_root = true: 名前空間の検索をルート要素から開始するかどうかを指定します。falseに設定すると、現在の要素から名前空間が検索されます。

array

SimpleXMLElementオブジェクトが持つ、XMLドキュメント内の名前空間の定義を配列で返します。配列のキーは名前空間のプレフィックス、値はその名前空間のURIとなります。