Backported wiki changes from http://docs.jquery.com/API/1.1.1/Ajax
[jquery.git] / src / ajax / ajax.js
index 3450843..e97fa07 100644 (file)
@@ -55,7 +55,7 @@ jQuery.fn.extend({
                // If the second parameter was provided
                if ( params )
                        // If it's a function
-                       if ( jQuery.isFunction( params.constructor ) ) {
+                       if ( jQuery.isFunction( params ) ) {
                                // We assume that it's the callback
                                callback = params;
                                params = null;
@@ -94,13 +94,14 @@ jQuery.fn.extend({
         * This will serialize all given elements.
         *
         * A serialization similar to the form submit of a browser is
-        * provided by the form plugin. It also takes multiple-selects 
+        * provided by the [http://www.malsup.com/jquery/form/ Form Plugin].
+        * It also takes multiple-selects 
         * into account, while this method recognizes only a single option.
         *
         * @example $("input[@type=text]").serialize();
         * @before <input type='text' name='name' value='John'/>
         * <input type='text' name='location' value='Boston'/>
-        * @after name=John&location=Boston
+        * @after name=John&amp;location=Boston
         * @desc Serialize a selection of input elements to a string
         *
         * @name serialize
@@ -132,7 +133,7 @@ jQuery.fn.extend({
 });
 
 // If IE is used, create a wrapper for the XMLHttpRequest object
-if ( jQuery.browser.msie && typeof XMLHttpRequest == "undefined" )
+if ( !window.XMLHttpRequest )
        XMLHttpRequest = function(){
                return new ActiveXObject("Microsoft.XMLHTTP");
        };
@@ -249,6 +250,13 @@ jQuery.extend({
        /**
         * Load a remote page using an HTTP GET request.
         *
+        * This is an easy way to send a simple GET request to a server
+        * without having to use the more complex $.ajax function. It
+        * allows a single callback function to be specified that will
+        * be executed when the request is complete (and only if the response
+        * has a successful response code). If you need to have both error
+        * and success callbacks, you may want to use $.ajax.
+        *
         * @example $.get("test.cgi");
         *
         * @example $.get("test.cgi", { name: "John", time: "2pm" } );
@@ -268,7 +276,7 @@ jQuery.extend({
         * @type XMLHttpRequest
         * @param String url The URL of the page to load.
         * @param Map params (optional) Key/value pairs that will be sent to the server.
-        * @param Function callback (optional) A function to be executed whenever the data is loaded.
+        * @param Function callback (optional) A function to be executed whenever the data is loaded successfully.
         * @cat Ajax
         */
        get: function( url, data, callback, type, ifModified ) {
@@ -310,7 +318,7 @@ jQuery.extend({
         * @type XMLHttpRequest
         * @param String url The URL of the page to load.
         * @param Map params (optional) Key/value pairs that will be sent to the server.
-        * @param Function callback (optional) A function to be executed whenever the data is loaded.
+        * @param Function callback (optional) A function to be executed whenever the data is loaded successfully.
         * @cat Ajax
         */
        getIfModified: function( url, data, callback, type ) {
@@ -320,7 +328,7 @@ jQuery.extend({
        /**
         * Loads, and executes, a remote JavaScript file using an HTTP GET request.
         *
-        * Warning: Safari <= 2.0.x is unable to evalulate scripts in a global
+        * Warning: Safari <= 2.0.x is unable to evaluate scripts in a global
         * context synchronously. If you load functions via getScript, make sure
         * to call them after a delay.
         *
@@ -333,7 +341,7 @@ jQuery.extend({
         * @name $.getScript
         * @type XMLHttpRequest
         * @param String url The URL of the page to load.
-        * @param Function callback (optional) A function to be executed whenever the data is loaded.
+        * @param Function callback (optional) A function to be executed whenever the data is loaded successfully.
         * @cat Ajax
         */
        getScript: function( url, callback ) {
@@ -358,7 +366,7 @@ jQuery.extend({
         * @type XMLHttpRequest
         * @param String url The URL of the page to load.
         * @param Map params (optional) Key/value pairs that will be sent to the server.
-        * @param Function callback A function to be executed whenever the data is loaded.
+        * @param Function callback A function to be executed whenever the data is loaded successfully.
         * @cat Ajax
         */
        getJSON: function( url, data, callback ) {
@@ -387,10 +395,15 @@ jQuery.extend({
         * @type XMLHttpRequest
         * @param String url The URL of the page to load.
         * @param Map params (optional) Key/value pairs that will be sent to the server.
-        * @param Function callback (optional) A function to be executed whenever the data is loaded.
+        * @param Function callback (optional) A function to be executed whenever the data is loaded successfully.
         * @cat Ajax
         */
        post: function( url, data, callback, type ) {
+               if ( jQuery.isFunction( data ) ) {
+                       callback = data;
+                       data = {};
+               }
+
                return jQuery.ajax({
                        type: "POST",
                        url: url,
@@ -457,7 +470,8 @@ jQuery.extend({
                timeout: 0,
                contentType: "application/x-www-form-urlencoded",
                processData: true,
-               async: true
+               async: true,
+               data: null
        },
        
        // Last-Modified header cache for next request
@@ -467,15 +481,17 @@ jQuery.extend({
         * Load a remote page using an HTTP request.
         *
         * This is jQuery's low-level AJAX implementation. See $.get, $.post etc. for
-        * higher-level abstractions.
+        * higher-level abstractions that are often easier to understand and use,
+        * but don't offer as much functionality (such as error callbacks).
         *
         * $.ajax() returns the XMLHttpRequest that it creates. In most cases you won't
         * need that object to manipulate directly, but it is available if you need to
         * abort the request manually.
         *
-        * Note: Make sure the server sends the right mimetype (eg. xml as
-        * "text/xml"). Sending the wrong mimetype will get you into serious
-        * trouble that jQuery can't solve.
+        * '''Note:''' If you specify the dataType option described below, make sure
+        * the server sends the correct MIME type in the response (eg. xml as "text/xml").
+        * Sending the wrong MIME type can lead to unexpected problems in your script.
+        * See [[Specifying the Data Type for AJAX Requests]] for more information.
         *
         * Supported datatypes are (see dataType option):
         *
@@ -564,8 +580,8 @@ jQuery.extend({
         *  async: false
         * }).responseText;
         * @desc Loads data synchronously. Blocks the browser while the requests is active.
-        * It is better to block user interaction with others means when synchronization is
-        * necessary, instead to block the complete browser.
+        * It is better to block user interaction by other means when synchronization is
+        * necessary.
         *
         * @example var xmlDocument = [create xml document];
         * $.ajax({
@@ -593,9 +609,12 @@ jQuery.extend({
                        if (s.processData && typeof s.data != "string")
                        s.data = jQuery.param(s.data);
                        // append data to url for get requests
-                       if( s.type.toLowerCase() == "get" )
+                       if( s.type.toLowerCase() == "get" ) {
                                // "?" + data or "&" + data (in case there are already params)
                                s.url += ((s.url.indexOf("?") > -1) ? "&" : "?") + s.data;
+                               // IE likes to send both get and post data, prevent this
+                               s.data = null;
+                       }
                }
 
                // Watch for a new set of requests
@@ -638,6 +657,13 @@ jQuery.extend({
                        // The transfer is complete and the data is available, or the request timed out
                        if ( xml && (xml.readyState == 4 || isTimeout == "timeout") ) {
                                requestDone = true;
+                               
+                               // clear poll interval
+                               if (ival) {
+                                       clearInterval(ival);
+                                       ival = null;
+                               }
+                               
                                var status;
                                try {
                                        status = jQuery.httpSuccess( xml ) && isTimeout != "timeout" ?
@@ -683,11 +709,13 @@ jQuery.extend({
                                        s.complete(xml, status);
 
                                // Stop memory leaks
-                               xml.onreadystatechange = function(){};
-                               xml = null;
+                               if(s.async)
+                                       xml = null;
                        }
                };
-               xml.onreadystatechange = onreadystatechange;
+               
+               // don't attach the handler to the request, just poll it instead
+               var ival = setInterval(onreadystatechange, 13); 
 
                // Timeout checker
                if ( s.timeout > 0 )
@@ -702,12 +730,9 @@ jQuery.extend({
                                }
                        }, s.timeout);
                        
-               // save non-leaking reference 
-               var xml2 = xml;
-
                // Send the data
                try {
-                       xml2.send(s.data);
+                       xml.send(s.data);
                } catch(e) {
                        jQuery.handleError(s, xml, null, e);
                }
@@ -717,7 +742,7 @@ jQuery.extend({
                        onreadystatechange();
                
                // return XMLHttpRequest to allow aborting the request etc.
-               return xml2;
+               return xml;
        },
 
        handleError: function( s, xml, status, e ) {
@@ -789,17 +814,19 @@ jQuery.extend({
                // of form elements
                if ( a.constructor == Array || a.jquery )
                        // Serialize the form elements
-                       for ( var i = 0; i < a.length; i++ )
-                               s.push( encodeURIComponent(a[i].name) + "=" + encodeURIComponent( a[i].value ) );
+                       jQuery.each( a, function(){
+                               s.push( encodeURIComponent(this.name) + "=" + encodeURIComponent( this.value ) );
+                       });
 
                // Otherwise, assume that it's an object of key/value pairs
                else
                        // Serialize the key/values
                        for ( var j in a )
                                // If the value is an array then the key names need to be repeated
-                               if ( a[j].constructor == Array )
-                                       for ( var k = 0; k < a[j].length; k++ )
-                                               s.push( encodeURIComponent(j) + "=" + encodeURIComponent( a[j][k] ) );
+                               if ( a[j] && a[j].constructor == Array )
+                                       jQuery.each( a[j], function(){
+                                               s.push( encodeURIComponent(j) + "=" + encodeURIComponent( this ) );
+                                       });
                                else
                                        s.push( encodeURIComponent(j) + "=" + encodeURIComponent( a[j] ) );