X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/c930e9176a5a85509c5b0230e2bff5c22a591432..6e39d509471fe9b4e2660e0d1631b350d0c66f40:/docs/source/JsonWriter.html
diff --git a/docs/source/JsonWriter.html b/docs/source/JsonWriter.html
index 8a25ed19..91daa70d 100644
--- a/docs/source/JsonWriter.html
+++ b/docs/source/JsonWriter.html
@@ -1,5 +1,6 @@
+
The source code
@@ -14,14 +15,14 @@ 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
+ // TODO: remove after Ext-3.0.1 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.
+ * @cfg {Boolean} returnJson Deprecated, will be removed in Ext-3.0.1. Use {@link Ext.data.JsonWriter#encode} instead.
*/
returnJson : undefined,
/**
@@ -31,50 +32,53 @@ Ext.extend(Ext.data.JsonWriter, Ext.data.DataWriter, {
* 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
+ * 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,
/**
* 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"
+ * @param {Object} http params-object to write-to.
+ * @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 compiled Store-recordset.
*/
- 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;