From: John Resig <jeresig@gmail.com>
Date: Mon, 19 Jun 2006 01:29:54 +0000 (+0000)
Subject: The AJAX plugin is now fully documented, along with some bug fixes and new features.
X-Git-Tag: 1.0a~16
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=70cab836b0d87ec1a94658411c398658780f5810;p=jquery.git

The AJAX plugin is now fully documented, along with some bug fixes and new features.
---

diff --git a/ajax/ajax.js b/ajax/ajax.js
index b0a993cab..db347432e 100644
--- a/ajax/ajax.js
+++ b/ajax/ajax.js
@@ -2,340 +2,211 @@
 // Docs Here:
 // http://jquery.com/docs/ajax/
 
-if ( typeof XMLHttpRequest == 'undefined' && typeof window.ActiveXObject == 'function') {
-	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 ) {
-	if ( !url ) {
-		ret = type.onComplete;
-		var onSuccess = type.onSuccess;
-		var onError = type.onError;
-		data = type.data;
-		url = type.url;
-		type = type.type;
-	}
-
-	var xml = new XMLHttpRequest();
-
-	if ( xml ) {
-		// 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');
-
-		/* Borrowed from Prototype:
-		 * 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() {
-			// Socket is openend
-			if ( xml.readyState == 1 ) {
-				// Increase counter
-				$.xmlActive++;
-
-				// Show loader if needed
-				if ( ($.xmlActive >= 1) && ($.xmlCreate) )
-					$.xmlCreate();
-			}
-
-			// Socket is closed and data is available
-			if ( xml.readyState == 4 ) {
-				// Decrease counter
-				$.xmlActive--;
-
-				// Hide loader if needed
-				if ( ($.xmlActive <= 0) && ($.xmlDestroy) ) {
-					$.xmlDestroy();
-					$.xmlActive = 0
-				}
-
-				if ( ( xml.status && ( xml.status >= 200 && xml.status < 300 ) || xml.status == 304 ) ||
-					!xml.status && location.protocol == 'file:' ) {
-					if ( onSuccess )
-						onSuccess( xml );
-				} else if ( onError ) {
-					onError( xml );
-				}
-
-				// Process result
-				if ( ret )
-					ret(xml);
-			}
-		};
-
-		xml.send(data)
-	}
-};
-
-$.httpData = function(r,type) {
-	return r.getResponseHeader("content-type").indexOf("xml") > 0 || type == "xml" ?
-		r.responseXML : r.responseText;
-};
-
-$.get = function( url, ret, type ) {
-	$.xml( "GET", url, null, function(r) {
-		if ( ret ) { ret( $.httpData(r,type) ); }
-	});
-};
-
-$.getXML = function( url, ret ) {
-	$.get( url, ret, "xml" );
-};
-
-$.post = function( url, data, ret, type ) {
-	$.xml( "POST", url, $.param(data), function(r) {
-		if ( ret ) { ret( $.httpData(r,type) ); }
-	});
-};
-
-$.postXML = function( url, data, ret ) {
-	$.post( url, data, ret, "xml" );
-};
-
-$.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 j in a ) {
-			s[s.length] = j + "=" + encodeURIComponent( a[j] );
-		}
-	}
-	return s.join("&");
-};
-
-$.fn.load = function(a,o,f) {
-	// Arrrrghhhhhhhh!!
+/**
+ * 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 ( a && a.constructor == Function ) {
-		return this.bind("load", a);
-	}
-
-	var t = "GET";
-	if ( o && o.constructor == Function ) {
-		f = o;
-		o = null;
-	}
-	if (typeof o !== 'undefined') {
-		o = $.param(o);
-		t = "POST";
+	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";
+		}
 	}
+	
 	var self = this;
-	$.xml(t,a,o,function(res){
-		// Assign it and execute all scripts
-		self.html(res.responseText).find("script").each(function(){
-			try { eval( this.text || this.textContent || this.innerHTML || ""); } catch(e){}
+	
+	// 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 || "");
 		});
 
-		// Callback function
-		if (f && f.constructor == Function)
-			f(res.responseText);
 	});
+	
 	return this;
 };
 
 /**
- * Initial frontend function to submit form variables. This function
- * is for registering coordinates, in the case of an image being used
- * as the submit element, and sets up an event to listen and wait for
- * a form submit click. It then calls any following chained functions
- * to actually gather the variables and submit them.
- *
- * Usage examples, when used with getForm().putForm():
- *
- * 1. Just eval the results returned from the backend.
- *    $('#form-id').form();
- *
- * 2. Render backend results directly to target ID (expects (x)HTML).
- *    $('#form-id').form('#target-id');
- *
- * 3. Submit to backend URL (form action) then call this function.
- *    $('#form-id').form(post_callback);
- *
- * 4. Load target ID with backend results then call a function.
- *    $('#form-id').form('#target-id', null, post_callback);
- *
- * 5. Call a browser function (for validation) and then (optionally)
- *    load server results to target ID.
- *    $('#form-id').form('#target-id', pre_callback);
- *
- * 6. Call validation function first then load server results to
- *    target ID and then also call a browser function.
- *    $('#form-id').form('#target-id', pre_callback, post_callback);
- *
- * @param target   arg for the target id element to render
- * @param pre_cb   callback function before submission
- * @param post_cb  callback after any results are returned
- * @return         "this" object
- * @see            getForm(), putForm()
- * @author         Mark Constable (markc@renta.net)
- * @author         G. vd Hoven, Mike Alsup, Sam Collett
- * @version        20060606
+ * Load a remote page using a GET request
  */
-$.fn.form = function(target, pre_cb, post_cb) {
-	$('input[@type="submit"],input[@type="image"]', this).click(function(ev){
-		this.form.clicked = this;
-		if (ev.offsetX != undefined) {
-			this.form.clicked_x = ev.offsetX;
-			this.form.clicked_y = ev.offsetY;
-		} else {
-			this.form.clicked_x = ev.pageX - this.offsetLeft;
-			this.form.clicked_y = ev.pageY - this.offsetTop;
-		}
+$.get = function( url, callback, type ) {
+	// Build and start the HTTP Request
+	$.ajax( "GET", url, null, function(r) {
+		if ( callback ) callback( $.httpData(r,type) );
 	});
-	this.submit(function(e){
-		e.preventDefault();
-		$(this).getForm().putForm(target, pre_cb, post_cb);
-		return this;
-  });
 };
 
 /**
- * This function gathers form element variables into an array that
- * is embedded into the current "this" variable as "this.vars". It
- * is normally used in conjunction with form() and putForm() but can
- * be used standalone as long as an image is not used for submission.
- *
- * Standalone usage examples:
- *
- * 1. Gather form vars and return array to LHS variable.
- *    var myform = $('#form-id').getForm();
- *
- * 2. Provide a serialized URL-ready string (after 1. above).
- *    var mystring = $.param(myform.vars);
- *
- * 3. Gather form vars and send to RHS plugin via "this.vars".
- *    $('#form-id').getForm().some_other_plugin();
- *
- * @return         "this" object
- * @see            form(), putForm()
- * @author         Mark Constable (markc@renta.net)
- * @author         G. vd Hoven, Mike Alsup, Sam Collett
- * @version        20060606
+ * Load a remote page using a POST request.
  */
-$.fn.getForm = function() {
-  var a = [];
-  var ok = {INPUT:true, TEXTAREA:true, OPTION:true};
-  $('*', this).each(function() {
-    if (this.disabled || this.type == 'reset' || (this.type == 'checkbox' && !this.checked) || (this.type == 'radio' && !this.checked))
-    	return;
+$.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) );
+	});
+};
+
+// 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"
+		);
+	};
 
-    if (this.type == 'submit' || this.type == 'image') {
-      if (this.form.clicked != this)
-      	return;
+// Counter for holding the number of active queries
+$.xmlActive = 0;
 
-      if (this.type == 'image') {
-        if (this.form.clicked_x) {
-					a.push({name: this.name+'_x', value: this.form.clicked_x});
-					a.push({name: this.name+'_y', value: this.form.clicked_y});
-					return;
-				}
-			}
-		}
+// 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);};
+	})();}
+})();
 
