Base Writer class used by most subclasses of Ext.data.proxy.Server. This class is\nresponsible for taking a set of Ext.data.Operation objects and a Ext.data.Request\nobject and modifying that request based on the Operations.
\n\n\n\n\nFor example a Ext.data.writer.Json would format the Operations and their Ext.data.Model \ninstances based on the config options passed to the JsonWriter's constructor.
\n\n\n\n\nWriters are not needed for any kind of local storage - whether via a\nWeb Storage proxy (see localStorage\nand sessionStorage) or just in memory via a\nMemoryProxy.
\n\n", - "extends": "Object", - "mixins": [ + "allMixins": [ ], - "alternateClassNames": [ - "Ext.data.DataWriter", - "Ext.data.Writer" - ], - "xtype": null, - "author": "Ed Spencer", + "deprecated": null, "docauthor": null, - "singleton": false, - "private": false, - "cfg": [ - { - "tagname": "cfg", - "name": "nameProperty", - "member": "Ext.data.writer.Writer", - "type": "String", - "doc": "This property is used to read the key for each value that will be sent to the server.\nFor example:
\n\nExt.define('Person', {\n extend: 'Ext.data.Model',\n fields: [{\n name: 'first',\n mapping: 'firstName'\n }, {\n name: 'last',\n mapping: 'lastName'\n }, {\n name: 'age'\n }]\n});\nnew Ext.data.writer.Writer({\n writeAllFields: true,\n nameProperty: 'mapping'\n});\n\n// This will be sent to the server\n{\n firstName: 'first name value',\n lastName: 'last name value',\n age: 1\n}\n\nDefaults to name. If the value is not present, the field name will always be used.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/writer/Writer.js", - "linenr": 32, - "html_filename": "Writer.html", - "href": "Writer.html#Ext-data-writer-Writer-cfg-nameProperty", - "shortDoc": "This property is used to read the key for each value that will be sent to the server.\nFor example:\n\nExt.define('Perso..." - }, - { - "tagname": "cfg", - "name": "writeAllFields", - "member": "Ext.data.writer.Writer", - "type": "Boolean", - "doc": "True to write all fields from the record to the server. If set to false it\nwill only send the fields that were modified. Defaults to true. Note that any fields that have\nExt.data.Field.persist set to false will still be ignored.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/writer/Writer.js", - "linenr": 25, - "html_filename": "Writer.html", - "href": "Writer.html#Ext-data-writer-Writer-cfg-writeAllFields", - "shortDoc": "True to write all fields from the record to the server. If set to false it\nwill only send the fields that were modifi..." - } - ], - "method": [ - { - "tagname": "method", - "name": "Writer", - "member": "Ext.data.writer.Writer", - "doc": "\n", - "params": [ - { + "members": { + "cfg": [ + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Writer.html#Ext-data-writer-Writer-cfg-nameProperty", + "shortDoc": "This property is used to read the key for each value that will be sent to the server. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/writer/Writer.js", + "private": false, + "name": "nameProperty", + "owner": "Ext.data.writer.Writer", + "doc": "This property is used to read the key for each value that will be sent to the server.\nFor example:
\n\nExt.define('Person', {\n extend: 'Ext.data.Model',\n fields: [{\n name: 'first',\n mapping: 'firstName'\n }, {\n name: 'last',\n mapping: 'lastName'\n }, {\n name: 'age'\n }]\n});\nnew Ext.data.writer.Writer({\n writeAllFields: true,\n nameProperty: 'mapping'\n});\n\n// This will be sent to the server\n{\n firstName: 'first name value',\n lastName: 'last name value',\n age: 1\n}\n\nDefaults to name. If the value is not present, the field name will always be used.
\n", + "linenr": 29, + "html_filename": "Writer.html" + }, + { + "type": "Boolean", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Writer.html#Ext-data-writer-Writer-cfg-writeAllFields", + "shortDoc": "True to write all fields from the record to the server. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/writer/Writer.js", + "private": false, + "name": "writeAllFields", + "owner": "Ext.data.writer.Writer", + "doc": "True to write all fields from the record to the server. If set to false it\nwill only send the fields that were modified. Defaults to true. Note that any fields that have\nExt.data.Field.persist set to false will still be ignored.
\n", + "linenr": 22, + "html_filename": "Writer.html" + } + ], + "method": [ + { + "deprecated": null, + "alias": null, + "href": "Writer.html#Ext-data-writer-Writer-method-constructor", + "tagname": "method", + "protected": false, + "shortDoc": "Creates new Writer. ...", + "static": false, + "params": [ + { + "type": "Object", + "optional": true, + "doc": "(optional) Config object.
\n", + "name": "config" + } + ], + "private": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/writer/Writer.js", + "doc": "Creates new Writer.
\n", + "owner": "Ext.data.writer.Writer", + "name": "Writer", + "html_filename": "Writer.html", + "return": { "type": "Object", - "name": "config", - "doc": "Optional config object
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + "doc": "\n" + }, + "linenr": 62 }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/writer/Writer.js", - "linenr": 1, - "html_filename": "Writer.html", - "href": "Writer.html#Ext-data-writer-Writer-method-constructor", - "shortDoc": "\n" - }, - { - "tagname": "method", - "name": "getRecordData", - "member": "Ext.data.writer.Writer", - "doc": "Formats the data for each record before sending it to the server. This\nmethod should be overridden to format the data in a way that differs from the default.
\n", - "params": [ - { + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Writer.html#Ext-data-writer-Writer-method-getRecordData", + "shortDoc": "Formats the data for each record before sending it to the server. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/writer/Writer.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "The record that we are writing to the server.
\n", + "name": "record" + } + ], + "name": "getRecordData", + "owner": "Ext.data.writer.Writer", + "doc": "Formats the data for each record before sending it to the server. This\nmethod should be overridden to format the data in a way that differs from the default.
\n", + "linenr": 88, + "return": { "type": "Object", - "name": "record", - "doc": "The record that we are writing to the server.
\n", - "optional": false - } - ], - "return": { - "type": "Object", - "doc": "An object literal of name/value keys to be written to the server.\nBy default this method returns the data property on the record.
\n" + "doc": "An object literal of name/value keys to be written to the server.\nBy default this method returns the data property on the record.
\n" + }, + "html_filename": "Writer.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/writer/Writer.js", - "linenr": 87, - "html_filename": "Writer.html", - "href": "Writer.html#Ext-data-writer-Writer-method-getRecordData", - "shortDoc": "Formats the data for each record before sending it to the server. This\nmethod should be overridden to format the data..." - }, - { - "tagname": "method", - "name": "write", - "member": "Ext.data.writer.Writer", - "doc": "Prepares a Proxy's Ext.data.Request object
\n", - "params": [ - { + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Writer.html#Ext-data-writer-Writer-method-write", + "shortDoc": "Prepares a Proxy's Ext.data.Request object ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/writer/Writer.js", + "private": false, + "params": [ + { + "type": "Ext.data.Request", + "optional": false, + "doc": "The request object
\n", + "name": "request" + } + ], + "name": "write", + "owner": "Ext.data.writer.Writer", + "doc": "Prepares a Proxy's Ext.data.Request object
\n", + "linenr": 70, + "return": { "type": "Ext.data.Request", - "name": "request", - "doc": "The request object
\n", - "optional": false - } - ], - "return": { - "type": "Ext.data.Request", - "doc": "The modified request object
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/writer/Writer.js", - "linenr": 69, - "html_filename": "Writer.html", - "href": "Writer.html#Ext-data-writer-Writer-method-write", - "shortDoc": "Prepares a Proxy's Ext.data.Request object
\n" - } - ], - "property": [ + "doc": "The modified request object
\n" + }, + "html_filename": "Writer.html" + } + ], + "property": [ - ], - "event": [ + ], + "cssVar": [ - ], - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/writer/Writer.js", - "linenr": 1, - "html_filename": "Writer.html", - "href": "Writer.html#Ext-data-writer-Writer", - "cssVar": [ + ], + "cssMixin": [ - ], - "cssMixin": [ + ], + "event": [ - ], - "component": false, + ] + }, + "singleton": false, + "alias": null, "superclasses": [ ], + "protected": false, + "tagname": "class", + "mixins": [ + + ], + "href": "Writer.html#Ext-data-writer-Writer", "subclasses": [ - "Ext.data.writer.Json", - "Ext.data.writer.Xml" + "Ext.data.writer.Xml", + "Ext.data.writer.Json" ], + "static": false, + "author": "Ed Spencer", + "component": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/writer/Writer.js", + "private": false, + "alternateClassNames": [ + "Ext.data.DataWriter", + "Ext.data.Writer" + ], + "name": "Ext.data.writer.Writer", + "doc": "Base Writer class used by most subclasses of Ext.data.proxy.Server. This class is\nresponsible for taking a set of Ext.data.Operation objects and a Ext.data.Request\nobject and modifying that request based on the Operations.
\n\n\n\n\nFor example a Ext.data.writer.Json would format the Operations and their Ext.data.Model \ninstances based on the config options passed to the JsonWriter's constructor.
\n\n\n\n\nWriters are not needed for any kind of local storage - whether via a\nWeb Storage proxy (see localStorage\nand sessionStorage) or just in memory via a\nMemoryProxy.
\n\n", "mixedInto": [ ], - "allMixins": [ + "linenr": 1, + "xtypes": [ - ] + ], + "html_filename": "Writer.html", + "extends": "Object" }); \ No newline at end of file