Upgrade to ExtJS 3.0.0 - Released 07/06/2009
[extjs.git] / docs / source / DirectProxy.html
diff --git a/docs/source/DirectProxy.html b/docs/source/DirectProxy.html
new file mode 100644 (file)
index 0000000..4e5b4cd
--- /dev/null
@@ -0,0 +1,147 @@
+<html>\r
+<head>\r
+  <title>The source code</title>\r
+    <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />\r
+    <script type="text/javascript" src="../resources/prettify/prettify.js"></script>\r
+</head>\r
+<body  onload="prettyPrint();">\r
+    <pre class="prettyprint lang-js"><div id="cls-Ext.data.DirectProxy"></div>/**\r
+ * @class Ext.data.DirectProxy\r
+ * @extends Ext.data.DataProxy\r
+ */\r
+Ext.data.DirectProxy = function(config){\r
+    Ext.apply(this, config);\r
+    if(typeof this.paramOrder == 'string'){\r
+        this.paramOrder = this.paramOrder.split(/[\s,|]/);\r
+    }\r
+    Ext.data.DirectProxy.superclass.constructor.call(this, config);\r
+};\r
+\r
+Ext.extend(Ext.data.DirectProxy, Ext.data.DataProxy, {\r
+    <div id="cfg-Ext.data.DirectProxy-paramOrder"></div>/**\r
+     * @cfg {Array/String} paramOrder Defaults to <tt>undefined</tt>. A list of params to be executed\r
+     * server side.  Specify the params in the order in which they must be executed on the server-side\r
+     * as either (1) an Array of String values, or (2) a String of params delimited by either whitespace,\r
+     * comma, or pipe. For example,\r
+     * any of the following would be acceptable:<pre><code>\r
+paramOrder: ['param1','param2','param3']\r
+paramOrder: 'param1 param2 param3'\r
+paramOrder: 'param1,param2,param3'\r
+paramOrder: 'param1|param2|param'\r
+     </code></pre>\r
+     */\r
+    paramOrder: undefined,\r
+\r
+    <div id="cfg-Ext.data.DirectProxy-paramsAsHash"></div>/**\r
+     * @cfg {Boolean} paramsAsHash\r
+     * Send parameters as a collection of named arguments (defaults to <tt>true</tt>). Providing a\r
+     * <tt>{@link #paramOrder}</tt> nullifies this configuration.\r
+     */\r
+    paramsAsHash: true,\r
+\r
+    <div id="cfg-Ext.data.DirectProxy-directFn"></div>/**\r
+     * @cfg {Function} directFn\r
+     * Function to call when executing a request.  directFn is a simple alternative to defining the api configuration-parameter\r
+     * for Store's which will not implement a full CRUD api.\r
+     */\r
+    directFn : undefined,\r
+\r
+    // protected\r
+    doRequest : function(action, rs, params, reader, callback, scope, options) {\r
+        var args = [];\r
+        var directFn = this.api[action] || this.directFn;\r
+\r
+        switch (action) {\r
+            case Ext.data.Api.actions.create:\r
+                args.push(params[reader.meta.root]);           // <-- create(Hash)\r
+                break;\r
+            case Ext.data.Api.actions.read:\r
+                if(this.paramOrder){\r
+                    for(var i = 0, len = this.paramOrder.length; i < len; i++){\r
+                        args.push(params[this.paramOrder[i]]);\r
+                    }\r
+                }else if(this.paramsAsHash){\r
+                    args.push(params);\r
+                }\r
+                break;\r
+            case Ext.data.Api.actions.update:\r
+                args.push(params[reader.meta.idProperty]);  // <-- save(Integer/Integer[], Hash/Hash[])\r
+                args.push(params[reader.meta.root]);\r
+                break;\r
+            case Ext.data.Api.actions.destroy:\r
+                args.push(params[reader.meta.root]);        // <-- destroy(Int/Int[])\r
+                break;\r
+        }\r
+\r
+        var trans = {\r
+            params : params || {},\r
+            request: {\r
+                callback : callback,\r
+                scope : scope,\r
+                arg : options\r
+            },\r
+            reader: reader\r
+        };\r
+\r
+        args.push(this.createCallback(action, rs, trans), this);\r
+        directFn.apply(window, args);\r
+    },\r
+\r
+    // private\r
+    createCallback : function(action, rs, trans) {\r
+        return function(result, res) {\r
+            if (!res.status) {\r
+                // @deprecated fire loadexception\r
+                if (action === Ext.data.Api.actions.read) {\r
+                    this.fireEvent("loadexception", this, trans, res, null);\r
+                }\r
+                this.fireEvent('exception', this, 'remote', action, trans, res, null);\r
+                trans.request.callback.call(trans.request.scope, null, trans.request.arg, false);\r
+                return;\r
+            }\r
+            if (action === Ext.data.Api.actions.read) {\r
+                this.onRead(action, trans, result, res);\r
+            } else {\r
+                this.onWrite(action, trans, result, res, rs);\r
+            }\r
+        };\r
+    },\r
+    /**\r
+     * Callback for read actions\r
+     * @param {String} action [Ext.data.Api.actions.create|read|update|destroy]\r
+     * @param {Object} trans The request transaction object\r
+     * @param {Object} res The server response\r
+     * @private\r
+     */\r
+    onRead : function(action, trans, result, res) {\r
+        var records;\r
+        try {\r
+            records = trans.reader.readRecords(result);\r
+        }\r
+        catch (ex) {\r
+            // @deprecated: Fire old loadexception for backwards-compat.\r
+            this.fireEvent("loadexception", this, trans, res, ex);\r
+\r
+            this.fireEvent('exception', this, 'response', action, trans, res, ex);\r
+            trans.request.callback.call(trans.request.scope, null, trans.request.arg, false);\r
+            return;\r
+        }\r
+        this.fireEvent("load", this, res, trans.request.arg);\r
+        trans.request.callback.call(trans.request.scope, records, trans.request.arg, true);\r
+    },\r
+    /**\r
+     * Callback for write actions\r
+     * @param {String} action [Ext.data.Api.actions.create|read|update|destroy]\r
+     * @param {Object} trans The request transaction object\r
+     * @param {Object} res The server response\r
+     * @private\r
+     */\r
+    onWrite : function(action, trans, result, res, rs) {\r
+        this.fireEvent("write", this, action, result, res, rs, trans.request.arg);\r
+        trans.request.callback.call(trans.request.scope, result, res, true);\r
+    }\r
+});\r
+\r
+</pre>    \r
+</body>\r
+</html>
\ No newline at end of file