* @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 );
* 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>
* @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 )
+ if ( jQuery.isFunction( url ) )
return this.bind("load", url);
callback = callback || function(){};
var type = "GET";
// If the second parameter was provided
- if ( params ) {
+ if ( params )
// If it's a function
- if ( params.constructor == Function ) {
+ if ( jQuery.isFunction( params ) ) {
// We assume that it's the callback
callback = params;
params = null;
params = jQuery.param( params );
type = "POST";
}
- }
var self = this;
data: params,
ifModified: ifModified,
complete: function(res, status){
- 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
- callback.apply( self, [res.responseText, status, res] );
+ // If successful, inject the HTML into all the matched elements
+ if ( status == "success" || !ifModified && status == "notmodified" )
+ self.html(res.responseText);
+
+ // Add delay to account for Safari's delay in globalEval
+ setTimeout(function(){
+ self.each( callback, [res.responseText, status, res] );
+ }, 13);
}
});
return this;
* This will serialize all given elements.
*
* A serialization similar to the form submit of a browser is
- * provided by the form plugin. It also takes multiple-selects
+ * 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&location=Boston
+ * @after name=John&location=Boston
* @desc Serialize a selection of input elements to a string
*
* @name serialize
* @type String
- * @cat AJAX
+ * @cat Ajax
*/
serialize: function() {
return jQuery.param( this );
- },
-
- /**
- * Evaluate all script tags inside this jQuery. If they have a src attribute,
- * the script is loaded, otherwise it's content is evaluated.
- *
- * @name evalScripts
- * @type jQuery
- * @private
- * @cat AJAX
- */
- evalScripts: function() {
- return this.find('script').each(function(){
- if ( this.src )
- jQuery.getScript( this.src );
- else {
- jQuery.globalEval( this.text || this.textContent || this.innerHTML || "" );
- }
- }).end();
}
});
-// If IE is used, create a wrapper for the XMLHttpRequest object
-if ( jQuery.browser.msie && typeof XMLHttpRequest == "undefined" )
- XMLHttpRequest = function(){
- return new ActiveXObject("Microsoft.XMLHTTP");
- };
-
// Attach a bunch of functions for handling common AJAX events
/**
* @name ajaxStart
* @type jQuery
* @param Function callback The function to execute.
- * @cat AJAX
+ * @cat Ajax
*/
/**
* @name ajaxStop
* @type jQuery
* @param Function callback The function to execute.
- * @cat AJAX
+ * @cat Ajax
*/
/**
* @name ajaxComplete
* @type jQuery
* @param Function callback The function to execute.
- * @cat AJAX
+ * @cat Ajax
*/
/**
* @name ajaxSuccess
* @type jQuery
* @param Function callback The function to execute.
- * @cat AJAX
+ * @cat Ajax
*/
/**
* @name ajaxError
* @type jQuery
* @param Function callback The function to execute.
- * @cat AJAX
+ * @cat Ajax
*/
/**
- * Attach a function to be executed before an AJAX request is send.
+ * 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 send.
+ * @desc Show a message before an AJAX request is sent.
*
* @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({
/**
* 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" } );
* @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 Function callback (optional) A function to be executed whenever the data is loaded.
- * @cat AJAX
+ * @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 ( data && data.constructor == Function ) {
+ if ( jQuery.isFunction( data ) ) {
callback = data;
data = null;
}
+
return jQuery.ajax({
+ type: "GET",
url: url,
data: data,
success: callback,
* @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 Function callback (optional) A function to be executed whenever the data is loaded.
- * @cat AJAX
+ * @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
*/
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 evalulate scripts in a global
+ * 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.
*
* @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.
- * @cat AJAX
+ * @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");
* @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 Function callback A function to be executed whenever the data is loaded.
- * @cat AJAX
+ * @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");
* @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 Function callback (optional) A function to be executed whenever the data is loaded.
- * @cat AJAX
+ * @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;
+ data = {};
+ }
+
return jQuery.ajax({
type: "POST",
url: url,
});
},
- // timeout (ms)
- //timeout: 0,
-
/**
- * Set the timeout of all AJAX requests to a specific amount of time.
+ * 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.
*
*
* @name $.ajaxTimeout
* @type undefined
- * @param Number time How long before an AJAX request times out.
- * @cat AJAX
+ * @param Number time How long before an AJAX request times out, in milliseconds.
+ * @cat Ajax
*/
- ajaxTimeout: function(timeout) {
+ ajaxTimeout: function( timeout ) {
jQuery.ajaxSettings.timeout = timeout;
},
* 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: {
timeout: 0,
contentType: "application/x-www-form-urlencoded",
processData: true,
- async: true
+ async: true,
+ data: null
},
// Last-Modified header cache for next request
* Load a remote page using an HTTP request.
*
* This is jQuery's low-level AJAX implementation. See $.get, $.post etc. for
- * higher-level abstractions.
+ * 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: Make sure the server sends the right mimetype (eg. xml as
- * "text/xml"). Sending the wrong mimetype will get you into serious
- * trouble that jQuery can't solve.
+ * '''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):
*
* 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 to override global timeout, eg. to give a
+ * (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.
*
* 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 send asynchronous (set to true).
+ * (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
* async: false
* }).responseText;
* @desc Loads data synchronously. Blocks the browser while the requests is active.
- * It is better to block user interaction with others means when synchronization is
- * necessary, instead to block the complete browser.
+ * It is better to block user interaction by other means when synchronization is
+ * necessary.
*
* @example var xmlDocument = [create xml document];
* $.ajax({
*
* @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
- s = jQuery.extend({}, jQuery.ajaxSettings, s);
+ // Extend the settings, but re-extend 's' so that it can be
+ // checked again later (in the test suite, specifically)
+ s = jQuery.extend(s, jQuery.extend({}, jQuery.ajaxSettings, s));
// if data available
if ( s.data ) {
// convert data if not already a string
- if (s.processData && typeof s.data != 'string')
- s.data = jQuery.param(s.data);
+ if ( s.processData && typeof s.data != "string" )
+ s.data = jQuery.param(s.data);
+
// append data to url for get requests
- if( s.type.toLowerCase() == "get" )
+ if ( s.type.toLowerCase() == "get" ) {
// "?" + data or "&" + data (in case there are already params)
- s.url += ((s.url.indexOf("?") > -1) ? "&" : "?") + s.data;
+ s.url += (s.url.indexOf("?") > -1 ? "&" : "?") + s.data;
+
+ // IE likes to send both get and post data, prevent this
+ s.data = null;
+ }
}
// Watch for a new set of requests
var requestDone = false;
- // Create the request object
- var xml = new XMLHttpRequest();
+ // Create the request object; Microsoft failed to properly
+ // implement the XMLHttpRequest in IE7, so we use the ActiveXObject when it is available
+ var xml = window.ActiveXObject ? new ActiveXObject("Microsoft.XMLHTTP") : new XMLHttpRequest();
// Open the socket
xml.open(s.type, s.url, s.async);
// 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
- if ( xml.overrideMimeType )
- xml.setRequestHeader("Connection", "close");
-
// 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
var onreadystatechange = function(isTimeout){
// The transfer is complete and the data is available, or the request timed out
- if ( xml && (xml.readyState == 4 || isTimeout == "timeout") ) {
+ if ( !requestDone && xml && (xml.readyState == 4 || isTimeout == "timeout") ) {
requestDone = true;
- var status;
- try {
- status = jQuery.httpSuccess( xml ) && isTimeout != "timeout" ?
- s.ifModified && jQuery.httpNotModified( xml, s.url ) ? "notmodified" : "success" : "error";
- // Make sure that the request was successful or notmodified
- if ( status != "error" ) {
- // Cache Last-Modified header, if ifModified mode.
- var modRes;
- try {
- modRes = xml.getResponseHeader("Last-Modified");
- } catch(e) {} // swallow exception thrown by FF if header is not available
-
- if ( s.ifModified && modRes )
- jQuery.lastModified[s.url] = modRes;
-
+
+ // clear poll interval
+ if (ival) {
+ clearInterval(ival);
+ ival = null;
+ }
+
+ var status = isTimeout == "timeout" && "timeout" ||
+ !jQuery.httpSuccess( xml ) && "error" ||
+ s.ifModified && jQuery.httpNotModified( xml, s.url ) && "notmodified" ||
+ "success";
+
+ if ( status == "success" ) {
+ // Watch for, and catch, XML document parse errors
+ try {
// process the data (runs the xml through httpData regardless of callback)
var data = jQuery.httpData( xml, s.dataType );
-
- // If a local callback was specified, fire it and pass it the data
- if ( s.success )
- s.success( data, status );
-
- // Fire the global callback
- if( s.global )
- jQuery.event.trigger( "ajaxSuccess", [xml, s] );
- } else {
- jQuery.handleError(s, xml, status);
+ } catch(e) {
+ status = "parsererror";
}
- } catch(e) {
- status = "error";
- jQuery.handleError(s, xml, status, e);
}
+ // Make sure that the request was successful or notmodified
+ if ( status == "success" ) {
+ // Cache Last-Modified header, if ifModified mode.
+ var modRes;
+ try {
+ modRes = xml.getResponseHeader("Last-Modified");
+ } catch(e) {} // swallow exception thrown by FF if header is not available
+
+ if ( s.ifModified && modRes )
+ jQuery.lastModified[s.url] = modRes;
+
+ // If a local callback was specified, fire it and pass it the data
+ if ( s.success )
+ s.success( data, status );
+
+ // Fire the global callback
+ if ( s.global )
+ jQuery.event.trigger( "ajaxSuccess", [xml, s] );
+ } else
+ jQuery.handleError(s, xml, status);
+
// The request was completed
if( s.global )
jQuery.event.trigger( "ajaxComplete", [xml, s] );
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(){};
- xml = null;
+ if(s.async)
+ xml = null;
}
};
- xml.onreadystatechange = onreadystatechange;
-
- // Timeout checker
- if(s.timeout > 0)
- setTimeout(function(){
- // Check to see if the request is still happening
- if(xml) {
- // Cancel the request
- xml.abort();
-
- if( !requestDone )
- onreadystatechange( "timeout" );
- }
- }, s.timeout);
+
+ if ( s.async ) {
+ // don't attach the handler to the request, just poll it instead
+ var ival = setInterval(onreadystatechange, 13);
+
+ // Timeout checker
+ if ( s.timeout > 0 )
+ setTimeout(function(){
+ // Check to see if the request is still happening
+ if ( xml ) {
+ // Cancel the request
+ xml.abort();
+
+ if( !requestDone )
+ onreadystatechange( "timeout" );
+ }
+ }, s.timeout);
+ }
- // save non-leaking reference
- var xml2 = xml;
-
// Send the data
try {
- xml2.send(s.data);
+ xml.send(s.data);
} catch(e) {
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;
+ return xml;
},
- 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] );
},
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 ||
},
// Determines if an XMLHttpRequest returns NotModified
- httpNotModified: function(xml, url) {
+ httpNotModified: function( xml, url ) {
try {
var xmlRes = xml.getResponseHeader("Last-Modified");
* (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;
+ var xml = type == "xml" || !type && ct && ct.indexOf("xml") >= 0;
+ data = xml ? r.responseXML : r.responseText;
+
+ if ( xml && data.documentElement.tagName == "parsererror" )
+ throw "parsererror";
// 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 );
-
- // evaluate scripts within html
- if ( type == "html" ) jQuery("<div>").html(data).evalScripts();
+ if ( type == "json" )
+ data = eval("(" + data + ")");
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 ) );
+ jQuery.each( a, function(){
+ s.push( encodeURIComponent(this.name) + "=" + encodeURIComponent( this.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++) {
- s.push( j + "=" + encodeURIComponent( a[j][k] ) );
- }
- } else {
- s.push( j + "=" + encodeURIComponent( a[j] ) );
- }
- }
- }
+ if ( a[j] && a[j].constructor == Array )
+ jQuery.each( a[j], function(){
+ s.push( encodeURIComponent(j) + "=" + encodeURIComponent( this ) );
+ });
+ else
+ s.push( encodeURIComponent(j) + "=" + encodeURIComponent( a[j] ) );
// Return the resulting serialization
return s.join("&");
- },
-
- // evalulates a script in global context
- // not reliable for safari
- globalEval: function(data) {
- if (window.execScript)
- window.execScript( data );
- else if(jQuery.browser.safari)
- // safari doesn't provide a synchronous global eval
- window.setTimeout( data, 0 );
- else
- eval.call( window, data );
}
});
git.asbjorn.biz / jquery.git / blobdiff