PHP/SimpleXMLElement

Windows版PHP 5.2による調査。

SimpleXMLElementオブジェクトが表す情報は以下の4パターンがある。どの情報を表しているかによって、SimpleXMLElementのメソッドの動作、関数適用時の結果が異なる。

• 要素
• 要素セット (要素の集合)
  厳密には以下2つのケースがある
  • ->foo によって取得した要素セット
  • ->children()によって取得した要素セット
• 属性
• 属性セット (属性の集合)

名前空間を使わないXMLの場合

要素関連の操作

※1

foreach($xml as $key => $value) {...}

※2

$xml[0]に演算を適用したのと同じ結果が得られる

※3

index=0で$xml自身と同じ内容が得られる。また、index>0でPHPのWarning発生。有効な用途はない。

※4

indexは >=0。indexが要素数以上の場合はNULLが得られる。

※5

名前がnameの属性が存在しない場合はNULLが得られる。

※6

名前がnameの子要素が存在しない場合は空の要素セットが得られる。

※7

同じ名前の要素が複数ある場合でも、すべての要素が得られる。(繰り返し中で同じ$keyが何回か出現する)

※8

子要素が無ければ空の要素セットが得られる。

※9

属性が無ければ空の属性セットが得られる。

※10

SimpleXMLElementが得られるが、そのSimpleXMLElementにcount, empty などを実行しようとするとPHPのWarningが発生するため、実質的に利用できない。

※11

->nameで得られた要素セットと、->children()で得られた要素セットとでそれぞれ異なる動作をする。

※12

子要素とそのコンテントを除去して、残った文字列を連携したもの。改行や行頭空白も含まれる。

また、いずれの場合も、

 (boolean)$xml  === !empty($xml)

属性関連の操作

※1

foreach($xml as $key => $value) {...}

※2

$xml[0]に演算を適用したのと同じ結果が得られる

※3

index=0で$xml自身と同じ内容が得られる。また、index>0でPHPのWarning発生。有効な用途はない。

※4

indexは >=0。indexが属性数以上の場合はNULLが得られる。

また、いずれの場合も、

 (boolean)$xml  === !empty($xml)

留意点

• 「無い」ことを表すのに、NULLが返る場合と、空のセットが返る場合がある。
• 要素に対するempty($xml)は、要素のコンテント/子要素が無ければtrueとなるのに対し、属性のempty($xml)は属性の値が空でもtrueにはならない。
• 要素、属性については、count($xml)==0 ⇔ empty($xml)==true の関係が成り立たない。
• attributes(), children()で得られたセットについては、$xml->name はそのセットのフィルタ(サブセットの切り出し)として機能する。一方、要素の->name で得られたセットについては、$xml->name は $xml[0]->name の省略形として機能する。
• あるSimpleXMLElementが、要素、要素セット、属性、属性セットのどれなのかを区別する確実な方法がない。

名前空間を使うXMLの場合

要素関連の操作

$xmlは要素であり、children('名前空間')を経由して取得された要素とする。

$xml = $root->children('http://example.com/foo')->name[0];

childrenを経由していない要素だと挙動が異なるらしい。要確認。例えば、以下の$xmlを$rootに置き換えると挙動が異なる。

※1

prefixがなければ、名前空間の有無を問わず、名前空間が親($xml)と同じか否かを問わず、取得できる。このため、名前空間利用時にはこのメソッドは実質的に利用できない。例:<foo xmlns="x"><aaa/><bbb xmlns="y"/><cc:ccc xmlns:cc="x"/><dd:ddd xmlns:dd="y"/></foo> で$xmlがfooのとき、取得されるのはaaa, bbbである。

※2

純粋に名前空間で判断され、prefixを使っているかどうかを問わない。

※3

コンテントテキストの有無はemptyの結果に影響しない。この点で、名前空間を使わない場合と動作が異なる。

名前空間なしに属する要素を明示的に指定して取得することはできない。(例: <foo xmlns="x"><bar xmlns=""/><baz xmlns="z"/></foo> において 名前空間なしに属する要素だけを(barだけ)を取り出す方法がない)

countでは、子要素の有無を判定できない。自分と異なる名前空間の要素があってもcountには反映されないため。

属性関連の操作

未調査

メモ

名前空間を区別せず全子要素数を取得するには、getNamespacesで名前空間を列挙し、それぞれにchildrenを実行して子要素数をカウントし、合計すればよい、かもしれない。

メモ　安全に使うには

• $xml[0]で要素も要素セットも要素になる。
• 要素セットはプログラム内で流通させない。要素セットを取得したら即[]を適用して要素にする。