Removed all inline documentation. The current version of all documentation is stored...
[jquery.git] / src / ajax / ajax.js
index 0b965e4..62785f3 100644 (file)
@@ -1,49 +1,9 @@
 jQuery.fn.extend({
-
-       /**
-        * Load HTML from a remote file and inject it into the DOM, only if it's
-        * been modified by the server.
-        *
-        * @example $("#feeds").loadIfModified("feeds.html");
-        * @before <div id="feeds"></div>
-        * @result <div id="feeds"><b>45</b> feeds found.</div>
-        *
-        * @name loadIfModified
-        * @type jQuery
-        * @param String url The URL of the HTML file 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 (parameters: responseText, status and response itself).
-        * @cat Ajax
-        */
        // DEPRECATED
        loadIfModified: function( url, params, callback ) {
                this.load( url, params, callback, 1 );
        },
 
-       /**
-        * 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>
-        * @result <div id="feeds"><b>45</b> feeds found.</div>
-        *
-        * @example $("#feeds").load("feeds.html",
-        *   {limit: 25},
-        *   function() { alert("The last 25 entries in the feed have been loaded"); }
-        * );
-        * @desc Same as above, but with an additional parameter
-        * and a callback that is executed when the data was loaded.
-        *
-        * @name load
-        * @type jQuery
-        * @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
-        */
        load: function( url, params, callback, ifModified ) {
                if ( jQuery.isFunction( url ) )
                        return this.bind("load", url);
@@ -107,25 +67,6 @@ jQuery.fn.extend({
                return this;
        },
 
-       /**
-        * Serializes a set of input elements into a string of data.
-        * This will serialize all given elements.
-        *
-        * A serialization similar to the form submit of a browser is
-        * 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&amp;location=Boston
-        * @desc Serialize a selection of input elements to a string
-        *
-        * @name serialize
-        * @type String
-        * @cat Ajax
-        */
        serialize: function() {
                return jQuery.param( this );
        },
@@ -138,106 +79,6 @@ jQuery.fn.extend({
 });
 
 // Attach a bunch of functions for handling common AJAX events
-
-/**
- * Attach a function to be executed whenever an AJAX request begins
- * and there is none already active.
- *
- * @example $("#loading").ajaxStart(function(){
- *   $(this).show();
- * });
- * @desc Show a loading message whenever an AJAX request starts
- * (and none is already active).
- *
- * @name ajaxStart
- * @type jQuery
- * @param Function callback The function to execute.
- * @cat Ajax
- */
-
-/**
- * Attach a function to be executed whenever all AJAX requests have ended.
- *
- * @example $("#loading").ajaxStop(function(){
- *   $(this).hide();
- * });
- * @desc Hide a loading message after all the AJAX requests have stopped.
- *
- * @name ajaxStop
- * @type jQuery
- * @param Function callback The function to execute.
- * @cat Ajax
- */
-
-/**
- * Attach a function to be executed whenever an AJAX request completes.
- *
- * The XMLHttpRequest and settings used for that request are passed
- * as arguments to the callback.
- *
- * @example $("#msg").ajaxComplete(function(request, settings){
- *   $(this).append("<li>Request Complete.</li>");
- * });
- * @desc Show a message when an AJAX request completes.
- *
- * @name ajaxComplete
- * @type jQuery
- * @param Function callback The function to execute.
- * @cat Ajax
- */
-
-/**
- * Attach a function to be executed whenever an AJAX request completes
- * successfully.
- *
- * The XMLHttpRequest and settings used for that request are passed
- * as arguments to the callback.
- *
- * @example $("#msg").ajaxSuccess(function(request, settings){
- *   $(this).append("<li>Successful Request!</li>");
- * });
- * @desc Show a message when an AJAX request completes successfully.
- *
- * @name ajaxSuccess
- * @type jQuery
- * @param Function callback The function to execute.
- * @cat Ajax
- */
-
-/**
- * Attach a function to be executed whenever an AJAX request fails.
- *
- * The XMLHttpRequest and settings used for that request are passed
- * as arguments to the callback. A third argument, an exception object,
- * is passed if an exception occured while processing the request.
- *
- * @example $("#msg").ajaxError(function(request, settings){
- *   $(this).append("<li>Error requesting page " + settings.url + "</li>");
- * });
- * @desc Show a message when an AJAX request fails.
- *
- * @name ajaxError
- * @type jQuery
- * @param Function callback The function to execute.
- * @cat Ajax
- */
-/**
- * Attach a function to be executed before an AJAX request is sent.
- *
- * The XMLHttpRequest and settings used for that request are passed
- * as arguments to the callback.
- *
- * @example $("#msg").ajaxSend(function(request, settings){
- *   $(this).append("<li>Starting request at " + settings.url + "</li>");
- * });
- * @desc Show a message before an AJAX request is sent.
- *
- * @name ajaxSend
- * @type jQuery
- * @param Function callback The function to execute.
- * @cat Ajax
- */
 jQuery.each( "ajaxStart,ajaxStop,ajaxComplete,ajaxError,ajaxSuccess,ajaxSend".split(","), function(i,o){
        jQuery.fn[o] = function(f){
                return this.bind(o, f);
@@ -247,39 +88,6 @@ jQuery.each( "ajaxStart,ajaxStop,ajaxComplete,ajaxError,ajaxSuccess,ajaxSend".sp
 var jsc = (new Date).getTime();
 
 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" } );
-        *
-        * @example $.get("test.cgi", function(data){
-        *   alert("Data Loaded: " + data);
-        * });
-        *
-        * @example $.get("test.cgi",
-        *   { name: "John", time: "2pm" },
-        *   function(data){
-        *     alert("Data Loaded: " + data);
-        *   }
-        * );
-        *
-        * @name $.get
-        * @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 successfully.
-        * @cat Ajax
-        */
        get: function( url, data, callback, type, ifModified ) {
                // shift arguments if data argument was ommited
                if ( jQuery.isFunction( data ) ) {
@@ -297,110 +105,19 @@ jQuery.extend({
                });
        },
 
-       /**
-        * Load a remote page using an HTTP GET request, only if it hasn't
-        * been modified since it was last retrieved.
-        *
-        * @example $.getIfModified("test.html");
-        *
-        * @example $.getIfModified("test.html", { name: "John", time: "2pm" } );
-        *
-        * @example $.getIfModified("test.cgi", function(data){
-        *   alert("Data Loaded: " + data);
-        * });
-        *
-        * @example $.getifModified("test.cgi",
-        *   { name: "John", time: "2pm" },
-        *   function(data){
-        *     alert("Data Loaded: " + data);
-        *   }
-        * );
-        *
-        * @name $.getIfModified
-        * @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 successfully.
-        * @cat Ajax
-        */
        // DEPRECATED
        getIfModified: function( url, data, callback, type ) {
                return jQuery.get(url, data, callback, type, 1);
        },
 
-       /**
-        * Loads, and executes, a remote JavaScript file using an HTTP GET request.
-        *
-        * 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.
-        *
-        * @example $.getScript("test.js");
-        *
-        * @example $.getScript("test.js", function(){
-        *   alert("Script loaded and executed.");
-        * });
-        *
-        * @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 successfully.
-        * @cat Ajax
-        */
        getScript: function( url, callback ) {
                return jQuery.get(url, null, callback, "script");
        },
 
-       /**
-        * Load JSON data using an HTTP GET request.
-        *
-        * @example $.getJSON("test.js", function(json){
-        *   alert("JSON Data: " + json.users[3].name);
-        * });
-        *
-        * @example $.getJSON("test.js",
-        *   { name: "John", time: "2pm" },
-        *   function(json){
-        *     alert("JSON Data: " + json.users[3].name);
-        *   }
-        * );
-        *
-        * @name $.getJSON
-        * @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 successfully.
-        * @cat Ajax
-        */
        getJSON: function( url, data, callback ) {
                return jQuery.get(url, data, callback, "json");
        },
 
-       /**
-        * Load a remote page using an HTTP POST request.
-        *
-        * @example $.post("test.cgi");
-        *
-        * @example $.post("test.cgi", { name: "John", time: "2pm" } );
-        *
-        * @example $.post("test.cgi", function(data){
-        *   alert("Data Loaded: " + data);
-        * });
-        *
-        * @example $.post("test.cgi",
-        *   { name: "John", time: "2pm" },
-        *   function(data){
-        *     alert("Data Loaded: " + data);
-        *   }
-        * );
-        *
-        * @name $.post
-        * @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 successfully.
-        * @cat Ajax
-        */
        post: function( url, data, callback, type ) {
                if ( jQuery.isFunction( data ) ) {
                        callback = data;
@@ -416,51 +133,11 @@ jQuery.extend({
                });
        },
 
-       /**
-        * Set the timeout in milliseconds of all AJAX requests to a specific amount of time.
-        * This will make all future AJAX requests timeout after a specified amount
-        * of time.
-        *
-        * Set to null or 0 to disable timeouts (default).
-        *
-        * 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.
-        *
-        * @name $.ajaxTimeout
-        * @type undefined
-        * @param Number time How long before an AJAX request times out, in milliseconds.
-        * @cat Ajax
-        */
        // DEPRECATED
        ajaxTimeout: function( 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 );
        },
@@ -478,128 +155,6 @@ jQuery.extend({
        // Last-Modified header cache for next request
        lastModified: {},
 
-       /**
-        * Load a remote page using an HTTP request.
-        *
-        * This is jQuery's low-level AJAX implementation. See $.get, $.post etc. for
-        * 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:''' 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):
-        *
-        * "xml": Returns a XML document that can be processed via jQuery.
-        *
-        * "html": Returns HTML as plain text, included script tags are evaluated.
-        *
-        * "script": Evaluates the response as Javascript and returns it as plain text.
-        *
-        * "json": Evaluates the response as JSON and returns a Javascript Object
-        *
-        * $.ajax() takes one argument, an object of key/value pairs, that are
-        * used to initalize and handle the request. These are all the key/values that can
-        * be used:
-        *
-        * (String) url - The URL to request.
-        *
-        * (String) type - The type of request to make ("POST" or "GET"), default is "GET".
-        *
-        * (String) dataType - The type of data that you're expecting back from
-        * the server. No default: If the server sends xml, the responseXML, otherwise
-        * the responseText is passed to the success callback.
-        *
-        * (Boolean) ifModified - Allow the request to be successful only if the
-        * response has changed since the last request. This is done by checking the
-        * Last-Modified header. Default value is false, ignoring the header.
-        *
-        * (Number) timeout - Local timeout in milliseconds to override global timeout, eg. to give a
-        * 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
-        * this request, default is true. Set to false to prevent that global handlers
-        * like ajaxStart or ajaxStop are triggered.
-        *
-        * (Function) error - A function to be called if the request fails. The
-        * function gets passed tree arguments: The XMLHttpRequest object, a
-        * string describing the type of error that occurred and an optional
-        * exception object, if one occured.
-        *
-        * (Function) success - A function to be called if the request succeeds. The
-        * function gets passed one argument: The data returned from the server,
-        * formatted according to the 'dataType' parameter.
-        *
-        * (Function) complete - A function to be called when the request finishes. The
-        * function gets passed two arguments: The XMLHttpRequest object and a
-        * string describing the type of success of the request.
-        *
-        * (Object|String) data - Data to be sent to the server. Converted to a query
-        * string, if not already a string. Is appended to the url for GET-requests.
-        * See processData option to prevent this automatic processing.
-        *
-        * (String) contentType - When sending data to the server, use this content-type.
-        * Default is "application/x-www-form-urlencoded", which is fine for most cases.
-        *
-        * (Boolean) processData - By default, data passed in to the data option as an object
-        * other as string will be processed and transformed into a query string, fitting to
-        * the default content-type "application/x-www-form-urlencoded". If you want to send
-        * DOMDocuments, set this option to false.
-        *
-        * (Boolean) async - By default, all requests are sent asynchronous (set to true).
-        * If you need synchronous requests, set this option to false.
-        *
-        * (Function) beforeSend - A pre-callback to set custom headers etc., the
-        * XMLHttpRequest is passed as the only argument.
-        *
-        * @example $.ajax({
-        *   type: "GET",
-        *   url: "test.js",
-        *   dataType: "script"
-        * })
-        * @desc Load and execute a JavaScript file.
-        *
-        * @example $.ajax({
-        *   type: "POST",
-        *   url: "some.php",
-        *   data: "name=John&location=Boston",
-        *   success: function(msg){
-        *     alert( "Data Saved: " + msg );
-        *   }
-        * });
-        * @desc Save some data to the server and notify the user once its complete.
-        *
-        * @example var html = $.ajax({
-        *  url: "some.php",
-        *  async: false
-        * }).responseText;
-        * @desc Loads data synchronously. Blocks the browser while the requests is active.
-        * It is better to block user interaction by other means when synchronization is
-        * necessary.
-        *
-        * @example var xmlDocument = [create xml document];
-        * $.ajax({
-        *   url: "page.php",
-        *   processData: false,
-        *   data: xmlDocument,
-        *   success: handleResponse
-        * });
-        * @desc Sends an xml document as data to the server. By setting the processData
-        * option to false, the automatic conversion of data to strings is prevented.
-        * 
-        * @name $.ajax
-        * @type XMLHttpRequest
-        * @param Map properties Key/value pairs to initialize the request with.
-        * @cat Ajax
-        * @see ajaxSetup(Map)
-        */
        ajax: function( s ) {
                var jsonp, jsre = /=(\?|%3F)/g, status, data;
 
@@ -862,12 +417,6 @@ jQuery.extend({
                return false;
        },
 
-       /* Get the data out of an XMLHttpRequest.
-        * Return parsed XML if content-type header is "xml" and type is "xml" or omitted,
-        * otherwise return plain text.
-        * (String) data - The type of data that you're expecting back,
-        * (e.g. "xml", "html", "script")
-        */
        httpData: function( r, type ) {
                var ct = r.getResponseHeader("content-type");
                var xml = type == "xml" || !type && ct && ct.indexOf("xml") >= 0;