Zend_Json-Objects.xml 7.1 KB

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