docs/source/Json2.html

   1 <!DOCTYPE html><html><head><title>Sencha Documentation Project</title><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../prettify.css" type="text/css"><link rel="stylesheet" href="../prettify_sa.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script></head><body onload="prettyPrint()"><pre class="prettyprint"><pre><span id='Ext-data.writer.Json'>/**
   2 </span> * @class Ext.data.writer.Json
   3  * @extends Ext.data.writer.Writer
   4  * @ignore
   5  */
   6 Ext.define('Ext.data.writer.Json', {
   7     extend: 'Ext.data.writer.Writer',
   8     alternateClassName: 'Ext.data.JsonWriter',
   9     alias: 'writer.json',
  10
  11 <span id='Ext-data.writer.Json-cfg-root'>    /**
  12 </span>     * @cfg {String} root The key under which the records in this Writer will be placed. Defaults to &lt;tt&gt;undefined&lt;/tt&gt;.
  13      * Example generated request, using root: 'records':
  14 &lt;pre&gt;&lt;code&gt;
  15 {'records': [{name: 'my record'}, {name: 'another record'}]}
  16 &lt;/code&gt;&lt;/pre&gt;
  17      */
  18     root: undefined,
  19
  20 <span id='Ext-data.writer.Json-cfg-encode'>    /**
  21 </span>     * @cfg {Boolean} encode True to use Ext.encode() on the data before sending. Defaults to &lt;tt&gt;false&lt;/tt&gt;.
  22      * The encode option should only be set to true when a {@link #root} is defined, because the values will be
  23      * sent as part of the request parameters as opposed to a raw post. The root will be the name of the parameter
  24      * sent to the server.
  25      */
  26     encode: false,
  27
  28 <span id='Ext-data.writer.Json-cfg-allowSingle'>    /**
  29 </span>     * @cfg {Boolean} allowSingle False to ensure that records are always wrapped in an array, even if there is only
  30      * one record being sent. When there is more than one record, they will always be encoded into an array.
  31      * Defaults to &lt;tt&gt;true&lt;/tt&gt;. Example:
  32      * &lt;pre&gt;&lt;code&gt;
  33 // with allowSingle: true
  34 &quot;root&quot;: {
  35     &quot;first&quot;: &quot;Mark&quot;,
  36     &quot;last&quot;: &quot;Corrigan&quot;
  37 }
  38
  39 // with allowSingle: false
  40 &quot;root&quot;: [{
  41     &quot;first&quot;: &quot;Mark&quot;,
  42     &quot;last&quot;: &quot;Corrigan&quot;
  43 }]
  44      * &lt;/code&gt;&lt;/pre&gt;
  45      */
  46     allowSingle: true,
  47
  48     //inherit docs
  49     writeRecords: function(request, data) {
  50         var root = this.root;
  51
  52         if (this.allowSingle &amp;&amp; data.length == 1) {
  53             // convert to single object format
  54             data = data[0];
  55         }
  56
  57         if (this.encode) {
  58             if (root) {
  59                 // sending as a param, need to encode
  60                 request.params[root] = Ext.encode(data);
  61             } else {
  62                 //&lt;debug&gt;
  63                 Ext.Error.raise('Must specify a root when using encode');
  64                 //&lt;/debug&gt;
  65             }
  66         } else {
  67             // send as jsonData
  68             request.jsonData = request.jsonData || {};
  69             if (root) {
  70                 request.jsonData[root] = data;
  71             } else {
  72                 request.jsonData = data;
  73             }
  74         }
  75         return request;
  76     }
  77 });
  78 </pre></pre></body></html>