/*!
* Ext JS Library 3.3.0
* Copyright(c) 2006-2010 Ext JS, Inc.
* licensing@extjs.com
* http://www.extjs.com/license
*/
(function(){
var BEFOREREQUEST = "beforerequest",
REQUESTCOMPLETE = "requestcomplete",
REQUESTEXCEPTION = "requestexception",
UNDEFINED = undefined,
LOAD = 'load',
POST = 'POST',
GET = 'GET',
WINDOW = window;
/**
* @class Ext.data.Connection
* @extends Ext.util.Observable
* The class encapsulates a connection to the page's originating domain, allowing requests to be made
* either to a configured URL, or to a URL specified at request time.
* Requests made by this class are asynchronous, and will return immediately. No data from
* the server will be available to the statement immediately following the {@link #request} call.
* To process returned data, use a
* success callback
* in the request options object,
* or an {@link #requestcomplete event listener}.
* File Uploads
File uploads are not performed using normal "Ajax" techniques, that
* is they are not performed using XMLHttpRequests. Instead the form is submitted in the standard
* manner with the DOM <form> element temporarily modified to have its
* target set to refer
* to a dynamically generated, hidden <iframe> which is inserted into the document
* but removed after the return data has been gathered.
* The server response is parsed by the browser to create the document for the IFRAME. If the
* server is using JSON to send the return object, then the
* Content-Type header
* must be set to "text/html" in order to tell the browser to insert the text unchanged into the document body.
* Characters which are significant to an HTML parser must be sent as HTML entities, so encode
* "<" as "<", "&" as "&" etc.
* The response text is retrieved from the document, and a fake XMLHttpRequest object
* is created containing a responseText property in order to conform to the
* requirements of event handlers and callbacks.
* Be aware that file upload packets are sent with the content type multipart/form
* and some server technologies (notably JEE) may require some custom processing in order to
* retrieve parameter names and parameter values from the packet content.
* Also note that it's not possible to check the response code of the hidden iframe, so the success handler will ALWAYS fire.
* @constructor
* @param {Object} config a configuration object.
*/
Ext.data.Connection = function(config){
Ext.apply(this, config);
this.addEvents(
/**
* @event beforerequest
* Fires before a network request is made to retrieve a data object.
* @param {Connection} conn This Connection object.
* @param {Object} options The options config object passed to the {@link #request} method.
*/
BEFOREREQUEST,
/**
* @event requestcomplete
* Fires if the request was successfully completed.
* @param {Connection} conn This Connection object.
* @param {Object} response The XHR object containing the response data.
* See The XMLHttpRequest Object
* for details.
* @param {Object} options The options config object passed to the {@link #request} method.
*/
REQUESTCOMPLETE,
/**
* @event requestexception
* Fires if an error HTTP status was returned from the server.
* See HTTP Status Code Definitions
* for details of HTTP status codes.
* @param {Connection} conn This Connection object.
* @param {Object} response The XHR object containing the response data.
* See The XMLHttpRequest Object
* for details.
* @param {Object} options The options config object passed to the {@link #request} method.
*/
REQUESTEXCEPTION
);
Ext.data.Connection.superclass.constructor.call(this);
};
Ext.extend(Ext.data.Connection, Ext.util.Observable, {
/**
* @cfg {String} url (Optional) The default URL to be used for requests to the server. Defaults to undefined.
* The url config may be a function which returns the URL to use for the Ajax request. The scope
* (this reference) of the function is the scope option passed to the {@link #request} method.
*/
/**
* @cfg {Object} extraParams (Optional) An object containing properties which are used as
* extra parameters to each request made by this object. (defaults to undefined)
*/
/**
* @cfg {Object} defaultHeaders (Optional) An object containing request headers which are added
* to each request made by this object. (defaults to undefined)
*/
/**
* @cfg {String} method (Optional) The default HTTP method to be used for requests.
* (defaults to undefined; if not set, but {@link #request} params are present, POST will be used;
* otherwise, GET will be used.)
*/
/**
* @cfg {Number} timeout (Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)
*/
timeout : 30000,
/**
* @cfg {Boolean} autoAbort (Optional) Whether this request should abort any pending requests. (defaults to false)
* @type Boolean
*/
autoAbort:false,
/**
* @cfg {Boolean} disableCaching (Optional) True to add a unique cache-buster param to GET requests. (defaults to true)
* @type Boolean
*/
disableCaching: true,
/**
* @cfg {String} disableCachingParam (Optional) Change the parameter which is sent went disabling caching
* through a cache buster. Defaults to '_dc'
* @type String
*/
disableCachingParam: '_dc',
/**
* Sends an HTTP request to a remote server.
* Important: Ajax server requests are asynchronous, and this call will
* return before the response has been received. Process any returned data
* in a callback function.
*
Ext.Ajax.request({
url: 'ajax_demo/sample.json',
success: function(response, opts) {
var obj = Ext.decode(response.responseText);
console.dir(obj);
},
failure: function(response, opts) {
console.log('server-side failure with status code ' + response.status);
}
});
*
* To execute a callback function in the correct scope, use the scope option.
* @param {Object} options An object which may contain the following properties:True if the form object is a file upload (will be set automatically if the form was * configured with enctype "multipart/form-data").
*File uploads are not performed using normal "Ajax" techniques, that is they are not * performed using XMLHttpRequests. Instead the form is submitted in the standard manner with the * DOM <form> element temporarily modified to have its * target set to refer * to a dynamically generated, hidden <iframe> which is inserted into the document * but removed after the return data has been gathered.
*The server response is parsed by the browser to create the document for the IFRAME. If the * server is using JSON to send the return object, then the * Content-Type header * must be set to "text/html" in order to tell the browser to insert the text unchanged into the document body.
*The response text is retrieved from the document, and a fake XMLHttpRequest object * is created containing a responseText property in order to conform to the * requirements of event handlers and callbacks.
*Be aware that file upload packets are sent with the content type multipart/form * and some server technologies (notably JEE) may require some custom processing in order to * retrieve parameter names and parameter values from the packet content.
*The options object may also contain any other property which might be needed to perform * postprocessing in a callback because it is passed to callback functions.
* @return {Number} transactionId The id of the server transaction. This may be used * to cancel the request. */ request : function(o){ var me = this; if(me.fireEvent(BEFOREREQUEST, me, o)){ if (o.el) { if(!Ext.isEmpty(o.indicatorText)){ me.indicatorText = 'The global Ajax request class that provides a simple way to make Ajax requests * with maximum flexibility.
*Since Ext.Ajax is a singleton, you can set common properties/events for it once * and override them at the request function level only if necessary.
*Common Properties you may want to set are:
// Default headers to pass in every request
Ext.Ajax.defaultHeaders = {
'Powered-By': 'Ext'
};
* Common Events you may want to set are:
// Example: show a spinner during all Ajax requests
Ext.Ajax.on('beforerequest', this.showSpinner, this);
Ext.Ajax.on('requestcomplete', this.hideSpinner, this);
Ext.Ajax.on('requestexception', this.hideSpinner, this);
* An example request:
*
// Basic request
Ext.Ajax.{@link Ext.data.Connection#request request}({
url: 'foo.php',
success: someFn,
failure: otherFn,
headers: {
'my-header': 'foo'
},
params: { foo: 'bar' }
});
// Simple ajax form submission
Ext.Ajax.{@link Ext.data.Connection#request request}({
form: 'some-form',
params: 'foo=bar'
});
*