Improved the categories of a bunch of docs, upped the version to 1.1.
[jquery.git] / src / ajax / ajax.js
index e9f9534..9a9e0eb 100644 (file)
@@ -11,9 +11,9 @@ jQuery.fn.extend({
         * @name loadIfModified
         * @type jQuery
         * @param String url The URL of the HTML file to load.
-        * @param Hash params (optional) A set of key/value pairs that will be sent to the server.
+        * @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 (parameters: responseText, status and response itself).
-        * @cat AJAX
+        * @cat Ajax
         */
        loadIfModified: function( url, params, callback ) {
                this.load( url, params, callback, 1 );
@@ -23,6 +23,7 @@ jQuery.fn.extend({
         * Load HTML from a remote file and inject it into the DOM.
         *
         * Note: Avoid to use this to load scripts, instead use $.getScript.
+        * IE strips script tags when there aren't any other characters in front of it.
         *
         * @example $("#feeds").load("feeds.html");
         * @before <div id="feeds"></div>
@@ -40,7 +41,7 @@ jQuery.fn.extend({
         * @param String url The URL of the HTML file to load.
         * @param Object params (optional) A set of key/value pairs that will be sent as data to the server.
         * @param Function callback (optional) A function to be executed whenever the data is loaded (parameters: responseText, status and response itself).
-        * @cat AJAX
+        * @cat Ajax
         */
        load: function( url, params, callback, ifModified ) {
                if ( url.constructor == Function )
@@ -52,7 +53,7 @@ jQuery.fn.extend({
                var type = "GET";
 
                // If the second parameter was provided
-               if ( params ) {
+               if ( params )
                        // If it's a function
                        if ( params.constructor == Function ) {
                                // We assume that it's the callback
@@ -64,7 +65,6 @@ jQuery.fn.extend({
                                params = jQuery.param( params );
                                type = "POST";
                        }
-               }
 
                var self = this;
 
@@ -75,14 +75,14 @@ jQuery.fn.extend({
                        data: params,
                        ifModified: ifModified,
                        complete: function(res, status){
-                               if ( status == "success" || !ifModified && status == "notmodified" ) {
+                               if ( status == "success" || !ifModified && status == "notmodified" )
                                        // Inject the HTML into all the matched elements
                                        self.html(res.responseText)
                                          // Execute all the scripts inside of the newly-injected HTML
                                          .evalScripts()
                                          // Execute callback
                                          .each( callback, [res.responseText, status, res] );
-                               } else
+                               else
                                        callback.apply( self, [res.responseText, status, res] );
                        }
                });
@@ -105,7 +105,7 @@ jQuery.fn.extend({
         *
         * @name serialize
         * @type String
-        * @cat AJAX
+        * @cat Ajax
         */
        serialize: function() {
                return jQuery.param( this );
@@ -118,15 +118,14 @@ jQuery.fn.extend({
         * @name evalScripts
         * @type jQuery
         * @private
-        * @cat AJAX
+        * @cat Ajax
         */
        evalScripts: function() {
                return this.find('script').each(function(){
                        if ( this.src )
                                jQuery.getScript( this.src );
-                       else {
+                       else
                                jQuery.globalEval( this.text || this.textContent || this.innerHTML || "" );
-                       }
                }).end();
        }
 
@@ -153,7 +152,7 @@ if ( jQuery.browser.msie && typeof XMLHttpRequest == "undefined" )
  * @name ajaxStart
  * @type jQuery
  * @param Function callback The function to execute.
- * @cat AJAX
+ * @cat Ajax
  */
 
 /**
@@ -167,7 +166,7 @@ if ( jQuery.browser.msie && typeof XMLHttpRequest == "undefined" )
  * @name ajaxStop
  * @type jQuery
  * @param Function callback The function to execute.
- * @cat AJAX
+ * @cat Ajax
  */
 
 /**
@@ -184,7 +183,7 @@ if ( jQuery.browser.msie && typeof XMLHttpRequest == "undefined" )
  * @name ajaxComplete
  * @type jQuery
  * @param Function callback The function to execute.
- * @cat AJAX
+ * @cat Ajax
  */
 
 /**
@@ -202,7 +201,7 @@ if ( jQuery.browser.msie && typeof XMLHttpRequest == "undefined" )
  * @name ajaxSuccess
  * @type jQuery
  * @param Function callback The function to execute.
- * @cat AJAX
+ * @cat Ajax
  */
 
 /**
@@ -220,7 +219,7 @@ if ( jQuery.browser.msie && typeof XMLHttpRequest == "undefined" )
  * @name ajaxError
  * @type jQuery
  * @param Function callback The function to execute.
- * @cat AJAX
+ * @cat Ajax
  */
  
 /**
@@ -237,19 +236,13 @@ if ( jQuery.browser.msie && typeof XMLHttpRequest == "undefined" )
  * @name ajaxSend
  * @type jQuery
  * @param Function callback The function to execute.
- * @cat AJAX
+ * @cat Ajax
  */
-
-new function(){
-       var e = "ajaxStart,ajaxStop,ajaxComplete,ajaxError,ajaxSuccess,ajaxSend".split(",");
-
-       for ( var i = 0; i < e.length; i++ ) new function(){
-               var o = e[i];
-               jQuery.fn[o] = function(f){
-                       return this.bind(o, f);
-               };
+jQuery.each( "ajaxStart,ajaxStop,ajaxComplete,ajaxError,ajaxSuccess,ajaxSend".split(","), function(i,o){
+       jQuery.fn[o] = function(f){
+               return this.bind(o, f);
        };
-};
+});
 
 jQuery.extend({
 
@@ -274,9 +267,9 @@ jQuery.extend({
         * @name $.get
         * @type XMLHttpRequest
         * @param String url The URL of the page to load.
-        * @param Hash params (optional) A set of key/value pairs that will be sent to the server.
+        * @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.
-        * @cat AJAX
+        * @cat Ajax
         */
        get: function( url, data, callback, type, ifModified ) {
                // shift arguments if data argument was ommited
@@ -284,6 +277,7 @@ jQuery.extend({
                        callback = data;
                        data = null;
                }
+               
                return jQuery.ajax({
                        url: url,
                        data: data,
@@ -315,9 +309,9 @@ jQuery.extend({
         * @name $.getIfModified
         * @type XMLHttpRequest
         * @param String url The URL of the page to load.
-        * @param Hash params (optional) A set of key/value pairs that will be sent to the server.
+        * @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.
-        * @cat AJAX
+        * @cat Ajax
         */
        getIfModified: function( url, data, callback, type ) {
                return jQuery.get(url, data, callback, type, 1);
@@ -340,7 +334,7 @@ jQuery.extend({
         * @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.
-        * @cat AJAX
+        * @cat Ajax
         */
        getScript: function( url, callback ) {
                return jQuery.get(url, null, callback, "script");
@@ -363,9 +357,9 @@ jQuery.extend({
         * @name $.getJSON
         * @type XMLHttpRequest
         * @param String url The URL of the page to load.
-        * @param Hash params (optional) A set of key/value pairs that will be sent to the server.
+        * @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.
-        * @cat AJAX
+        * @cat Ajax
         */
        getJSON: function( url, data, callback ) {
                return jQuery.get(url, data, callback, "json");
@@ -392,9 +386,9 @@ jQuery.extend({
         * @name $.post
         * @type XMLHttpRequest
         * @param String url The URL of the page to load.
-        * @param Hash params (optional) A set of key/value pairs that will be sent to the server.
+        * @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.
-        * @cat AJAX
+        * @cat Ajax
         */
        post: function( url, data, callback, type ) {
                return jQuery.ajax({
@@ -427,9 +421,9 @@ jQuery.extend({
         * @name $.ajaxTimeout
         * @type undefined
         * @param Number time How long before an AJAX request times out.
-        * @cat AJAX
+        * @cat Ajax
         */
-       ajaxTimeout: function(timeout) {
+       ajaxTimeout: function( timeout ) {
                jQuery.ajaxSettings.timeout = timeout;
        },
        
@@ -443,16 +437,18 @@ jQuery.extend({
         *   global: false,
         *   type: "POST"
         * } );
+        * $.ajax({ data: myData });
         * @desc Sets the defaults for AJAX requests to the url "/xmlhttp/",
-        * disables global handlers and uses POST instead of GET
+        * disables global handlers and uses POST instead of GET. The following
+        * AJAX requests then sends some data without having to set anything else.
         *
         * @name $.ajaxSetup
         * @type undefined
-        * @param Object settings Key/value pairs for ajax options
-        * @cat AJAX
+        * @param Map settings Key/value pairs to use for all AJAX requests
+        * @cat Ajax
         */
-       ajaxSetup: function(settings) {
-               jQuery.extend(jQuery.ajaxSettings, settings);
+       ajaxSetup: function( settings ) {
+               jQuery.extend( jQuery.ajaxSettings, settings );
        },
 
        ajaxSettings: {
@@ -583,8 +579,9 @@ jQuery.extend({
         * 
         * @name $.ajax
         * @type XMLHttpRequest
-        * @param Hash prop A set of properties to initialize the request with.
-        * @cat AJAX
+        * @param Map properties Key/value pairs to initialize the request with.
+        * @cat Ajax
+        * @see ajaxSetup(Map)
         */
        ajax: function( s ) {
                // TODO introduce global settings, allowing the client to modify them for all requests, not only timeout
@@ -632,7 +629,8 @@ jQuery.extend({
                // Allow custom headers/mimetypes
                if( s.beforeSend )
                        s.beforeSend(xml);
-               if (s.global)
+                       
+               if ( s.global )
                    jQuery.event.trigger("ajaxSend", [xml, s]);
 
                // Wait for a response to come back
@@ -665,9 +663,8 @@ jQuery.extend({
                                                // Fire the global callback
                                                if( s.global )
                                                        jQuery.event.trigger( "ajaxSuccess", [xml, s] );
-                                       } else {
+                                       } else
                                                jQuery.handleError(s, xml, status);
-                                       }
                                } catch(e) {
                                        status = "error";
                                        jQuery.handleError(s, xml, status, e);
@@ -682,7 +679,8 @@ jQuery.extend({
                                        jQuery.event.trigger( "ajaxStop" );
 
                                // Process result
-                               if ( s.complete ) s.complete(xml, status);
+                               if ( s.complete )
+                                       s.complete(xml, status);
 
                                // Stop memory leaks
                                xml.onreadystatechange = function(){};
@@ -692,10 +690,10 @@ jQuery.extend({
                xml.onreadystatechange = onreadystatechange;
 
                // Timeout checker
-               if(s.timeout > 0)
+               if ( s.timeout > 0 )
                        setTimeout(function(){
                                // Check to see if the request is still happening
-                               if(xml) {
+                               if ( xml ) {
                                        // Cancel the request
                                        xml.abort();
 
@@ -715,19 +713,19 @@ jQuery.extend({
                }
                
                // firefox 1.5 doesn't fire statechange for sync requests
-               if(!s.async)
+               if ( !s.async )
                        onreadystatechange();
                
                // return XMLHttpRequest to allow aborting the request etc.
                return xml2;
        },
 
-       handleError: function(s, xml, status, e) {
+       handleError: function( s, xml, status, e ) {
                // If a local callback was specified, fire it
                if ( s.error ) s.error( xml, status, e );
 
                // Fire the global callback
-               if( s.global )
+               if ( s.global )
                        jQuery.event.trigger( "ajaxError", [xml, s, e] );
        },
 
@@ -735,7 +733,7 @@ jQuery.extend({
        active: 0,
 
        // Determines if an XMLHttpRequest was successful or not
-       httpSuccess: function(r) {
+       httpSuccess: function( r ) {
                try {
                        return !r.status && location.protocol == "file:" ||
                                ( r.status >= 200 && r.status < 300 ) || r.status == 304 ||
@@ -745,7 +743,7 @@ jQuery.extend({
        },
 
        // Determines if an XMLHttpRequest returns NotModified
-       httpNotModified: function(xml, url) {
+       httpNotModified: function( xml, url ) {
                try {
                        var xmlRes = xml.getResponseHeader("Last-Modified");
 
@@ -762,51 +760,48 @@ jQuery.extend({
         * (String) data - The type of data that you're expecting back,
         * (e.g. "xml", "html", "script")
         */
-       httpData: function(r,type) {
+       httpData: function( r, type ) {
                var ct = r.getResponseHeader("content-type");
                var data = !type && ct && ct.indexOf("xml") >= 0;
                data = type == "xml" || data ? r.responseXML : r.responseText;
 
                // If the type is "script", eval it in global context
-               if ( type == "script" ) {
+               if ( type == "script" )
                        jQuery.globalEval( data );
-               }
 
                // Get the JavaScript object, if JSON is used.
-               if ( type == "json" ) eval( "data = " + data );
+               if ( type == "json" )
+                       eval( "data = " + data );
 
                // evaluate scripts within html
-               if ( type == "html" ) jQuery("<div>").html(data).evalScripts();
+               if ( type == "html" )
+                       jQuery("<div>").html(data).evalScripts();
 
                return data;
        },
 
        // Serialize an array of form elements or a set of
        // key/values into a query string
-       param: function(a) {
+       param: function( a ) {
                var s = [];
 
                // If an array was passed in, assume that it is an array
                // of form elements
-               if ( a.constructor == Array || a.jquery ) {
+               if ( a.constructor == Array || a.jquery )
                        // 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 {
+               else
                        // Serialize the key/values
-                       for ( var j in a ) {
+                       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++) {
+                               if ( a[j].constructor == Array )
+                                       for ( var k = 0; k < a[j].length; k++ )
                                                s.push( j + "=" + encodeURIComponent( a[j][k] ) );
-                                       }
-                               } else {
+                               else
                                        s.push( j + "=" + encodeURIComponent( a[j] ) );
-                               }
-                       }
-               }
 
                // Return the resulting serialization
                return s.join("&");
@@ -814,10 +809,10 @@ jQuery.extend({
        
        // evalulates a script in global context
        // not reliable for safari
-       globalEval: function(data) {
-               if (window.execScript)
+       globalEval: function( data ) {
+               if ( window.execScript )
                        window.execScript( data );
-               else if(jQuery.browser.safari)
+               else if ( jQuery.browser.safari )
                        // safari doesn't provide a synchronous global eval
                        window.setTimeout( data, 0 );
                else