--- /dev/null
+<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.HttpProxy"></div>/**\r
+ * @class Ext.data.HttpProxy\r
+ * @extends Ext.data.DataProxy\r
+ * <p>An implementation of {@link Ext.data.DataProxy} that processes data requests within the same\r
+ * domain of the originating page.</p>\r
+ * <p><b>Note</b>: this class cannot be used to retrieve data from a domain other\r
+ * than the domain from which the running page was served. For cross-domain requests, use a\r
+ * {@link Ext.data.ScriptTagProxy ScriptTagProxy}.</p>\r
+ * <p>Be aware that to enable the browser to parse an XML document, the server must set\r
+ * the Content-Type header in the HTTP response to "<tt>text/xml</tt>".</p>\r
+ * @constructor\r
+ * @param {Object} conn\r
+ * An {@link Ext.data.Connection} object, or options parameter to {@link Ext.Ajax#request}.\r
+ * <p>Note that if this HttpProxy is being used by a (@link Ext.data.Store Store}, then the\r
+ * Store's call to {@link #load} will override any specified <tt>callback</tt> and <tt>params</tt>\r
+ * options. In this case, use the Store's {@link Ext.data.Store#events events} to modify parameters,\r
+ * or react to loading events. The Store's {@link Ext.data.Store#baseParams baseParams} may also be\r
+ * used to pass parameters known at instantiation time.</p>\r
+ * <p>If an options parameter is passed, the singleton {@link Ext.Ajax} object will be used to make\r
+ * the request.</p>\r
+ */\r
+Ext.data.HttpProxy = function(conn){\r
+ Ext.data.HttpProxy.superclass.constructor.call(this, conn);\r
+\r
+ <div id="prop-Ext.data.HttpProxy-conn"></div>/**\r
+ * The Connection object (Or options parameter to {@link Ext.Ajax#request}) which this HttpProxy\r
+ * uses to make requests to the server. Properties of this object may be changed dynamically to\r
+ * change the way data is requested.\r
+ * @property\r
+ */\r
+ this.conn = conn;\r
+\r
+ // nullify the connection url. The url param has been copied to 'this' above. The connection\r
+ // url will be set during each execution of doRequest when buildUrl is called. This makes it easier for users to override the\r
+ // connection url during beforeaction events (ie: beforeload, beforesave, etc). The connection url will be nullified\r
+ // after each request as well. Url is always re-defined during doRequest.\r
+ this.conn.url = null;\r
+\r
+ this.useAjax = !conn || !conn.events;\r
+\r
+ //private. A hash containing active requests, keyed on action [Ext.data.Api.actions.create|read|update|destroy]\r
+ var actions = Ext.data.Api.actions;\r
+ this.activeRequest = {};\r
+ for (var verb in actions) {\r
+ this.activeRequest[actions[verb]] = undefined;\r
+ }\r
+};\r
+\r
+Ext.extend(Ext.data.HttpProxy, Ext.data.DataProxy, {\r
+ <div id="cfg-Ext.data.HttpProxy-restful"></div>/**\r
+ * @cfg {Boolean} restful\r
+ * <p>If set to <tt>true</tt>, a {@link Ext.data.Record#phantom non-phantom} record's\r
+ * {@link Ext.data.Record#id id} will be appended to the url (defaults to <tt>false</tt>).</p><br>\r
+ * <p>The url is built based upon the action being executed <tt>[load|create|save|destroy]</tt>\r
+ * using the commensurate <tt>{@link #api}</tt> property, or if undefined default to the\r
+ * configured {@link Ext.data.Store}.{@link Ext.data.Store#url url}.</p><br>\r
+ * <p>Some MVC (e.g., Ruby on Rails, Merb and Django) support this style of segment based urls\r
+ * where the segments in the URL follow the Model-View-Controller approach.</p><pre><code>\r
+ * someSite.com/controller/action/id\r
+ * </code></pre>\r
+ * Where the segments in the url are typically:<div class="mdetail-params"><ul>\r
+ * <li>The first segment : represents the controller class that should be invoked.</li>\r
+ * <li>The second segment : represents the class function, or method, that should be called.</li>\r
+ * <li>The third segment : represents the ID (a variable typically passed to the method).</li>\r
+ * </ul></div></p>\r
+ * <p>For example:</p>\r
+ * <pre><code>\r
+api: {\r
+ load : '/controller/load',\r
+ create : '/controller/new', // Server MUST return idProperty of new record\r
+ save : '/controller/update',\r
+ destroy : '/controller/destroy_action'\r
+}\r
+\r
+// Alternatively, one can use the object-form to specify each API-action\r
+api: {\r
+ load: {url: 'read.php', method: 'GET'},\r
+ create: 'create.php',\r
+ destroy: 'destroy.php',\r
+ save: 'update.php'\r
+}\r
+ */\r
+\r
+ <div id="method-Ext.data.HttpProxy-getConnection"></div>/**\r
+ * Return the {@link Ext.data.Connection} object being used by this Proxy.\r
+ * @return {Connection} The Connection object. This object may be used to subscribe to events on\r
+ * a finer-grained basis than the DataProxy events.\r
+ */\r
+ getConnection : function() {\r
+ return this.useAjax ? Ext.Ajax : this.conn;\r
+ },\r
+\r
+ <div id="method-Ext.data.HttpProxy-setUrl"></div>/**\r
+ * Used for overriding the url used for a single request. Designed to be called during a beforeaction event. Calling setUrl\r
+ * will override any urls set via the api configuration parameter. Set the optional parameter makePermanent to set the url for\r
+ * all subsequent requests. If not set to makePermanent, the next request will use the same url or api configuration defined\r
+ * in the initial proxy configuration.\r
+ * @param {String} url\r
+ * @param {Boolean} makePermanent (Optional) [false]\r
+ *\r
+ * (e.g.: beforeload, beforesave, etc).\r
+ */\r
+ setUrl : function(url, makePermanent) {\r
+ this.conn.url = url;\r
+ if (makePermanent === true) {\r
+ this.url = url;\r
+ Ext.data.Api.prepare(this);\r
+ }\r
+ },\r
+\r
+ <div id="method-Ext.data.HttpProxy-doRequest"></div>/**\r
+ * HttpProxy implementation of DataProxy#doRequest\r
+ * @param {String} action The crud action type (create, read, update, destroy)\r
+ * @param {Ext.data.Record/Ext.data.Record[]} rs If action is load, rs will be null\r
+ * @param {Object} params An object containing properties which are to be used as HTTP parameters\r
+ * for the request to the remote server.\r
+ * @param {Ext.data.DataReader} reader The Reader object which converts the data\r
+ * object into a block of Ext.data.Records.\r
+ * @param {Function} callback\r
+ * <div class="sub-desc"><p>A function to be called after the request.\r
+ * The <tt>callback</tt> is passed the following arguments:<ul>\r
+ * <li><tt>r</tt> : Ext.data.Record[] The block of Ext.data.Records.</li>\r
+ * <li><tt>options</tt>: Options object from the action request</li>\r
+ * <li><tt>success</tt>: Boolean success indicator</li></ul></p></div>\r
+ * @param {Object} scope The scope in which to call the callback\r
+ * @param {Object} arg An optional argument which is passed to the callback as its second parameter.\r
+ */\r
+ doRequest : function(action, rs, params, reader, cb, scope, arg) {\r
+ var o = {\r
+ method: (this.api[action]) ? this.api[action]['method'] : undefined,\r
+ request: {\r
+ callback : cb,\r
+ scope : scope,\r
+ arg : arg\r
+ },\r
+ reader: reader,\r
+ callback : this.createCallback(action, rs),\r
+ scope: this\r
+ };\r
+ // Sample the request data: If it's an object, then it hasn't been json-encoded yet.\r
+ // Transmit data using jsonData config of Ext.Ajax.request\r
+ if (typeof(params[reader.meta.root]) === 'object') {\r
+ o.jsonData = params;\r
+ } else {\r
+ o.params = params || {};\r
+ }\r
+ // Set the connection url. If this.conn.url is not null here,\r
+ // the user may have overridden the url during a beforeaction event-handler.\r
+ // this.conn.url is nullified after each request.\r
+ if (this.conn.url === null) {\r
+ this.conn.url = this.buildUrl(action, rs);\r
+ }\r
+ else if (this.restful === true && rs instanceof Ext.data.Record && !rs.phantom) {\r
+ this.conn.url += '/' + rs.id;\r
+ }\r
+ if(this.useAjax){\r
+\r
+ Ext.applyIf(o, this.conn);\r
+\r
+ // If a currently running request is found for this action, abort it.\r
+ if (this.activeRequest[action]) {\r
+ // Disabled aborting activeRequest while implementing REST. activeRequest[action] will have to become an array\r
+ //Ext.Ajax.abort(this.activeRequest[action]);\r
+ }\r
+ this.activeRequest[action] = Ext.Ajax.request(o);\r
+ }else{\r
+ this.conn.request(o);\r
+ }\r
+ // request is sent, nullify the connection url in preparation for the next request\r
+ this.conn.url = null;\r
+ },\r
+\r
+ /**\r
+ * Returns a callback function for a request. Note a special case is made for the\r
+ * read action vs all the others.\r
+ * @param {String} action [create|update|delete|load]\r
+ * @param {Ext.data.Record[]} rs The Store-recordset being acted upon\r
+ * @private\r
+ */\r
+ createCallback : function(action, rs) {\r
+ return function(o, success, response) {\r
+ this.activeRequest[action] = undefined;\r
+ if (!success) {\r
+ if (action === Ext.data.Api.actions.read) {\r
+ // @deprecated: fire loadexception for backwards compat.\r
+ this.fireEvent('loadexception', this, o, response);\r
+ }\r
+ this.fireEvent('exception', this, 'response', action, o, response);\r
+ o.request.callback.call(o.request.scope, null, o.request.arg, false);\r
+ return;\r
+ }\r
+ if (action === Ext.data.Api.actions.read) {\r
+ this.onRead(action, o, response);\r
+ } else {\r
+ this.onWrite(action, o, response, rs);\r
+ }\r
+ }\r
+ },\r
+\r
+ /**\r
+ * Callback for read action\r
+ * @param {String} action Action name as per {@link Ext.data.Api.actions#read}.\r
+ * @param {Object} o The request transaction object\r
+ * @param {Object} res The server response\r
+ * @private\r
+ */\r
+ onRead : function(action, o, response) {\r
+ var result;\r
+ try {\r
+ result = o.reader.read(response);\r
+ }catch(e){\r
+ // @deprecated: fire old loadexception for backwards-compat.\r
+ this.fireEvent('loadexception', this, o, response, e);\r
+ this.fireEvent('exception', this, 'response', action, o, response, e);\r
+ o.request.callback.call(o.request.scope, null, o.request.arg, false);\r
+ return;\r
+ }\r
+ if (result.success === false) {\r
+ // @deprecated: fire old loadexception for backwards-compat.\r
+ this.fireEvent('loadexception', this, o, response);\r
+\r
+ // Get DataReader read-back a response-object to pass along to exception event\r
+ var res = o.reader.readResponse(action, response);\r
+ this.fireEvent('exception', this, 'remote', action, o, res, null);\r
+ }\r
+ else {\r
+ this.fireEvent('load', this, o, o.request.arg);\r
+ }\r
+ o.request.callback.call(o.request.scope, result, o.request.arg, result.success);\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, o, response, rs) {\r
+ var reader = o.reader;\r
+ var res;\r
+ try {\r
+ res = reader.readResponse(action, response);\r
+ } catch (e) {\r
+ this.fireEvent('exception', this, 'response', action, o, response, e);\r
+ o.request.callback.call(o.request.scope, null, o.request.arg, false);\r
+ return;\r
+ }\r
+ if (res[reader.meta.successProperty] === false) {\r
+ this.fireEvent('exception', this, 'remote', action, o, res, rs);\r
+ } else {\r
+ this.fireEvent('write', this, action, res[reader.meta.root], res, rs, o.request.arg);\r
+ }\r
+ o.request.callback.call(o.request.scope, res[reader.meta.root], res, res[reader.meta.successProperty]);\r
+ },\r
+\r
+ // inherit docs\r
+ destroy: function(){\r
+ if(!this.useAjax){\r
+ this.conn.abort();\r
+ }else if(this.activeRequest){\r
+ var actions = Ext.data.Api.actions;\r
+ for (var verb in actions) {\r
+ if(this.activeRequest[actions[verb]]){\r
+ Ext.Ajax.abort(this.activeRequest[actions[verb]]);\r
+ }\r
+ }\r
+ }\r
+ Ext.data.HttpProxy.superclass.destroy.call(this);\r
+ }\r
+});</pre> \r
+</body>\r
+</html>
\ No newline at end of file
git.ithinksw.org / extjs.git / blobdiff