-		if (!ok[this.nodeName.toUpperCase()])
-			return;
+/**
+ * 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;
+	}
 
-		var par = this.parentNode;
-		var p = par.nodeName.toUpperCase();
-		if ((p == 'SELECT' || p == 'OPTGROUP') && !this.selected)
-			return;
+	// Create the request object
+	var xml = new XMLHttpRequest();
 
-		var n = this.name || par.name;
-		if (!n && p == 'OPTGROUP' && (par = par.parentNode))
-			n = par.name;
+	// 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' );
+		}
 
-		if (n == undefined)
-			return;
+		// Socket is closed and data is available
+		if ( xml.readyState == 4 ) {
+			// Decrease counter
+			$.xmlActive--;
 
-		a.push({name: n, value: this.value});
-	});
+			// Hide loader if needed
+			if ( $.xmlActive <= 0 && $.xmlDestroy ) {
+				$.event.trigger( 'ajaxComplete' );
+				$.xmlActive = 0
+			}
 
-	this.vars = a;
+			// 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' );
+			}
 
-	return this;
-}
+			// Process result
+			if ( ret ) ret(xml);
+		}
+	};
 
-/**
- * Final form submission plugin usually used in conjunction with
- * form() and getForm(). If a second argument is a valid function
- * then it will be called before the form vars are sent to the
- * backend. If this pre-submit function returns exactly "false"
- * then it will abort further processing otherwise the process
- * will continue according to the first and third arguments.
- *
- * If the first argument is a function, and it exists, then the form
- * values will be submitted and that callback function called. If
- * the first argument is a string value then the "load()" plugin
- * will be called which will populate the innerHTML of the indicated
- * element and a callback will be called if there is third argument.
- * If there are no arguments then the form values are submitted with
- * an additional variable (evaljs=1) which indicates to the backend
- * to to prepare the returned results for evaluation, ie; the result
- * needs to be valid javascript all on a single line.
- *
- * Usage example:
- *
- * $.fn.myvars = function() {
- *   this.vars = [];
- *   for (var i in this) {
- *     if (this[i] instanceof Function || this[i] == null) continue;
- *     this.vars.push({name: i, value: this[i].length});
- *   }
- *   return this;
- * }
- *
- * precb = function(vars) {
- *   return confirm('Submit these values?\n\n'+$.param(vars));
- * }
- *
- * $('*').myvars().putForm('#mytarget',precb,null,'myhandler.php');
- *
- * @param target   arg for the target id element to render
- * @param pre_cb   callback function before submission
- * @param post_cb  callback after any results are returned
- * @param url      form action override
- * @param mth      form method override
- * @return         "this" object
- * @see            form(), getForm(), load(), xml()
- * @author         Mark Constable (markc@renta.net)
- * @author         G. vd Hoven, Mike Alsup, Sam Collett
- * @version        20060606
- */
-$.fn.putForm = function(target, pre_cb, post_cb, url, mth) {
-	if (pre_cb && pre_cb.constructor == Function)
-		if (pre_cb(this.vars) === false)
-			return;
+	// Send the data
+	xml.send(data);
+};
 
-	var f = this.get(0);
-	var url = url || f.action || '';
-	var mth = mth || f.method || 'POST';
+// 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:';
+};
 
-	if (target && target.constructor == Function) {
-		$.xml(mth, url, $.param(this.vars), target);
-	} else if (target && target.constructor == String) {
-		$(target).load(url, this.vars, post_cb);
-	} else {
-		this.vars.push({name: 'evaljs', value: 1});
-		$.xml(mth, url, $.param(this.vars), function(r) { eval(r.responseText); });
-	}
+// 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;
+};
 
-	return this;
-}
+// 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("&");
+};