X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/c930e9176a5a85509c5b0230e2bff5c22a591432..b37ceabb82336ee82757cd32efe353cfab8ec267:/docs/source/JsonWriter.html diff --git a/docs/source/JsonWriter.html b/docs/source/JsonWriter.html index 8a25ed19..3af977d0 100644 --- a/docs/source/JsonWriter.html +++ b/docs/source/JsonWriter.html @@ -1,84 +1,106 @@ - - - The source code - - - - -
/** + + + + The source code + + + + +
/*!
+ * Ext JS Library 3.2.2
+ * Copyright(c) 2006-2010 Ext JS, Inc.
+ * licensing@extjs.com
+ * http://www.extjs.com/license
+ */
+
/** * @class Ext.data.JsonWriter * @extends Ext.data.DataWriter * DataWriter extension for writing an array or single {@link Ext.data.Record} object(s) in preparation for executing a remote CRUD action. */ -Ext.data.JsonWriter = function(config) { - Ext.data.JsonWriter.superclass.constructor.call(this, config); - - // careful to respect "returnJson", renamed to "encode" - // TODO: remove after v3 final release - if (this.returnJson != undefined) { - this.encode = this.returnJson; - } -} -Ext.extend(Ext.data.JsonWriter, Ext.data.DataWriter, { -
/** - * @cfg {Boolean} returnJson Deprecated. Use {@link Ext.data.JsonWriter#encode} instead. - */ - returnJson : undefined, +Ext.data.JsonWriter = Ext.extend(Ext.data.DataWriter, {
/** - * @cfg {Boolean} encode true to {@link Ext.util.JSON#encode encode} the - * {@link Ext.data.DataWriter#toHash hashed data}. Defaults to true. When using - * {@link Ext.data.DirectProxy}, set this to false since Ext.Direct.JsonProvider will perform + * @cfg {Boolean} encode

true to {@link Ext.util.JSON#encode JSON encode} the + * {@link Ext.data.DataWriter#toHash hashed data} into a standard HTTP parameter named after this + * Reader's meta.root property which, by default is imported from the associated Reader. Defaults to true.

+ *

If set to false, the hashed data is {@link Ext.util.JSON#encode JSON encoded}, along with + * the associated {@link Ext.data.Store}'s {@link Ext.data.Store#baseParams baseParams}, into the POST body.

+ *

When using {@link Ext.data.DirectProxy}, set this to false since Ext.Direct.JsonProvider will perform * its own json-encoding. In addition, if you're using {@link Ext.data.HttpProxy}, setting to false * will cause HttpProxy to transmit data using the jsonData configuration-params of {@link Ext.Ajax#request} - * instead of params. When using a {@link Ext.data.Store#restful} Store, some serverside frameworks are - * tuned to expect data through the jsonData mechanism. In those cases, one will want to set encode: false + * instead of params.

+ *

When using a {@link Ext.data.Store#restful} Store, some serverside frameworks are + * tuned to expect data through the jsonData mechanism. In those cases, one will want to set encode: false, as in + * let the lower-level connection object (eg: Ext.Ajax) do the encoding.

*/ encode : true, +
/** + * @cfg {Boolean} encodeDelete False to send only the id to the server on delete, true to encode it in an object + * literal, eg:

+{id: 1}
+ * 
Defaults to false + */ + encodeDelete: false, + + constructor : function(config){ + Ext.data.JsonWriter.superclass.constructor.call(this, config); + },
/** - * Final action of a write event. Apply the written data-object to params. - * @param {String} action [Ext.data.Api.actions.create|read|update|destroy] - * @param {Record[]} rs - * @param {Object} http params - * @param {Object} data object populated according to DataReader meta-data "root" and "idProperty" + *

This method should not need to be called by application code, however it may be useful on occasion to + * override it, or augment it with an {@link Function#createInterceptor interceptor} or {@link Function#createSequence sequence}.

+ *

The provided implementation encodes the serialized data representing the Store's modified Records into the Ajax request's + * params according to the {@link #encode} setting.

+ * @param {Object} Ajax request params object to write into. + * @param {Object} baseParams as defined by {@link Ext.data.Store#baseParams}. The baseParms must be encoded by the extending class, eg: {@link Ext.data.JsonWriter}, {@link Ext.data.XmlWriter}. + * @param {Object/Object[]} data Data object representing the serialized modified records from the Store. May be either a single object, + * or an Array of objects - user implementations must handle both cases. */ - render : function(action, rs, params, data) { - Ext.apply(params, data); - - if (this.encode === true) { // <-- @deprecated returnJson - if (Ext.isArray(rs) && data[this.meta.idProperty]) { - params[this.meta.idProperty] = Ext.encode(params[this.meta.idProperty]); - } - params[this.meta.root] = Ext.encode(params[this.meta.root]); + render : function(params, baseParams, data) { + if (this.encode === true) { + // Encode here now. + Ext.apply(params, baseParams); + params[this.meta.root] = Ext.encode(data); + } else { + // defer encoding for some other layer, probably in {@link Ext.Ajax#request}. Place everything into "jsonData" key. + var jdata = Ext.apply({}, baseParams); + jdata[this.meta.root] = data; + params.jsonData = jdata; } },
/** - * createRecord + * Implements abstract Ext.data.DataWriter#createRecord * @protected * @param {Ext.data.Record} rec + * @return {Object} */ createRecord : function(rec) { - var data = this.toHash(rec); - delete data[this.meta.idProperty]; - return data; + return this.toHash(rec); },
/** - * updateRecord + * Implements abstract Ext.data.DataWriter#updateRecord * @protected * @param {Ext.data.Record} rec + * @return {Object} */ updateRecord : function(rec) { return this.toHash(rec); },
/** - * destroyRecord + * Implements abstract Ext.data.DataWriter#destroyRecord * @protected * @param {Ext.data.Record} rec + * @return {Object} */ - destroyRecord : function(rec) { - return rec.id; + destroyRecord : function(rec){ + if(this.encodeDelete){ + var data = {}; + data[this.meta.idProperty] = rec.id; + return data; + }else{ + return rec.id; + } } -});
- +});
+ \ No newline at end of file