Changed "Hash" to "Map" in docs
[jquery.git] / src / ajax / ajax.js
index dd3bf18..45159a5 100644 (file)
@@ -11,7 +11,7 @@ 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
         */
@@ -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>
@@ -274,7 +275,7 @@ 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
         */
@@ -315,7 +316,7 @@ 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
         */
@@ -363,7 +364,7 @@ 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
         */
@@ -392,7 +393,7 @@ 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
         */
@@ -407,7 +408,7 @@ jQuery.extend({
        },
 
        // timeout (ms)
-       timeout: 0,
+       //timeout: 0,
 
        /**
         * Set the timeout of all AJAX requests to a specific amount of time.
@@ -419,6 +420,8 @@ jQuery.extend({
         * You can manually abort requests with the XMLHttpRequest's (returned by
         * all ajax functions) abort() method.
         *
+        * Deprecated. Use $.ajaxSetup instead.
+        *
         * @example $.ajaxTimeout( 5000 );
         * @desc Make all AJAX requests timeout after 5 seconds.
         *
@@ -428,9 +431,42 @@ jQuery.extend({
         * @cat AJAX
         */
        ajaxTimeout: function(timeout) {
-               jQuery.timeout = timeout;
+               jQuery.ajaxSettings.timeout = timeout;
+       },
+       
+       /**
+        * Setup global settings for AJAX requests.
+        *
+        * See $.ajax for a description of all available options.
+        *
+        * @example $.ajaxSetup( {
+        *   url: "/xmlhttp/",
+        *   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. The following
+        * AJAX requests then sends some data without having to set anything else.
+        *
+        * @name $.ajaxSetup
+        * @type undefined
+        * @param Map settings Key/value pairs to use for all AJAX requests
+        * @cat AJAX
+        */
+       ajaxSetup: function(settings) {
+               jQuery.extend(jQuery.ajaxSettings, settings);
        },
 
+       ajaxSettings: {
+               global: true,
+               type: "GET",
+               timeout: 0,
+               contentType: "application/x-www-form-urlencoded",
+               processData: true,
+               async: true
+       },
+       
        // Last-Modified header cache for next request
        lastModified: {},
 
@@ -475,7 +511,7 @@ jQuery.extend({
         * Last-Modified header. Default value is false, ignoring the header.
         *
         * (Number) timeout - Local timeout to override global timeout, eg. to give a
-        * single request a longer timeout while all others timeout after 1 seconds.
+        * single request a longer timeout while all others timeout after 1 second.
         * See $.ajaxTimeout() for global timeouts.
         *
         * (Boolean) global - Whether to trigger global AJAX event handlers for
@@ -550,27 +586,13 @@ jQuery.extend({
         * 
         * @name $.ajax
         * @type XMLHttpRequest
-        * @param Hash prop A set of properties to initialize the request with.
+        * @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
-               s = jQuery.extend({
-                       global: true,
-                       ifModified: false,
-                       type: "GET",
-                       timeout: jQuery.timeout,
-                       complete: null,
-                       success: null,
-                       error: null,
-                       dataType: null,
-                       url: null,
-                       data: null,
-                       contentType: "application/x-www-form-urlencoded",
-                       processData: true,
-                       async: true,
-                       beforeSend: null
-               }, s);
+               s = jQuery.extend({}, jQuery.ajaxSettings, s);
 
                // if data available
                if ( s.data ) {
@@ -647,6 +669,8 @@ jQuery.extend({
                                                // Fire the global callback
                                                if( s.global )
                                                        jQuery.event.trigger( "ajaxSuccess", [xml, s] );
+                                       } else {
+                                               jQuery.handleError(s, xml, status);
                                        }
                                } catch(e) {
                                        status = "error";
@@ -675,14 +699,12 @@ jQuery.extend({
                if(s.timeout > 0)
                        setTimeout(function(){
                                // Check to see if the request is still happening
-                               if (xml) {
+                               if(xml) {
                                        // Cancel the request
                                        xml.abort();
 
-                                       if ( !requestDone ) onreadystatechange( "timeout" );
-
-                                       // Clear from memory
-                                       xml = null;
+                                       if( !requestDone )
+                                               onreadystatechange( "timeout" );
                                }
                        }, s.timeout);
                        
@@ -696,6 +718,10 @@ jQuery.extend({
                        jQuery.handleError(s, xml, null, e);
                }
                
+               // firefox 1.5 doesn't fire statechange for sync requests
+               if(!s.async)
+                       onreadystatechange();
+               
                // return XMLHttpRequest to allow aborting the request etc.
                return xml2;
        },
@@ -714,18 +740,24 @@ jQuery.extend({
 
        // Determines if an XMLHttpRequest was successful or not
        httpSuccess: function(r) {
-               return !r.status && location.protocol == "file:" ||
-                       ( r.status >= 200 && r.status < 300 ) || r.status == 304 ||
-                       jQuery.browser.safari && r.status == undefined;
+               try {
+                       return !r.status && location.protocol == "file:" ||
+                               ( r.status >= 200 && r.status < 300 ) || r.status == 304 ||
+                               jQuery.browser.safari && r.status == undefined;
+               } catch(e){}
+               return false;
        },
 
        // Determines if an XMLHttpRequest returns NotModified
        httpNotModified: function(xml, url) {
-               var xmlRes = xml.getResponseHeader("Last-Modified");
+               try {
+                       var xmlRes = xml.getResponseHeader("Last-Modified");
 
-               // Firefox always returns 200. check Last-Modified date
-               return xml.status == 304 || xmlRes == jQuery.lastModified[url] ||
-                       jQuery.browser.safari && xml.status == undefined;
+                       // Firefox always returns 200. check Last-Modified date
+                       return xml.status == 304 || xmlRes == jQuery.lastModified[url] ||
+                               jQuery.browser.safari && xml.status == undefined;
+               } catch(e){}
+               return false;
        },
 
        /* Get the data out of an XMLHttpRequest.