XML から JSON への変換

Zend_Json には、XML 形式のデータを JSON 形式に変換するための便利なメソッドがあります。 この機能は » IBM developerWorks の記事 に触発されて追加したものです。

Zend_Json には、静的関数 Zend_Json::fromXml() が搭載されています。この関数は、XML を受け取って JSON を作成します。 入力パラメータには、任意の XML 文字列を渡せます。 また、オプションのパラメータで論理値を渡し、 変換処理中に XML の属性を無視するかどうかを指定できます。 このパラメータを省略した場合のデフォルトの挙動は、 XML の属性を無視します。この関数の使用法は、以下のようになります。

  1. // fromXml 関数の入力には、XML を含む文字列を渡します
  2. $jsonContents = Zend_Json::fromXml($xmlStringContents, true);

Zend_Json::fromXml() 関数は、 入力として渡された XML 形式の文字列を、 それと同等な JSON 形式の文字列に変換して返します。 XML の書式にエラーがあったり変換中にエラーが発生した場合は、 この関数は例外をスローします。 変換ロジックは、XML ツリーを再帰的に走査します。 最大で 25 段階までの再帰を行います。 それ以上の深さに達した場合は Zend_Json_Exception をスローします。Zend Framework の tests ディレクトリ内には XML ファイルがいくつか入っているので、 それらを用いると xml2json の機能を確認できます。

XML 入力文字列の例と、 Zend_Json::fromXml() 関数が返す JSON 文字列の例を次に示します。 この例では、オプションのパラメータで XML の属性を無視しないように設定しています。 そのため、JSON 文字列の中に XML の属性の情報が含まれていることがわかるでしょう。

Zend_Json::fromXml() 関数に渡す XML 入力文字列です。

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <books>
  3.     <book id="1">
  4.         <title>Code Generation in Action</title>
  5.         <author><first>Jack</first><last>Herrington</last></author>
  6.         <publisher>Manning</publisher>
  7.     </book>
  8.  
  9.     <book id="2">
  10.         <title>PHP Hacks</title>
  11.         <author><first>Jack</first><last>Herrington</last></author>
  12.         <publisher>O'Reilly</publisher>
  13.     </book>
  14.  
  15.     <book id="3">
  16.         <title>Podcasting Hacks</title>
  17.         <author><first>Jack</first><last>Herrington</last></author>
  18.         <publisher>O'Reilly</publisher>
  19.     </book>
  20. </books>

Zend_Json::fromXml() 関数が返す JSON 文字列です。

  1. {
  2.    "books" : {
  3.       "book" : [ {
  4.          "@attributes" : {
  5.             "id" : "1"
  6.          },
  7.          "title" : "Code Generation in Action",
  8.          "author" : {
  9.             "first" : "Jack", "last" : "Herrington"
  10.          },
  11.          "publisher" : "Manning"
  12.       }, {
  13.          "@attributes" : {
  14.             "id" : "2"
  15.          },
  16.          "title" : "PHP Hacks", "author" : {
  17.             "first" : "Jack", "last" : "Herrington"
  18.          },
  19.          "publisher" : "O'Reilly"
  20.       }, {
  21.          "@attributes" : {
  22.             "id" : "3"
  23.          },
  24.          "title" : "Podcasting Hacks", "author" : {
  25.             "first" : "Jack", "last" : "Herrington"
  26.          },
  27.          "publisher" : "O'Reilly"
  28.       }
  29.    ]}
  30. }

変更内容

1.11.6 での変更内容

Starting from the release 1.11.6 the Zend_Json::fromXml() function has been rewritten from scratch in order to manage XML element with attributes, text value and sub-elements (see the » ZF-3257).

For instance, if you have an XML document like this:

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <a>
  3.     <b id="foo"/>
  4.     bar
  5. </a>

Zend_Json::fromXml() から返される JSON 出力文字列はこうです。

  1. {
  2.    "a" : {
  3.       "b" : {
  4.          "@attributes" : {
  5.             "id" : "foo"
  6.          }
  7.       },
  8.       "@text" : "bar"
  9.    }
  10. }

The idea is to use a special key value (@text) to store the text value of an XML element, only if this element contains attributes or sub-elements (as in the previous examples). If you have a simple XML element with only a text value, like this:

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <a>foo</a>

the JSON will be {"a":"foo"} that is quite intuitive, instead of {"a":{"@text":"foo"}}.

blog comments powered by Disqus