-// AJAX Plugin
-// Docs Here:
-// http://jquery.com/docs/ajax/
+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 Hash params A set of 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
- */
-jQuery.fn.loadIfModified = function( url, params, callback ) {
- this.load( url, params, callback, 1 );
-};
-
-/**
- * Load HTML from a remote file and inject it into the DOM.
- *
- * @example $("#feeds").load("feeds.html")
- * @before <div id="feeds"></div>
- * @result <div id="feeds"><b>45</b> feeds found.</div>
- *
- * @name load
- * @type jQuery
- * @param String url The URL of the HTML file to load.
- * @param Hash params A set of 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
- */
-jQuery.fn.load = function( url, params, callback, ifModified ) {
- if ( url.constructor == Function )
- return this.bind("load", url);
-
- callback = callback || function(){};
-
- // Default to a GET request
- var type = "GET";
+ /**
+ * 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 Hash params A set of 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
+ */
+ loadIfModified: function( url, params, callback ) {
+ this.load( url, params, callback, 1 );
+ },
- // If the second parameter was provided
- if ( params ) {
- // If it's a function
- if ( params.constructor == Function ) {
- // We assume that it's the callback
- callback = params;
- params = null;
-
- // Otherwise, build a param string
- } else {
- params = jQuery.param( params );
- type = "POST";
- }
- }
+ /**
+ * Load HTML from a remote file and inject it into the DOM.
+ *
+ * @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",
+ * {test: true},
+ * function() { alert("load is done"); }
+ * );
+ * @desc Same as above, but with an additional parameter
+ * and a callback that is executed when the data was loaded.
+ *
+ * @test stop();
+ * $('#first').load("data/name.php", function() {
+ * ok( $('#first').text() == 'ERROR', 'Check if content was injected into the DOM' );
+ * start();
+ * });
+ *
+ * @test stop(); // check if load can be called with only url
+ * $('#first').load("data/name.php");
+ * setTimeout(function() {
+ * ok( $('#first').text() == 'ERROR', 'Check if load works without callback');
+ * start();
+ * }, 100);
+ *
+ * @name load
+ * @type jQuery
+ * @param String url The URL of the HTML file to load.
+ * @param Hash params A set of 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
+ */
+ load: function( url, params, callback, ifModified ) {
+ if ( url.constructor == Function )
+ return this.bind("load", url);
- var self = this;
+ callback = callback || function(){};
- // Request the remote document
- jQuery.ajax( type, url, params,function(res, status){
+ // Default to a GET request
+ var type = "GET";
+
+ // If the second parameter was provided
+ if ( params ) {
+ // If it's a function
+ if ( params.constructor == Function ) {
+ // We assume that it's the callback
+ callback = params;
+ params = null;
+
+ // Otherwise, build a param string
+ } else {
+ params = jQuery.param( params );
+ type = "POST";
+ }
+ }
+
+ var self = this;
- if ( status == "success" || !ifModified && status == "notmodified" ) {
- // Inject the HTML into all the matched elements
- self.html(res.responseText).each( callback, [res.responseText, status] );
+ // Request the remote document
+ jQuery.ajax( type, url, params,function(res, status){
- // Execute all the scripts inside of the newly-injected HTML
- $("script", self).each(function(){
- if ( this.src )
- $.getScript( this.src );
- else
- eval.call( window, this.text || this.textContent || this.innerHTML || "" );
- });
- } else
- callback.apply( self, [res.responseText, status] );
-
- }, ifModified);
+ if ( status == "success" || !ifModified && status == "notmodified" ) {
+ // Inject the HTML into all the matched elements
+ self.html(res.responseText).each( callback, [res.responseText, status] );
+
+ // Execute all the scripts inside of the newly-injected HTML
+ jQuery("script", self).each(function(){
+ if ( this.src )
+ jQuery.getScript( this.src );
+ else
+ eval.call( window, this.text || this.textContent || this.innerHTML || "" );
+ });
+ } else
+ callback.apply( self, [res.responseText, status] );
- return this;
-};
+ }, ifModified);
+
+ return this;
+ },
-/**
- * A function for serializing a set of input elements into
- * a string of data.
- *
- * @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
- * @desc Serialize a selection of input elements to a string
- *
- * @name serialize
- * @type String
- * @cat AJAX
- */
-jQuery.fn.serialize = function(){
- return $.param( this );
-};
+ /**
+ * Serializes a set of input elements into a string of data.
+ * This will serialize all given elements. If you need
+ * serialization similar to the form submit of a browser,
+ * you should use the form plugin. This is also true for
+ * selects with multiple attribute set, only a single option
+ * is serialized.
+ *
+ * @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
+ * @desc Serialize a selection of input elements to a string
+ *
+ * @test var data = $(':input').not('button').serialize();
+ * // ignore button, IE takes text content as value, not relevant for this test
+ * ok( data == 'action=Test&text2=Test&radio1=on&radio2=on&check=on&=on&hidden=&foo[bar]=&name=name&=foobar&select1=&select2=3&select3=1', 'Check form serialization as query string' );
+ *
+ * @name serialize
+ * @type String
+ * @cat AJAX
+ */
+ serialize: function() {
+ return jQuery.param( this );
+ }
+
+});
// If IE is used, create a wrapper for the XMLHttpRequest object
if ( jQuery.browser.msie && typeof XMLHttpRequest == "undefined" )
* @param Function callback The function to execute.
* @cat AJAX
*/
+
+/**
+ * @test stop(); var counter = { complete: 0, success: 0, error: 0 };
+ * var success = function() { counter.success++ };
+ * var error = function() { counter.error++ };
+ * var complete = function() { counter.complete++ };
+ * $('#foo').ajaxStart(complete).ajaxStop(complete).ajaxComplete(complete).ajaxError(error).ajaxSuccess(success);
+ * // start with successful test
+ * $.ajax({url: "data/name.php", success: success, error: error, complete: function() {
+ * ok( counter.error == 0, 'Check succesful request' );
+ * ok( counter.success == 2, 'Check succesful request' );
+ * ok( counter.complete == 3, 'Check succesful request' );
+ * counter.error = 0; counter.success = 0; counter.complete = 0;
+ * $.ajaxTimeout(500);
+ * $.ajax({url: "data/name.php?wait=5", success: success, error: error, complete: function() {
+ * ok( counter.error == 2, 'Check failed request' );
+ * ok( counter.success == 0, 'Check failed request' );
+ * ok( counter.complete == 3, 'Check failed request' );
+ * start();
+ * }});
+ * }});
+
+ * @test stop(); var counter = { complete: 0, success: 0, error: 0 };
+ * counter.error = 0; counter.success = 0; counter.complete = 0;
+ * var success = function() { counter.success++ };
+ * var error = function() { counter.error++ };
+ * $.ajaxTimeout(0);
+ * $.ajax({url: "data/name.php", global: false, success: success, error: error, complete: function() {
+ * ok( counter.error == 0, 'Check sucesful request without globals' );
+ * ok( counter.success == 1, 'Check sucesful request without globals' );
+ * ok( counter.complete == 0, 'Check sucesful request without globals' );
+ * counter.error = 0; counter.success = 0; counter.complete = 0;
+ * $.ajaxTimeout(500);
+ * $.ajax({url: "data/name.php?wait=5", global: false, success: success, error: error, complete: function() {
+ * ok( counter.error == 1, 'Check failed request without globals' );
+ * ok( counter.success == 0, 'Check failed request without globals' );
+ * ok( counter.complete == 0, 'Check failed request without globals' );
+ * start();
+ * }});
+ * }});
+ *
+ * @name ajaxHandlersTesting
+ * @private
+ */
+
new function(){
var e = "ajaxStart,ajaxStop,ajaxComplete,ajaxError,ajaxSuccess".split(",");
* }
* )
*
- * @test stop();
- * $.get("data/dashboard.xml", function(xml) {
- * var content = [];
- * $('tab', xml).each(function(k) {
- * // workaround for IE needed here, $(this).text() throws an error
- * // content[k] = $.trim(this.firstChild.data) || $(this).text();
- * content[k] = $(this).text();
- * });
- * ok( content[0] && content[0].match(/blabla/), 'Check first tab' );
- * ok( content[1] && content[1].match(/blublu/), 'Check second tab' );
- * start();
- * });
- *
* @name $.get
* @type jQuery
* @param String url The URL of the page to load.
data = null;
}
- if ( data ) url += "?" + jQuery.param(data);
+ // append ? + data or & + data, in case there are already params
+ if ( data ) url += ((url.indexOf("?") > -1) ? "&" : "?") + jQuery.param(data);
// Build and start the HTTP Request
jQuery.ajax( "GET", url, null, function(r, status) {
* }
* )
*
+ * @test stop();
+ * $.getIfModified("data/name.php", function(msg) {
+ * ok( msg == 'ERROR', 'Check ifModified' );
+ * start();
+ * });
+ *
* @name $.getIfModified
* @type jQuery
* @param String url The URL of the page to load.
* alert("Script loaded and executed.");
* })
*
+ * @test stop();
+ * $.getScript("data/test.js", function() {
+ * ok( foobar == "bar", 'Check if script was evaluated' );
+ * start();
+ * });
*
* @name $.getScript
* @type jQuery
* @param Function callback A function to be executed whenever the data is loaded.
* @cat AJAX
*/
- getScript: function( url, data, callback ) {
- jQuery.get(url, data, callback, "script");
+ getScript: function( url, callback ) {
+ jQuery.get(url, callback, "script");
},
/**
* }
* )
*
+ * @test stop();
+ * $.getJSON("data/json.php", {json: "array"}, function(json) {
+ * ok( json[0].name == 'John', 'Check JSON: first, name' );
+ * ok( json[0].age == 21, 'Check JSON: first, age' );
+ * ok( json[1].name == 'Peter', 'Check JSON: second, name' );
+ * ok( json[1].age == 25, 'Check JSON: second, age' );
+ * start();
+ * });
+ * @test stop();
+ * $.getJSON("data/json.php", function(json) {
+ * ok( json.data.lang == 'en', 'Check JSON: lang' );
+ * ok( json.data.length == 25, 'Check JSON: length' );
+ * start();
+ * });
+ *
* @name $.getJSON
* @type jQuery
* @param String url The URL of the page to load.
* @cat AJAX
*/
getJSON: function( url, data, callback ) {
- jQuery.get(url, data, callback, "json");
+ if(callback)
+ jQuery.get(url, data, callback, "json");
+ else {
+ jQuery.get(url, data, "json");
+ }
},
/**
* }
* )
*
+ * @test stop();
+ * $.post("data/name.php", {xml: "5-2"}, function(xml){
+ * $('math', xml).each(function() {
+ * ok( $('calculation', this).text() == '5-2', 'Check for XML' );
+ * ok( $('result', this).text() == '3', 'Check for XML' );
+ * });
+ * start();
+ * });
+ *
* @name $.post
* @type jQuery
* @param String url The URL of the page to load.
* @example $.ajaxTimeout( 5000 );
* @desc Make all AJAX requests timeout after 5 seconds.
*
+ * @test stop();
+ * var passed = 0;
+ * var timeout;
+ * $.ajaxTimeout(1000);
+ * var pass = function() {
+ * passed++;
+ * if(passed == 2) {
+ * ok( true, 'Check local and global callbacks after timeout' );
+ * clearTimeout(timeout);
+ * $('#main').unbind("ajaxError");
+ * start();
+ * }
+ * };
+ * var fail = function() {
+ * ok( false, 'Check for timeout failed' );
+ * start();
+ * };
+ * timeout = setTimeout(fail, 1500);
+ * $('#main').ajaxError(pass);
+ * $.ajax({
+ * type: "GET",
+ * url: "data/name.php?wait=5",
+ * error: pass,
+ * success: fail
+ * });
+ *
+ * @test stop(); $.ajaxTimeout(50);
+ * $.ajax({
+ * type: "GET",
+ * timeout: 5000,
+ * url: "data/name.php?wait=1",
+ * error: function() {
+ * ok( false, 'Check for local timeout failed' );
+ * start();
+ * },
+ * success: function() {
+ * ok( true, 'Check for local timeout' );
+ * start();
+ * }
+ * });
+ * // reset timeout
+ * $.ajaxTimeout(0);
+ *
+ *
* @name $.ajaxTimeout
* @type jQuery
* @param Number time How long before an AJAX request times out.
* (String) dataType - The type of data that you're expecting back from
* the server (e.g. "xml", "html", "script", or "json").
*
+ * (Boolean) ifModified - Allow the request to be successful only if the
+ * response has changed since the last request, default is false, ignoring
+ * the Last-Modified 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,
+ * see $.ajaxTimeout
+ *
+ * (Boolean) global - Wheather to trigger global AJAX event handlers for
+ * this request, default is true. Set to true 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 two arguments: The XMLHttpRequest object and a
* string describing the type of error that occurred.
* });
* @desc Save some data to the server and notify the user once its complete.
*
+ * @test stop();
+ * $.ajax({
+ * type: "GET",
+ * url: "data/name.php?name=foo",
+ * success: function(msg){
+ * ok( msg == 'bar', 'Check for GET' );
+ * start();
+ * }
+ * });
+ *
+ * @test stop();
+ * $.ajax({
+ * type: "POST",
+ * url: "data/name.php",
+ * data: "name=peter",
+ * success: function(msg){
+ * ok( msg == 'pan', 'Check for POST' );
+ * start();
+ * }
+ * });
+ *
* @name $.ajax
* @type jQuery
* @param Hash prop A set of properties to initialize the request with.
var success = type.success;
var error = type.error;
var dataType = type.dataType;
+ var global = typeof type.global == "boolean" ? type.global : true;
+ var timeout = typeof type.timeout == "number" ? type.timeout : jQuery.timeout;
+ var ifModified = type.ifModified || false;
data = type.data;
url = type.url;
type = type.type;
}
// Watch for a new set of requests
- if ( ! jQuery.active++ )
+ if ( global && ! jQuery.active++ )
jQuery.event.trigger( "ajaxStart" );
var requestDone = false;
xml.setRequestHeader("If-Modified-Since",
jQuery.lastModified[url] || "Thu, 01 Jan 1970 00:00:00 GMT" );
- // Set header so calling script knows that it's an XMLHttpRequest
+ // Set header so the called script knows that it's an XMLHttpRequest
xml.setRequestHeader("X-Requested-With", "XMLHttpRequest");
// Make sure the browser sends the right content length
// Make sure that the request was successful or notmodified
if ( status != "error" ) {
// Cache Last-Modified header, if ifModified mode.
- var modRes = xml.getResponseHeader("Last-Modified");
- if ( ifModified && modRes ) jQuery.lastModified[url] = modRes;
+ var modRes;
+ try {
+ modRes = xml.getResponseHeader("Last-Modified");
+ } catch(e) {} // swallow exception thrown by FF if header is not available
+
+ if ( ifModified && modRes )
+ jQuery.lastModified[url] = modRes;
// If a local callback was specified, fire it
if ( success )
success( jQuery.httpData( xml, dataType ), status );
// Fire the global callback
- jQuery.event.trigger( "ajaxSuccess" );
+ if( global )
+ jQuery.event.trigger( "ajaxSuccess" );
// Otherwise, the request was not successful
} else {
if ( error ) error( xml, status );
// Fire the global callback
- jQuery.event.trigger( "ajaxError" );
+ if( global )
+ jQuery.event.trigger( "ajaxError" );
}
// The request was completed
- jQuery.event.trigger( "ajaxComplete" );
+ if( global )
+ jQuery.event.trigger( "ajaxComplete" );
// Handle the global AJAX counter
- if ( ! --jQuery.active )
+ if ( global && ! --jQuery.active )
jQuery.event.trigger( "ajaxStop" );
// Process result
xml.onreadystatechange = onreadystatechange;
// Timeout checker
- if(jQuery.timeout > 0)
+ if(timeout > 0)
setTimeout(function(){
// Check to see if the request is still happening
if (xml) {
// Clear from memory
xml = null;
}
- }, jQuery.timeout);
+ }, timeout);
// Send the data
xml.send(data);
git.asbjorn.biz / jquery.git / blobdiff