X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/2e847cf21b8ab9d15fa167b315ca5b2fa92638fc..7a654f8d43fdb43d78b63d90528bed6e86b608cc:/docs/api/Ext.data.writer.Writer.html diff --git a/docs/api/Ext.data.writer.Writer.html b/docs/api/Ext.data.writer.Writer.html new file mode 100644 index 00000000..3c8ac54b --- /dev/null +++ b/docs/api/Ext.data.writer.Writer.html @@ -0,0 +1,112 @@ +Ext.data.writer.Writer | Ext JS 4.0 Documentation +
For up to date documentation and features, visit +http://docs.sencha.com/ext-js/4-0

Sencha Documentation

+ + + + + +

Base Writer class used by most subclasses of Ext.data.proxy.Server. This class is +responsible for taking a set of Ext.data.Operation objects and a Ext.data.Request +object and modifying that request based on the Operations.

+ + + + +

For example a Ext.data.writer.Json would format the Operations and their Ext.data.Model +instances based on the config options passed to the JsonWriter's constructor.

+ + + + +

Writers are not needed for any kind of local storage - whether via a +Web Storage proxy (see localStorage +and sessionStorage) or just in memory via a +MemoryProxy.

+ +
Defined By

Config Options

Other Configs

 
This property is used to read the key for each value that will be sent to the server. +For example: + +Ext.define('Perso...

This property is used to read the key for each value that will be sent to the server. +For example:

+ +
Ext.define('Person', {
+    extend: 'Ext.data.Model',
+    fields: [{
+        name: 'first',
+        mapping: 'firstName'
+    }, {
+        name: 'last',
+        mapping: 'lastName'
+    }, {
+        name: 'age'
+    }]
+});
+new Ext.data.writer.Writer({
+    writeAllFields: true,
+    nameProperty: 'mapping'
+});
+
+// This will be sent to the server
+{
+    firstName: 'first name value',
+    lastName: 'last name value',
+    age: 1
+}
+
+
+ + +

Defaults to name. If the value is not present, the field name will always be used.

+
 
True to write all fields from the record to the server. If set to false it +will only send the fields that were modifi...

True to write all fields from the record to the server. If set to false it +will only send the fields that were modified. Defaults to true. Note that any fields that have +Ext.data.Field.persist set to false will still be ignored.

+
Defined By

Methods

 
Writer( +Object config) + : void

 

+

Parameters

  • config : Object

    Optional config object

    +

Returns

  • void    +
 
Formats the data for each record before sending it to the server. This +method should be overridden to format the data...

Formats the data for each record before sending it to the server. This +method should be overridden to format the data in a way that differs from the default.

+

Parameters

  • record : Object

    The record that we are writing to the server.

    +

Returns

  • Object   

    An object literal of name/value keys to be written to the server. +By default this method returns the data property on the record.

    +
 
write( +Ext.data.Request request) + : Ext.data.Request

Prepares a Proxy's Ext.data.Request object

+

Prepares a Proxy's Ext.data.Request object

+

Parameters

  • request : Ext.data.Request

    The request object

    +

Returns

  • Ext.data.Request   

    The modified request object

    +
\ No newline at end of file