Zend_Json-Objects.xml 7.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- Reviewed: no -->
  3. <!-- EN-Revision: 24249 -->
  4. <sect1 id="zend.json.advanced">
  5. <title>Zend_Json の高度な使用法</title>
  6. <sect2 id="zend.json.advanced.objects1">
  7. <title>JSON オブジェクト</title>
  8. <para>
  9. <acronym>PHP</acronym> オブジェクトを <acronym>JSON</acronym> にエンコードすると、
  10. オブジェクトの public プロパティがすべて <acronym>JSON</acronym>
  11. オブジェクトにエンコードされます。
  12. </para>
  13. <para>
  14. <acronym>JSON</acronym> はオブジェクトへの参照を扱うことができません。
  15. 再帰的な参照を伴うオブジェクトをエンコードしないように気をつけましょう。
  16. 再帰に関する問題が発生しないよう、
  17. <methodname>Zend_Json::encode()</methodname> および
  18. <methodname>Zend_Json_Encoder::encode()</methodname>
  19. のオプションの二番目のパラメータで再帰をチェックできます。
  20. オブジェクトが二度シリアライズされると、例外がスローされるようになります。
  21. </para>
  22. <para>
  23. <acronym>JSON</acronym> オブジェクトのデコードは、さらに大変です。Javascript
  24. のオブジェクトを <acronym>PHP</acronym> に対応させるなら、連想配列にするのが一番近いでしょう。
  25. しかし、中には「クラスの ID を渡してそのインスタンスを作成し、
  26. <acronym>JSON</acronym> オブジェクトの キー/値 をそのインスタンスに代入すべきだという人もいます。
  27. また、そんなことをするとセキュリティ上問題があるという人もいるでしょう。
  28. </para>
  29. <para>
  30. デフォルトでは、<classname>Zend_Json</classname> は <acronym>JSON</acronym>
  31. オブジェクトを連想配列にデコードします。しかし、
  32. もしオブジェクトとして受け取りたいのなら、そのように指定することもできます。
  33. </para>
  34. <programlisting language="php"><![CDATA[
  35. // JSONオブジェクトをPHPオブジェクトにデコードします
  36. $phpNative = Zend_Json::decode($encodedValue, Zend_Json::TYPE_OBJECT);
  37. ]]></programlisting>
  38. <para>
  39. このようにしてデコードされたオブジェクトは <classname>StdClass</classname>
  40. オブジェクトとなり、<acronym>JSON</acronym> の キー/値
  41. のペアに対応するプロパティを保持します。
  42. </para>
  43. <para>
  44. Zend Framework の推奨する方法は、各開発者が <acronym>JSON</acronym>
  45. オブジェクトのデコード方法を決めるべきだというものです。
  46. もし特定の型のオブジェクトを返してほしいのなら、
  47. お望みの型のオブジェクトを開発者自身が作成したうえで、
  48. <classname>Zend_Json</classname> がデコードした値をそこに代入していけばいいのです。
  49. </para>
  50. </sect2>
  51. <sect2 id="zend.json.advanced.objects2">
  52. <title>PHP オブジェクトのエンコード</title>
  53. <para>
  54. <acronym>PHP</acronym> オブジェクトをエンコードする際に、
  55. デフォルトでエンコードメカニズムがアクセスできるのはオブジェクトの
  56. public プロパティのみです。エンコードするオブジェクトに
  57. <methodname>toJson()</methodname> メソッドが実装されていれば、
  58. <classname>Zend_Json</classname> はこのメソッドを実行します。
  59. このメソッドは、オブジェクトの内部状態を <acronym>JSON</acronym> 表現で返すものと期待されています。
  60. </para>
  61. </sect2>
  62. <sect2 id="zend.json.advanced.internal">
  63. <title>内部エンコーダ/デコーダ</title>
  64. <para>
  65. <classname>Zend_Json</classname> には二通りのモードがあり、<acronym>PHP</acronym> 環境で ext/json
  66. が有効になっているかどうかによってどちらを使うかが変わります。
  67. ext/json がインストールされていれば、デフォルトで
  68. <methodname>json_encode()</methodname> 関数および <methodname>json_decode()</methodname>
  69. 関数を使用して <acronym>JSON</acronym> のエンコード/デコードを行います。
  70. ext/json がインストールされていない場合は、<acronym>PHP</acronym> コードによる
  71. Zend Framework の実装を用いてエンコード/デコードを行います。
  72. これは <acronym>PHP</acronym> 拡張モジュールを使う場合にくらべて相当遅くなりますが、
  73. まったく同じ挙動になります。
  74. </para>
  75. <para>
  76. しかし、ext/json がインストール環境で敢えて内部エンコーダ/
  77. デコーダを使いたくなる場合もあるかもしれません。
  78. そんなときは次のようにコールします。
  79. </para>
  80. <programlisting language="php"><![CDATA[
  81. Zend_Json::$useBuiltinEncoderDecoder = true:
  82. ]]></programlisting>
  83. </sect2>
  84. <sect2 id="zend.json.advanced.expr">
  85. <title>JSON 式</title>
  86. <para>
  87. Javascript では無名関数のコールバックを多用します。
  88. そしてそれが <acronym>JSON</acronym> オブジェクト変数内に保存されます。
  89. これが動作するのはダブルクォートの中で返されていない場合のみであり、
  90. <classname>Zend_Json</classname> は当然そのようにします。
  91. <classname>Zend_Json</classname> の式サポートを使用すれば、<acronym>JSON</acronym> オブジェクトを
  92. javascript コールバックとして正しい形式でエンコードできます。
  93. これは、<methodname>json_encode()</methodname> と内部エンコーダの両方で動作します。
  94. </para>
  95. <para>
  96. javascript コールバックは <classname>Zend_Json_Expr</classname> オブジェクトで表されます。
  97. これは value object パターンを実装しており、不変 (immutable) です。
  98. javascript の式を、コンストラクタの最初の引数として指定できます。
  99. デフォルトでは <classname>Zend_Json::encode</classname> は javascript
  100. コールバックをエンコードしません。エンコードするには、
  101. オプション <property>enableJsonExprFinder</property> を渡し、
  102. <methodname>encode</methodname> 関数に <constant>TRUE</constant> を設定しなければなりません。
  103. これを有効にすると、
  104. 大きなオブジェクト構造の中の入れ子状の式に対しても式サポートが有効となります。
  105. 次のようにして使用します。
  106. </para>
  107. <programlisting language="php"><![CDATA[
  108. $data = array(
  109. 'onClick' => new Zend_Json_Expr('function() {'
  110. . 'alert("I am a valid javascript callback '
  111. . 'created by Zend_Json"); }'),
  112. 'other' => 'no expression',
  113. );
  114. $jsonObjectWithExpression = Zend_Json::encode(
  115. $data,
  116. false,
  117. array('enableJsonExprFinder' => true)
  118. );
  119. ]]></programlisting>
  120. </sect2>
  121. </sect1>
  122. <!--
  123. vim:se ts=4 sw=4 et:
  124. -->