4 * Load HTML from a remote file and inject it into the DOM, only if it's
5 * been modified by the server.
7 * @example $("#feeds").loadIfModified("feeds.html");
8 * @before <div id="feeds"></div>
9 * @result <div id="feeds"><b>45</b> feeds found.</div>
11 * @name loadIfModified
13 * @param String url The URL of the HTML file to load.
14 * @param Map params (optional) Key/value pairs that will be sent to the server.
15 * @param Function callback (optional) A function to be executed whenever the data is loaded (parameters: responseText, status and response itself).
18 loadIfModified: function( url, params, callback ) {
19 this.load( url, params, callback, 1 );
23 * Load HTML from a remote file and inject it into the DOM.
25 * Note: Avoid to use this to load scripts, instead use $.getScript.
26 * IE strips script tags when there aren't any other characters in front of it.
28 * @example $("#feeds").load("feeds.html");
29 * @before <div id="feeds"></div>
30 * @result <div id="feeds"><b>45</b> feeds found.</div>
32 * @example $("#feeds").load("feeds.html",
34 * function() { alert("The last 25 entries in the feed have been loaded"); }
36 * @desc Same as above, but with an additional parameter
37 * and a callback that is executed when the data was loaded.
41 * @param String url The URL of the HTML file to load.
42 * @param Object params (optional) A set of key/value pairs that will be sent as data to the server.
43 * @param Function callback (optional) A function to be executed whenever the data is loaded (parameters: responseText, status and response itself).
46 load: function( url, params, callback, ifModified ) {
47 if ( jQuery.isFunction( url ) )
48 return this.bind("load", url);
50 callback = callback || function(){};
52 // Default to a GET request
55 // If the second parameter was provided
58 if ( jQuery.isFunction( params ) ) {
59 // We assume that it's the callback
63 // Otherwise, build a param string
65 params = jQuery.param( params );
71 // Request the remote document
76 ifModified: ifModified,
77 complete: function(res, status){
78 // If successful, inject the HTML into all the matched elements
79 if ( status == "success" || !ifModified && status == "notmodified" )
80 self.html(res.responseText);
82 // Add delay to account for Safari's delay in globalEval
83 setTimeout(function(){
84 self.each( callback, [res.responseText, status, res] );
92 * Serializes a set of input elements into a string of data.
93 * This will serialize all given elements.
95 * A serialization similar to the form submit of a browser is
96 * provided by the [http://www.malsup.com/jquery/form/ Form Plugin].
97 * It also takes multiple-selects
98 * into account, while this method recognizes only a single option.
100 * @example $("input[@type=text]").serialize();
101 * @before <input type='text' name='name' value='John'/>
102 * <input type='text' name='location' value='Boston'/>
103 * @after name=John&location=Boston
104 * @desc Serialize a selection of input elements to a string
110 serialize: function() {
111 return jQuery.param( this );
116 // Attach a bunch of functions for handling common AJAX events
119 * Attach a function to be executed whenever an AJAX request begins
120 * and there is none already active.
122 * @example $("#loading").ajaxStart(function(){
125 * @desc Show a loading message whenever an AJAX request starts
126 * (and none is already active).
130 * @param Function callback The function to execute.
135 * Attach a function to be executed whenever all AJAX requests have ended.
137 * @example $("#loading").ajaxStop(function(){
140 * @desc Hide a loading message after all the AJAX requests have stopped.
144 * @param Function callback The function to execute.
149 * Attach a function to be executed whenever an AJAX request completes.
151 * The XMLHttpRequest and settings used for that request are passed
152 * as arguments to the callback.
154 * @example $("#msg").ajaxComplete(function(request, settings){
155 * $(this).append("<li>Request Complete.</li>");
157 * @desc Show a message when an AJAX request completes.
161 * @param Function callback The function to execute.
166 * Attach a function to be executed whenever an AJAX request completes
169 * The XMLHttpRequest and settings used for that request are passed
170 * as arguments to the callback.
172 * @example $("#msg").ajaxSuccess(function(request, settings){
173 * $(this).append("<li>Successful Request!</li>");
175 * @desc Show a message when an AJAX request completes successfully.
179 * @param Function callback The function to execute.
184 * Attach a function to be executed whenever an AJAX request fails.
186 * The XMLHttpRequest and settings used for that request are passed
187 * as arguments to the callback. A third argument, an exception object,
188 * is passed if an exception occured while processing the request.
190 * @example $("#msg").ajaxError(function(request, settings){
191 * $(this).append("<li>Error requesting page " + settings.url + "</li>");
193 * @desc Show a message when an AJAX request fails.
197 * @param Function callback The function to execute.
202 * Attach a function to be executed before an AJAX request is sent.
204 * The XMLHttpRequest and settings used for that request are passed
205 * as arguments to the callback.
207 * @example $("#msg").ajaxSend(function(request, settings){
208 * $(this).append("<li>Starting request at " + settings.url + "</li>");
210 * @desc Show a message before an AJAX request is sent.
214 * @param Function callback The function to execute.
217 jQuery.each( "ajaxStart,ajaxStop,ajaxComplete,ajaxError,ajaxSuccess,ajaxSend".split(","), function(i,o){
218 jQuery.fn[o] = function(f){
219 return this.bind(o, f);
226 * Load a remote page using an HTTP GET request.
228 * This is an easy way to send a simple GET request to a server
229 * without having to use the more complex $.ajax function. It
230 * allows a single callback function to be specified that will
231 * be executed when the request is complete (and only if the response
232 * has a successful response code). If you need to have both error
233 * and success callbacks, you may want to use $.ajax.
235 * @example $.get("test.cgi");
237 * @example $.get("test.cgi", { name: "John", time: "2pm" } );
239 * @example $.get("test.cgi", function(data){
240 * alert("Data Loaded: " + data);
243 * @example $.get("test.cgi",
244 * { name: "John", time: "2pm" },
246 * alert("Data Loaded: " + data);
251 * @type XMLHttpRequest
252 * @param String url The URL of the page to load.
253 * @param Map params (optional) Key/value pairs that will be sent to the server.
254 * @param Function callback (optional) A function to be executed whenever the data is loaded successfully.
257 get: function( url, data, callback, type, ifModified ) {
258 // shift arguments if data argument was ommited
259 if ( jQuery.isFunction( data ) ) {
270 ifModified: ifModified
275 * Load a remote page using an HTTP GET request, only if it hasn't
276 * been modified since it was last retrieved.
278 * @example $.getIfModified("test.html");
280 * @example $.getIfModified("test.html", { name: "John", time: "2pm" } );
282 * @example $.getIfModified("test.cgi", function(data){
283 * alert("Data Loaded: " + data);
286 * @example $.getifModified("test.cgi",
287 * { name: "John", time: "2pm" },
289 * alert("Data Loaded: " + data);
293 * @name $.getIfModified
294 * @type XMLHttpRequest
295 * @param String url The URL of the page to load.
296 * @param Map params (optional) Key/value pairs that will be sent to the server.
297 * @param Function callback (optional) A function to be executed whenever the data is loaded successfully.
300 getIfModified: function( url, data, callback, type ) {
301 return jQuery.get(url, data, callback, type, 1);
305 * Loads, and executes, a remote JavaScript file using an HTTP GET request.
307 * Warning: Safari <= 2.0.x is unable to evaluate scripts in a global
308 * context synchronously. If you load functions via getScript, make sure
309 * to call them after a delay.
311 * @example $.getScript("test.js");
313 * @example $.getScript("test.js", function(){
314 * alert("Script loaded and executed.");
318 * @type XMLHttpRequest
319 * @param String url The URL of the page to load.
320 * @param Function callback (optional) A function to be executed whenever the data is loaded successfully.
323 getScript: function( url, callback ) {
324 return jQuery.get(url, null, callback, "script");
328 * Load JSON data using an HTTP GET request.
330 * @example $.getJSON("test.js", function(json){
331 * alert("JSON Data: " + json.users[3].name);
334 * @example $.getJSON("test.js",
335 * { name: "John", time: "2pm" },
337 * alert("JSON Data: " + json.users[3].name);
342 * @type XMLHttpRequest
343 * @param String url The URL of the page to load.
344 * @param Map params (optional) Key/value pairs that will be sent to the server.
345 * @param Function callback A function to be executed whenever the data is loaded successfully.
348 getJSON: function( url, data, callback ) {
349 return jQuery.get(url, data, callback, "json");
353 * Load a remote page using an HTTP POST request.
355 * @example $.post("test.cgi");
357 * @example $.post("test.cgi", { name: "John", time: "2pm" } );
359 * @example $.post("test.cgi", function(data){
360 * alert("Data Loaded: " + data);
363 * @example $.post("test.cgi",
364 * { name: "John", time: "2pm" },
366 * alert("Data Loaded: " + data);
371 * @type XMLHttpRequest
372 * @param String url The URL of the page to load.
373 * @param Map params (optional) Key/value pairs that will be sent to the server.
374 * @param Function callback (optional) A function to be executed whenever the data is loaded successfully.
377 post: function( url, data, callback, type ) {
378 if ( jQuery.isFunction( data ) ) {
393 * Set the timeout in milliseconds of all AJAX requests to a specific amount of time.
394 * This will make all future AJAX requests timeout after a specified amount
397 * Set to null or 0 to disable timeouts (default).
399 * You can manually abort requests with the XMLHttpRequest's (returned by
400 * all ajax functions) abort() method.
402 * Deprecated. Use $.ajaxSetup instead.
404 * @example $.ajaxTimeout( 5000 );
405 * @desc Make all AJAX requests timeout after 5 seconds.
407 * @name $.ajaxTimeout
409 * @param Number time How long before an AJAX request times out, in milliseconds.
412 ajaxTimeout: function( timeout ) {
413 jQuery.ajaxSettings.timeout = timeout;
417 * Setup global settings for AJAX requests.
419 * See $.ajax for a description of all available options.
421 * @example $.ajaxSetup( {
426 * $.ajax({ data: myData });
427 * @desc Sets the defaults for AJAX requests to the url "/xmlhttp/",
428 * disables global handlers and uses POST instead of GET. The following
429 * AJAX requests then sends some data without having to set anything else.
433 * @param Map settings Key/value pairs to use for all AJAX requests
436 ajaxSetup: function( settings ) {
437 jQuery.extend( jQuery.ajaxSettings, settings );
444 contentType: "application/x-www-form-urlencoded",
450 // Last-Modified header cache for next request
454 * Load a remote page using an HTTP request.
456 * This is jQuery's low-level AJAX implementation. See $.get, $.post etc. for
457 * higher-level abstractions that are often easier to understand and use,
458 * but don't offer as much functionality (such as error callbacks).
460 * $.ajax() returns the XMLHttpRequest that it creates. In most cases you won't
461 * need that object to manipulate directly, but it is available if you need to
462 * abort the request manually.
464 * '''Note:''' If you specify the dataType option described below, make sure
465 * the server sends the correct MIME type in the response (eg. xml as "text/xml").
466 * Sending the wrong MIME type can lead to unexpected problems in your script.
467 * See [[Specifying the Data Type for AJAX Requests]] for more information.
469 * Supported datatypes are (see dataType option):
471 * "xml": Returns a XML document that can be processed via jQuery.
473 * "html": Returns HTML as plain text, included script tags are evaluated.
475 * "script": Evaluates the response as Javascript and returns it as plain text.
477 * "json": Evaluates the response as JSON and returns a Javascript Object
479 * $.ajax() takes one argument, an object of key/value pairs, that are
480 * used to initalize and handle the request. These are all the key/values that can
483 * (String) url - The URL to request.
485 * (String) type - The type of request to make ("POST" or "GET"), default is "GET".
487 * (String) dataType - The type of data that you're expecting back from
488 * the server. No default: If the server sends xml, the responseXML, otherwise
489 * the responseText is passed to the success callback.
491 * (Boolean) ifModified - Allow the request to be successful only if the
492 * response has changed since the last request. This is done by checking the
493 * Last-Modified header. Default value is false, ignoring the header.
495 * (Number) timeout - Local timeout in milliseconds to override global timeout, eg. to give a
496 * single request a longer timeout while all others timeout after 1 second.
497 * See $.ajaxTimeout() for global timeouts.
499 * (Boolean) global - Whether to trigger global AJAX event handlers for
500 * this request, default is true. Set to false to prevent that global handlers
501 * like ajaxStart or ajaxStop are triggered.
503 * (Function) error - A function to be called if the request fails. The
504 * function gets passed tree arguments: The XMLHttpRequest object, a
505 * string describing the type of error that occurred and an optional
506 * exception object, if one occured.
508 * (Function) success - A function to be called if the request succeeds. The
509 * function gets passed one argument: The data returned from the server,
510 * formatted according to the 'dataType' parameter.
512 * (Function) complete - A function to be called when the request finishes. The
513 * function gets passed two arguments: The XMLHttpRequest object and a
514 * string describing the type of success of the request.
516 * (Object|String) data - Data to be sent to the server. Converted to a query
517 * string, if not already a string. Is appended to the url for GET-requests.
518 * See processData option to prevent this automatic processing.
520 * (String) contentType - When sending data to the server, use this content-type.
521 * Default is "application/x-www-form-urlencoded", which is fine for most cases.
523 * (Boolean) processData - By default, data passed in to the data option as an object
524 * other as string will be processed and transformed into a query string, fitting to
525 * the default content-type "application/x-www-form-urlencoded". If you want to send
526 * DOMDocuments, set this option to false.
528 * (Boolean) async - By default, all requests are sent asynchronous (set to true).
529 * If you need synchronous requests, set this option to false.
531 * (Function) beforeSend - A pre-callback to set custom headers etc., the
532 * XMLHttpRequest is passed as the only argument.
539 * @desc Load and execute a JavaScript file.
544 * data: "name=John&location=Boston",
545 * success: function(msg){
546 * alert( "Data Saved: " + msg );
549 * @desc Save some data to the server and notify the user once its complete.
551 * @example var html = $.ajax({
555 * @desc Loads data synchronously. Blocks the browser while the requests is active.
556 * It is better to block user interaction by other means when synchronization is
559 * @example var xmlDocument = [create xml document];
562 * processData: false,
564 * success: handleResponse
566 * @desc Sends an xml document as data to the server. By setting the processData
567 * option to false, the automatic conversion of data to strings is prevented.
570 * @type XMLHttpRequest
571 * @param Map properties Key/value pairs to initialize the request with.
573 * @see ajaxSetup(Map)
575 ajax: function( s ) {
576 // Extend the settings, but re-extend 's' so that it can be
577 // checked again later (in the test suite, specifically)
578 s = jQuery.extend(true, s, jQuery.extend(true, {}, jQuery.ajaxSettings, s));
582 // convert data if not already a string
583 if ( s.processData && typeof s.data != "string" )
584 s.data = jQuery.param(s.data);
586 // append data to url for get requests
587 if ( s.type.toLowerCase() == "get" ) {
588 // "?" + data or "&" + data (in case there are already params)
589 s.url += (s.url.indexOf("?") > -1 ? "&" : "?") + s.data;
591 // IE likes to send both get and post data, prevent this
596 // Watch for a new set of requests
597 if ( s.global && ! jQuery.active++ )
598 jQuery.event.trigger( "ajaxStart" );
600 var requestDone = false;
602 // Create the request object; Microsoft failed to properly
603 // implement the XMLHttpRequest in IE7, so we use the ActiveXObject when it is available
604 var xml = window.ActiveXObject ? new ActiveXObject("Microsoft.XMLHTTP") : new XMLHttpRequest();
607 xml.open(s.type, s.url, s.async);
609 // Set the correct header, if data is being sent
611 xml.setRequestHeader("Content-Type", s.contentType);
613 // Set the If-Modified-Since header, if ifModified mode.
615 xml.setRequestHeader("If-Modified-Since",
616 jQuery.lastModified[s.url] || "Thu, 01 Jan 1970 00:00:00 GMT" );
618 // Set header so the called script knows that it's an XMLHttpRequest
619 xml.setRequestHeader("X-Requested-With", "XMLHttpRequest");
621 // Allow custom headers/mimetypes
626 jQuery.event.trigger("ajaxSend", [xml, s]);
628 // Wait for a response to come back
629 var onreadystatechange = function(isTimeout){
630 // The transfer is complete and the data is available, or the request timed out
631 if ( !requestDone && xml && (xml.readyState == 4 || isTimeout == "timeout") ) {
634 // clear poll interval
640 var status = isTimeout == "timeout" && "timeout" ||
641 !jQuery.httpSuccess( xml ) && "error" ||
642 s.ifModified && jQuery.httpNotModified( xml, s.url ) && "notmodified" ||
645 if ( status == "success" ) {
646 // Watch for, and catch, XML document parse errors
648 // process the data (runs the xml through httpData regardless of callback)
649 var data = jQuery.httpData( xml, s.dataType );
651 status = "parsererror";
655 // Make sure that the request was successful or notmodified
656 if ( status == "success" ) {
657 // Cache Last-Modified header, if ifModified mode.
660 modRes = xml.getResponseHeader("Last-Modified");
661 } catch(e) {} // swallow exception thrown by FF if header is not available
663 if ( s.ifModified && modRes )
664 jQuery.lastModified[s.url] = modRes;
666 // If a local callback was specified, fire it and pass it the data
668 s.success( data, status );
670 // Fire the global callback
672 jQuery.event.trigger( "ajaxSuccess", [xml, s] );
674 jQuery.handleError(s, xml, status);
676 // The request was completed
678 jQuery.event.trigger( "ajaxComplete", [xml, s] );
680 // Handle the global AJAX counter
681 if ( s.global && ! --jQuery.active )
682 jQuery.event.trigger( "ajaxStop" );
686 s.complete(xml, status);
695 // don't attach the handler to the request, just poll it instead
696 var ival = setInterval(onreadystatechange, 13);
700 setTimeout(function(){
701 // Check to see if the request is still happening
703 // Cancel the request
707 onreadystatechange( "timeout" );
716 jQuery.handleError(s, xml, null, e);
719 // firefox 1.5 doesn't fire statechange for sync requests
721 onreadystatechange();
723 // return XMLHttpRequest to allow aborting the request etc.
727 handleError: function( s, xml, status, e ) {
728 // If a local callback was specified, fire it
729 if ( s.error ) s.error( xml, status, e );
731 // Fire the global callback
733 jQuery.event.trigger( "ajaxError", [xml, s, e] );
736 // Counter for holding the number of active queries
739 // Determines if an XMLHttpRequest was successful or not
740 httpSuccess: function( r ) {
742 return !r.status && location.protocol == "file:" ||
743 ( r.status >= 200 && r.status < 300 ) || r.status == 304 ||
744 jQuery.browser.safari && r.status == undefined;
749 // Determines if an XMLHttpRequest returns NotModified
750 httpNotModified: function( xml, url ) {
752 var xmlRes = xml.getResponseHeader("Last-Modified");
754 // Firefox always returns 200. check Last-Modified date
755 return xml.status == 304 || xmlRes == jQuery.lastModified[url] ||
756 jQuery.browser.safari && xml.status == undefined;
761 /* Get the data out of an XMLHttpRequest.
762 * Return parsed XML if content-type header is "xml" and type is "xml" or omitted,
763 * otherwise return plain text.
764 * (String) data - The type of data that you're expecting back,
765 * (e.g. "xml", "html", "script")
767 httpData: function( r, type ) {
768 var ct = r.getResponseHeader("content-type");
769 var xml = type == "xml" || !type && ct && ct.indexOf("xml") >= 0;
770 data = xml ? r.responseXML : r.responseText;
772 if ( xml && data.documentElement.tagName == "parsererror" )
775 // If the type is "script", eval it in global context
776 if ( type == "script" )
777 jQuery.globalEval( data );
779 // Get the JavaScript object, if JSON is used.
780 if ( type == "json" )
781 data = eval("(" + data + ")");
786 // Serialize an array of form elements or a set of
787 // key/values into a query string
788 param: function( a ) {
791 // If an array was passed in, assume that it is an array
793 if ( a.constructor == Array || a.jquery )
794 // Serialize the form elements
795 jQuery.each( a, function(){
796 s.push( encodeURIComponent(this.name) + "=" + encodeURIComponent( this.value ) );
799 // Otherwise, assume that it's an object of key/value pairs
801 // Serialize the key/values
803 // If the value is an array then the key names need to be repeated
804 if ( a[j] && a[j].constructor == Array )
805 jQuery.each( a[j], function(){
806 s.push( encodeURIComponent(j) + "=" + encodeURIComponent( this ) );
809 s.push( encodeURIComponent(j) + "=" + encodeURIComponent( a[j] ) );
811 // Return the resulting serialization