Upgrade to ExtJS 3.2.1 - Released 04/27/2010
[extjs.git] / docs / source / DirectProxy.html
1 <html>
2 <head>
3   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />    
4   <title>The source code</title>
5     <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
6     <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
7 </head>
8 <body  onload="prettyPrint();">
9     <pre class="prettyprint lang-js">/*!
10  * Ext JS Library 3.2.1
11  * Copyright(c) 2006-2010 Ext JS, Inc.
12  * licensing@extjs.com
13  * http://www.extjs.com/license
14  */
15 <div id="cls-Ext.data.DirectProxy"></div>/**
16  * @class Ext.data.DirectProxy
17  * @extends Ext.data.DataProxy
18  */
19 Ext.data.DirectProxy = function(config){
20     Ext.apply(this, config);
21     if(typeof this.paramOrder == 'string'){
22         this.paramOrder = this.paramOrder.split(/[\s,|]/);
23     }
24     Ext.data.DirectProxy.superclass.constructor.call(this, config);
25 };
26
27 Ext.extend(Ext.data.DirectProxy, Ext.data.DataProxy, {
28     <div id="cfg-Ext.data.DirectProxy-paramOrder"></div>/**
29      * @cfg {Array/String} paramOrder Defaults to <tt>undefined</tt>. A list of params to be executed
30      * server side.  Specify the params in the order in which they must be executed on the server-side
31      * as either (1) an Array of String values, or (2) a String of params delimited by either whitespace,
32      * comma, or pipe. For example,
33      * any of the following would be acceptable:<pre><code>
34 paramOrder: ['param1','param2','param3']
35 paramOrder: 'param1 param2 param3'
36 paramOrder: 'param1,param2,param3'
37 paramOrder: 'param1|param2|param'
38      </code></pre>
39      */
40     paramOrder: undefined,
41
42     <div id="cfg-Ext.data.DirectProxy-paramsAsHash"></div>/**
43      * @cfg {Boolean} paramsAsHash
44      * Send parameters as a collection of named arguments (defaults to <tt>true</tt>). Providing a
45      * <tt>{@link #paramOrder}</tt> nullifies this configuration.
46      */
47     paramsAsHash: true,
48
49     <div id="cfg-Ext.data.DirectProxy-directFn"></div>/**
50      * @cfg {Function} directFn
51      * Function to call when executing a request.  directFn is a simple alternative to defining the api configuration-parameter
52      * for Store's which will not implement a full CRUD api.
53      */
54     directFn : undefined,
55
56     <div id="method-Ext.data.DirectProxy-doRequest"></div>/**
57      * DirectProxy implementation of {@link Ext.data.DataProxy#doRequest}
58      * @param {String} action The crud action type (create, read, update, destroy)
59      * @param {Ext.data.Record/Ext.data.Record[]} rs If action is load, rs will be null
60      * @param {Object} params An object containing properties which are to be used as HTTP parameters
61      * for the request to the remote server.
62      * @param {Ext.data.DataReader} reader The Reader object which converts the data
63      * object into a block of Ext.data.Records.
64      * @param {Function} callback
65      * <div class="sub-desc"><p>A function to be called after the request.
66      * The <tt>callback</tt> is passed the following arguments:<ul>
67      * <li><tt>r</tt> : Ext.data.Record[] The block of Ext.data.Records.</li>
68      * <li><tt>options</tt>: Options object from the action request</li>
69      * <li><tt>success</tt>: Boolean success indicator</li></ul></p></div>
70      * @param {Object} scope The scope (<code>this</code> reference) in which the callback function is executed. Defaults to the browser window.
71      * @param {Object} arg An optional argument which is passed to the callback as its second parameter.
72      * @protected
73      */
74     doRequest : function(action, rs, params, reader, callback, scope, options) {
75         var args = [],
76             directFn = this.api[action] || this.directFn;
77
78         switch (action) {
79             case Ext.data.Api.actions.create:
80                 args.push(params.jsonData);             // <-- create(Hash)
81                 break;
82             case Ext.data.Api.actions.read:
83                 // If the method has no parameters, ignore the paramOrder/paramsAsHash.
84                 if(directFn.directCfg.method.len > 0){
85                     if(this.paramOrder){
86                         for(var i = 0, len = this.paramOrder.length; i < len; i++){
87                             args.push(params[this.paramOrder[i]]);
88                         }
89                     }else if(this.paramsAsHash){
90                         args.push(params);
91                     }
92                 }
93                 break;
94             case Ext.data.Api.actions.update:
95                 args.push(params.jsonData);        // <-- update(Hash/Hash[])
96                 break;
97             case Ext.data.Api.actions.destroy:
98                 args.push(params.jsonData);        // <-- destroy(Int/Int[])
99                 break;
100         }
101
102         var trans = {
103             params : params || {},
104             request: {
105                 callback : callback,
106                 scope : scope,
107                 arg : options
108             },
109             reader: reader
110         };
111
112         args.push(this.createCallback(action, rs, trans), this);
113         directFn.apply(window, args);
114     },
115
116     // private
117     createCallback : function(action, rs, trans) {
118         var me = this;
119         return function(result, res) {
120             if (!res.status) {
121                 // @deprecated fire loadexception
122                 if (action === Ext.data.Api.actions.read) {
123                     me.fireEvent("loadexception", me, trans, res, null);
124                 }
125                 me.fireEvent('exception', me, 'remote', action, trans, res, null);
126                 trans.request.callback.call(trans.request.scope, null, trans.request.arg, false);
127                 return;
128             }
129             if (action === Ext.data.Api.actions.read) {
130                 me.onRead(action, trans, result, res);
131             } else {
132                 me.onWrite(action, trans, result, res, rs);
133             }
134         };
135     },
136
137     <div id="method-Ext.data.DirectProxy-onRead"></div>/**
138      * Callback for read actions
139      * @param {String} action [Ext.data.Api.actions.create|read|update|destroy]
140      * @param {Object} trans The request transaction object
141      * @param {Object} result Data object picked out of the server-response.
142      * @param {Object} res The server response
143      * @protected
144      */
145     onRead : function(action, trans, result, res) {
146         var records;
147         try {
148             records = trans.reader.readRecords(result);
149         }
150         catch (ex) {
151             // @deprecated: Fire old loadexception for backwards-compat.
152             this.fireEvent("loadexception", this, trans, res, ex);
153
154             this.fireEvent('exception', this, 'response', action, trans, res, ex);
155             trans.request.callback.call(trans.request.scope, null, trans.request.arg, false);
156             return;
157         }
158         this.fireEvent("load", this, res, trans.request.arg);
159         trans.request.callback.call(trans.request.scope, records, trans.request.arg, true);
160     },
161     <div id="method-Ext.data.DirectProxy-onWrite"></div>/**
162      * Callback for write actions
163      * @param {String} action [{@link Ext.data.Api#actions create|read|update|destroy}]
164      * @param {Object} trans The request transaction object
165      * @param {Object} result Data object picked out of the server-response.
166      * @param {Object} res The server response
167      * @param {Ext.data.Record/[Ext.data.Record]} rs The Store resultset associated with the action.
168      * @protected
169      */
170     onWrite : function(action, trans, result, res, rs) {
171         var data = trans.reader.extractData(trans.reader.getRoot(result), false);
172         var success = trans.reader.getSuccess(result);
173         success = (success !== false);
174         if (success){
175             this.fireEvent("write", this, action, data, res, rs, trans.request.arg);
176         }else{
177             this.fireEvent('exception', this, 'remote', action, trans, result, rs);
178         }
179         trans.request.callback.call(trans.request.scope, data, res, success);
180     }
181 });
182 </pre>    
183 </body>
184 </html>