repo_zf1/documentation/manual/ja/module_specs/Zend_View-Helpers-Json.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- Reviewed: no -->
<!-- EN-Revision: 24829 -->
<sect3 id="zend.view.helpers.initial.json">
    <title>JSON ヘルパー</title>

    <para>
        <acronym>JSON</acronym> を返すビューを作成する際に大事なのは、
        適切なレスポンスヘッダを設定することです。
        <acronym>JSON</acronym> ビューヘルパーは、まさにその作業を行います。
        さらに、デフォルトでレイアウト機能を無効にします (現在有効である場合)。
        <acronym>JSON</acronym> レスポンスでは通常レイアウト機能は使わないからです。
    </para>

    <para>
        <acronym>JSON</acronym> ヘルパーは次のようなヘッダを設定します。
    </para>

    <programlisting language="text"><![CDATA[
Content-Type: application/json
]]></programlisting>

    <para>
        たいていの <acronym>AJAX</acronym> ライブラリは、
        レスポンスでこのヘッダを見つけると適切に処理してくれます。
    </para>

    <para>
        <acronym>JSON</acronym> ヘルパーの使用法は、このように非常に単純です。
    </para>

    <programlisting language="php"><![CDATA[
<?php echo $this->json($this->data) ?>
]]></programlisting>

    <note>
        <title>レイアウトの維持、およびZend_Json_Expr によるエンコードの有効化</title>

        <para>
            <acronym>JSON</acronym> ヘルパーの各メソッドには、オプションで 2 番目の引数を指定できます。
            この 2 番目の引数は、レイアウト機能の有効/無効を指定する boolean フラグか
            あるいは <methodname>Zend_Json::encode()</methodname>
            に渡して内部的なデータのエンコードに使用するオプションの配列となります。
        </para>

        <para>
            レイアウトを維持するには、2 番目のパラメータを
            <constant>TRUE</constant> としなければなりません。
            2 番目のパラメータを配列ににする場合にレイアウトを維持するには、配列に
            <property>keepLayouts</property> というキーを含め、その値を
            <constant>TRUE</constant> にします。
        </para>

        <programlisting language="php"><![CDATA[
// 2 番目の引数に true を指定するとレイアウトが有効になります
echo $this->json($this->data, true);

// あるいは、キー "keepLayouts" に true を指定します
echo $this->json($this->data, array('keepLayouts' => true));
]]></programlisting>

        <para>
            <methodname>Zend_Json::encode()</methodname> は、ネイティブ <acronym>JSON</acronym> 式を
            <classname>Zend_Json_Expr</classname> オブジェクトを使用してエンコードできます。
            このオプションはデフォルトでは無効になっています。
            有効にするには、<property>enableJsonExprFinder</property>
            オプションに <constant>TRUE</constant> を設定します。
        </para>

        <programlisting language="php"><![CDATA[
<?php echo $this->json($this->data, array(
    'enableJsonExprFinder' => true, 
    'keepLayouts'          => true,
)) ?>
]]></programlisting>
    </note>

    <!-- TODO : to be translated -->
    <note>
        <title>Sending pre-encoded JSON</title>

        <para>
            By default, the <acronym>JSON</acronym> helper will JSON-encode the 
            data provided to the helper's first parameter.  If you wish to pass 
            in data which has already been encoded into <acronym>JSON</acronym>, 
            the third parameter needs to be set to boolean <constant>FALSE</constant>.  
            When the second parameter is an array, disabling <acronym>JSON</acronym> 
            encoding can be achived by including a <property>encodeData</property> 
            key with the value of boolean <constant>FALSE</constant>:
        </para>

        <programlisting language="php"><![CDATA[
// Boolean false as third argument disables internal JSON encoding of data
echo $this->json($this->data, false, false);

// Or boolean false as "encodeData" key:
echo $this->json($this->data, array('encodeData' => false));
]]></programlisting>

    </note>

</sect3>
<!--
vim:se ts=4 sw=4 et:
-->