Subclasses
Ext.data.JsonWriter
Ext.data.XmlWriter
Files
DataWriter.js

Ext.data.DataWriter facilitates create, update, and destroy actions between\nan Ext.data.Store and a server-side framework. A Writer enabled Store will\nautomatically manage the Ajax requests to perform CRUD actions on a Store.

\n\n\n

Ext.data.DataWriter is an abstract base class which is intended to be extended\nand should not be created directly. For existing implementations, see\nExt.data.JsonWriter.

\n\n\n

Creating a writer is simple:

\n\n\n

var writer = new Ext.data.JsonWriter({\n    encode: false   // <--- false causes data to be printed to jsonData config-property of Ext.Ajax#reqeust\n});\n

\n\n\n

Same old JsonReader as Ext-2.x:

\n\n\n

var reader = new Ext.data.JsonReader({idProperty: 'id'}, [{name: 'first'}, {name: 'last'}, {name: 'email'}]);\n

\n\n\n\n\n

The proxy for a writer enabled store can be configured with a simple url:

\n\n\n

// Create a standard HttpProxy instance.\nvar proxy = new Ext.data.HttpProxy({\n    url: 'app.php/users'    // <--- Supports \"provides\"-type urls, such as '/users.json', '/products.xml' (Hello Rails/Merb)\n});\n

\n\n\n

For finer grained control, the proxy may also be configured with an API:

\n\n\n

// Maximum flexibility with the API-configuration\nvar proxy = new Ext.data.HttpProxy({\n    api: {\n        read    : 'app.php/users/read',\n        create  : 'app.php/users/create',\n        update  : 'app.php/users/update',\n        destroy : {  // <--- Supports object-syntax as well\n            url: 'app.php/users/destroy',\n            method: \"DELETE\"\n        }\n    }\n});\n

\n\n\n

Pulling it all together into a Writer-enabled Store:

\n\n\n

var store = new Ext.data.Store({\n    proxy: proxy,\n    reader: reader,\n    writer: writer,\n    autoLoad: true,\n    autoSave: true  // -- Cell-level updates.\n});\n

\n\n\n

Initiating write-actions automatically, using the existing Ext2.0 Store/Record API:

\n\n\n

var rec = store.getAt(0);\nrec.set('email', 'foo@bar.com');  // <--- Immediately initiates an UPDATE action through configured proxy.\n\nstore.remove(rec);  // <---- Immediately initiates a DESTROY action through configured proxy.\n

\n\n\n

For record/batch updates, use the Store-configuration autoSave:false

\n\n\n

var store = new Ext.data.Store({\n    proxy: proxy,\n    reader: reader,\n    writer: writer,\n    autoLoad: true,\n    autoSave: false  // -- disable cell-updates\n});\n\nvar urec = store.getAt(0);\nurec.set('email', 'foo@bar.com');\n\nvar drec = store.getAt(1);\nstore.remove(drec);\n\n// Push the button!\nstore.save();\n

\n\n

Defined By

Config options

Ext.data.DataWriter
view source

createRecord : Function

Abstract method that should be implemented in all subclasses\n(e.g.: JsonWriter.createRecord)

Ext.data.DataWriter
view source

destroyRecord : Function

Abstract method that should be implemented in all subclasses\n(e.g.: JsonWriter.destroyRecord)

Ext.data.DataWriter
view source

listful : Boolean

false by default. ...

false by default. Set true to have the DataWriter always write HTTP params as a list,\neven when acting upon a single record.

Defaults to: false

Ext.data.DataWriter
view source

updateRecord : Function

Abstract method that should be implemented in all subclasses\n(e.g.: JsonWriter.updateRecord

Ext.data.DataWriter
view source

writeAllFields : Boolean

false by default. ...

false by default. Set true to have DataWriter return ALL fields of a modified\nrecord -- not just those that changed.\nfalse to have DataWriter only request modified fields from a record.

Defaults to: false

Defined By

Methods

Ext.data.DataWriter
view source

newExt.data.DataWriter( meta, recordType ) : Ext.data.DataWriter

Create a new DataWriter ...

Create a new DataWriter

Parameters

meta : Object
Metadata configuration options (implementation-specific)
\n
recordType : Object
Either an Array of field definition objects as specified\nin Ext.data.Record.create, or an Ext.data.Record object created\nusing Ext.data.Record.create.
\n

Returns

Ext.data.DataWriter
\n

Ext.data.DataWriter
view source

apply( params, baseParams, action, rs )

Compiles a Store recordset into a data-format defined by an extension such as Ext.data.JsonWriter or Ext.data.XmlWrit...

Compiles a Store recordset into a data-format defined by an extension such as Ext.data.JsonWriter or Ext.data.XmlWriter in preparation for a server-write action. The first two params are similar similar in nature to Ext.apply,\nWhere the first parameter is the receiver of paramaters and the second, baseParams, the source.

Parameters

params : Object
The request-params receiver.
\n
baseParams : Object
as defined by Ext.data.Store.baseParams. The baseParms must be encoded by the extending class, eg: Ext.data.JsonWriter, Ext.data.XmlWriter.
\n
action : String
[create|update|destroy]
\n
rs : Record/Record[]
The recordset to write, the subject(s) of the write action.
\n

Ext.data.DataWriter
view source

render( action, rs, params, data )

abstract method meant to be overridden by all DataWriter extensions. ...

abstract method meant to be overridden by all DataWriter extensions. It's the extension's job to apply the \"data\" to the \"params\".\nThe data-object provided to render is populated with data according to the meta-info defined in the user's DataReader config,

Parameters

action : String
[Ext.data.Api.actions.create|read|update|destroy]
\n
rs : Record[]
Store recordset
\n
params : Object
Http params to be sent to server.
\n
data : Object
object populated according to DataReader meta-data.
\n

Ext.data.DataWriter
view source

toArray( data ) : Object[]protected

Converts a Hashed Ext.data.Record to fields-array array suitable\nfor encoding to xml via XTemplate, eg:\n\n\n<tpl for...

Converts a Hashed Ext.data.Record to fields-array array suitable\nfor encoding to xml via XTemplate, eg:\n

\n\n<tpl for=\".\"><{name}>{value}</{name}</tpl>
\n\n\n

\neg, non-phantom:\n

\n\n{id: 1, first: 'foo', last: 'bar'} --> [{name: 'id', value: 1}, {name: 'first', value: 'foo'}, {name: 'last', value: 'bar'}]
\n\n\n

\nPhantom records will have had their idProperty omitted in toHash if determined to be auto-generated.\nNon AUTOINCREMENT pks should have been protected.

Parameters

data : Hash
Hashed by Ext.data.DataWriter.toHash
\n

Returns

Object[]
Array of attribute-objects.
\n

Ext.data.DataWriter
view source

toHash( rec, config ) : Objectprotected

Converts a Record to a hash, taking into account the state of the Ext.data.Record along with configuration properties...

Converts a Record to a hash, taking into account the state of the Ext.data.Record along with configuration properties\nrelated to its rendering, such as writeAllFields, phantom, getChanges and\nidProperty

Parameters

rec : Ext.data.Record
The Record from which to create a hash.
\n
config : Object
NOT YET IMPLEMENTED. Will implement an exlude/only configuration for fine-control over which fields do/don't get rendered.
\n

Returns

Object
TODO Implement excludes/only configuration with 2nd param?
\n