The AJAX plugin is now fully documented, along with some bug fixes and new features.
[jquery.git] / ajax / ajax.js
index d448ebb..db34743 100644 (file)
 // Docs Here:
 // http://jquery.com/docs/ajax/
 
-if ( typeof XMLHttpRequest == 'undefined' && typeof window.ActiveXObject == 'function') {
-       var XMLHttpRequest = function() {
-               return new ActiveXObject((navigator.userAgent.toLowerCase().indexOf('msie 5') >= 0) ?
-                       "Microsoft.XMLHTTP" : "Msxml2.XMLHTTP");
-       };
-}
-
-//
-// Counter for holding the active query's
-$.xmlActive=0;
-
-$.xml = function( type, url, data, ret ) {
-       var xml = new XMLHttpRequest();
-
-       if ( xml ) {
-               //
-               // Increase the query counter
-               $.xmlActive++;
-
-               //
-               // Show loader if needed
-               if ($.xmlCreate)
-                       $.xmlCreate();
-
-               //
-               // Open the socket
-               xml.open(type || "GET", url, true);
-
-               if ( data )
-                       xml.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded');
-
-               //
-               // Set header so calling script knows that it's an XMLHttpRequest
-               xml.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
-
-               /* Force "Connection: close" for Mozilla browsers to work around
-                * a bug where XMLHttpReqeuest sends an incorrect Content-length
-                * header. See Mozilla Bugzilla #246651.
-                */
-               if ( xml.overrideMimeType )
-                       xml.setRequestHeader('Connection', 'close');
-
-               xml.onreadystatechange = function() {
-                       if ( xml.readyState == 4 ) {
-                               if ( ret ) ret(xml);
-
-                               //
-                               // Decrease counter
-                               $.xmlActive--;
-
-                               //
-                               // Hide loader if needed
-                               if ($.xmlActive <= 0) {
-                                       if ($.xmlDestroy)
-                                               $.xmlDestroy();
-                               }
-                       }
-               };
-
-               xml.send(data)
+/**
+ * Load HTML from a remote file and inject it into the DOM
+ */
+$.fn.load = function( url, params, callback ) {
+       // I overwrote the event plugin's .load
+       // this won't happen again, I hope -John
+       if ( url && url.constructor == Function )
+               return this.bind("load", url);
+
+       // Default to a GET request
+       var type = "GET";
+
+       // If the second parameter was provided
+       if ( params ) {
+               // If it's a function
+               if ( params.constructor == Function ) {
+                       // We assume that it's the callback
+                       callback = params;
+                       params = null;
+                       
+               // Otherwise, build a param string
+               } else {
+                       params = $.param( params );
+                       type = "POST";
+               }
        }
-};
-
-$.httpData = function(r,type) {
-       return r.getResponseHeader("content-type").indexOf("xml") > 0 || type == "xml" ?
-               r.responseXML : r.responseText;
-};
+       
+       var self = this;
+       
+       // Request the remote document
+       $.ajax( type, url, params,function(res){
+                       
+               // Inject the HTML into all the matched elements
+               self.html(res.responseText).each(function(){
+                       // If a callback function was provided
+                       if ( callback && callback.constructor == Function )
+                               // Execute it within the context of the element
+                               $.apply( self, callback, [res.responseText] );
+               });
+               
+               // Execute all the scripts inside of the newly-injected HTML
+               $("script", self).each(function(){
+                       eval( this.text || this.textContent || this.innerHTML || "");
+               });
 
-$.get = function( url, ret, type ) {
-       $.xml( "GET", url, null, function(r) {
-               if ( ret ) ret( $.httpData(r,type) );
        });
+       
+       return this;
 };
 
-$.getXML = function( url, ret ) {
-       $.get( url, ret, "xml" );
+/**
+ * Load a remote page using a GET request
+ */
+$.get = function( url, callback, type ) {
+       // Build and start the HTTP Request
+       $.ajax( "GET", url, null, function(r) {
+               if ( callback ) callback( $.httpData(r,type) );
+       });
 };
 
-$.post = function( url, data, ret, type ) {
-       $.xml( "POST", url, $.param(data), function(r) {
-               if ( ret ) ret( $.httpData(r,type) );
+/**
+ * Load a remote page using a POST request.
+ */
+$.post = function( url, data, callback, type ) {
+       // Build and start the HTTP Request
+       $.ajax( "POST", url, $.param(data), function(r) {
+               if ( callback ) callback( $.httpData(r,type) );
        });
 };
 
-$.postXML = function( url, data, ret ) {
-       $.post( url, data, ret, "xml" );
-};
+// If IE is used, create a wrapper for the XMLHttpRequest object
+if ( $.browser == "msie" )
+       XMLHttpRequest = function(){
+               return new ActiveXObject(
+                       (navigator.userAgent.toLowerCase().indexOf('msie 5') >= 0) ?
+                       "Microsoft.XMLHTTP" : "Msxml2.XMLHTTP"
+               );
+       };
 
-// Dynamic Form Submission
-// Based upon the mailing list post at:
-// http://jquery.com/discuss/2006-March/000424/
-
-$.fn.serialize = function(callback) {
-       return this.each(function(){
-               var a = {};
-               $(this)
-                       .find("input:checked,hidden,text,option[@selected],textarea")
-                       .filter(":enabled").each(function() {
-                               a[ this.name || this.id || this.parentNode.name || this.parentNode.id ] = this.value;
-                       });
-               $.xml( this.method || "GET", this.action || "", $.param(a), callback );
-       });
-};
+// Counter for holding the number of active queries
+$.xmlActive = 0;
 
-$.param = function(a) {
-       var s = [];
-       if (a && typeof a == 'object' && a.constructor == Array) {
-               for ( var i=0; i < a.length; i++ )
-                       s[s.length] = a[i]['name'] + "=" + encodeURIComponent( a[i]['value'] );
-       } else {
-               for ( var i in a )
-                       s[s.length] = i + "=" + encodeURIComponent( a[i] );
+// Attach a bunch of functions for handling common AJAX events
+(function(){
+       var e = ['ajaxStart','ajaxComplete','ajaxError','ajaxSuccess'];
+       
+       for ( var i = 0; i < e.length; i++ ){ (function(){
+               var o = e[i];
+               $.fn[o] = function(f){return this.bind(o, f);};
+       })();}
+})();
+
+/**
+ * A common wrapper for making XMLHttpRequests
+ */
+$.ajax = function( type, url, data, ret ) {
+       // If only a single argument was passed in,
+       // assume that it is a object of key/value pairs
+       if ( !url ) {
+               ret = type.complete;
+               var success = type.success;
+               var error = type.error;
+               data = type.data;
+               url = type.url;
+               type = type.type;
        }
-       return s.join("&");
-};
 
-$.fn.load = function(a,o,f) {
-       // Arrrrghhhhhhhh!!
-       // I overwrote the event plugin's .load
-       // this won't happen again, I hope -John
-       if ( a && a.constructor == Function )
-               return this.bind("load", a);
+       // Create the request object
+       var xml = new XMLHttpRequest();
 
-       var t = "GET";
-       if ( o && o.constructor == Function ) {
-               f = o;
-               o = null;
-       }
-       if (o != null) {
-               o = $.param(o);
-               t = "POST";
-       }
-       var self = this;
-       $.xml(t,a,o,function(h){
-               var h = h.responseText;
-               self.html(h).find("script").each(function(){
-                       try {
-                               eval( this.text || this.textContent || this.innerHTML );
-                       } catch(e){}
-               });
-               if(f)f(h);
-       });
-       return this;
+       // Open the socket
+       xml.open(type || "GET", url, true);
+       
+       // Set the correct header, if data is being sent
+       if ( data )
+               xml.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded');
+
+       // Set header so calling script knows that it's an XMLHttpRequest
+       xml.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
+
+       // Make sure the browser sends the right content length
+       if ( xml.overrideMimeType )
+               xml.setRequestHeader('Connection', 'close');
+
+       // Wait for a response to come back
+       xml.onreadystatechange = function(){
+               // Socket is openend
+               if ( xml.readyState == 1 ) {
+                       // Increase counter
+                       $.xmlActive++;
+
+                       // Show loader if needed
+                       if ( $.xmlActive >= 1 && $.xmlCreate )
+                               $.event.trigger( 'ajaxStart' );
+               }
+
+               // Socket is closed and data is available
+               if ( xml.readyState == 4 ) {
+                       // Decrease counter
+                       $.xmlActive--;
+
+                       // Hide loader if needed
+                       if ( $.xmlActive <= 0 && $.xmlDestroy ) {
+                               $.event.trigger( 'ajaxComplete' );
+                               $.xmlActive = 0
+                       }
+
+                       // Make sure that the request was successful
+                       if ( $.httpSuccess( xml ) ) {
+                       
+                               // If a local callback was specified, fire it
+                               if ( success ) success( xml );
+                               
+                               // Fire the global callback
+                               $.event.trigger( 'ajaxSuccess' );
+                       
+                       // Otherwise, the request was not successful
+                       } else {
+                               // If a local callback was specified, fire it
+                               if ( error ) error( xml );
+                               
+                               // Fire the global callback
+                               $.event.trigger( 'ajaxError' );
+                       }
+
+                       // Process result
+                       if ( ret ) ret(xml);
+               }
+       };
+
+       // Send the data
+       xml.send(data);
 };
 
-/**
- * function:   $.fn.formValues
- * usage:              $('#frmLogin').formValues()
- * docs:                       Gets the form values and creates a key=>value array of the found values (only for ENABLED elements!)
- */
-$.fn.formValues = function() {
-       var a = new Array();
-       this.find("input[@type='submit'],input[@type='hidden'],textarea,input[@checked],input[@type='password'],input[@type='text'],option[@selected]")
-               .filter(":enabled").each(function() {
-                       o = {};
-                       o['name'] = this.name || this.id || this.parentNode.name || this.parentNode.id;
-                       o['value'] = this.value;
-                       a.push(o);
-               });
-       return a;
+// Determines if an XMLHttpRequest was successful or not
+$.httpSuccess = function(r) {
+       return ( r.status && ( r.status >= 200 && r.status < 300 ) || 
+               r.status == 304 ) || !r.status && location.protocol == 'file:';
 };
 
-/**
- * function:   $.update
- * usage:              $.update('someJQueryObject', 'someurl', 'array');
- * docs:                       Mimics the ajaxUpdater from prototype. Posts the key=>value array to the url and
- *                                     puts the results from that call in the jQuery object specified.
- *                                     --> If you set the blnNoEval to true, the script tags are NOT evaluated.
- */
-$.update = function(objElement, strURL, arrValues, fncCallback) {
-       $.post(strURL, arrValues, function(strHTML) {
-               //
-               // Update the element with the new HTML
-               objElement.html(strHTML);
-
-               //
-               // Evaluate the scripts
-               objElement.html(strHTML).find("script").each(function(){
-                       try { eval( this.text || this.textContent || this.innerHTML ); } catch(e){}
-               });
+// Get the data out of an XMLHttpRequest
+$.httpData = function(r,type) {
+       // Check the headers, or watch for a force override
+       return r.getResponseHeader("content-type").indexOf("xml") > 0 || 
+               type == "xml" ? r.responseXML : r.responseText;
+};
 
-               //
-               // Callback handler
-               if (fncCallback) fncCallback();
-       });
+// Serialize an array of form elements or a set of
+// key/values into a query string
+$.param = function(a) {
+       var s = [];
+       
+       // If an array was passed in, assume that it is an array
+       // of form elements
+       if ( a.constructor == Array )
+               // Serialize the form elements
+               for ( var i = 0; i < a.length; i++ )
+                       s.push( a[i].name + "=" + encodeURIComponent( a[i].value ) );
+               
+       // Otherwise, assume that it's an object of key/value pairs
+       else
+               // Serialize the key/values
+               for ( var j in a )
+                       s.push( j + "=" + encodeURIComponent( a[j] ) );
+       
+       // Return the resulting serialization
+       return s.join("&");
 };