Pro PHP and jQuery by Jason Lengstorf.pdf - Computer Science ...

CHAPTER 2 ■ COMMON JQUERY ACTIONS AND METHODS
Quite a few settings are available for $.ajax(), not all of which are covered here or used in this book.
See http://api.jquery.com/jQuery.ajax for a full list of available settings. The most common follow:
• data: This describes any data to be sent to the remote script, either as a query
string (key1=val1&key2=val2) or as JSON ({"key1":"val1","key2":"val2"}).
• dataFilter(data, type): This callback allows prefiltering of data and is great for
sanitizing data as it comes from the remote script.
• dataType: This described the type of data expected from the request. jQuery makes
an intelligent guess if this is left undefined. The available types are "xml", "html",
"script", "json", "jsonp", and "text".
• error(XMLHttpRequest, textStatus, errorThrown): This callback is to be executed
in the event of a request error. The XMLHttpRequest object, a string communicating
the status of the request, and an error code are passed as arguments.
• success(data, textStatus, XMLHttpRequest): This callback is to be executed if the
request completes successfully. The data returned from the remote script, a string
communicating the status of the request, and the XMLHttpRequest object are
passed as arguments.
• type: This is the type of request to send. The default is GET, but POST is also
available. PUT and DELETE can be used but may not work properly in all browsers.
• url: This is the URL to which the request is to be sent.
To send a basic POST request to your sample script and load the results into the paragraph with ID
bar, you would use the following:
$.ajax({
"type":"POST",
"url":"ajax.php",
"data":"var1=val1&var2=val2",
"success":function(data){
$("#bar")
.css("background","yellow")
.html(data);
}
});
After executing this code, the contents of the paragraph are replaced with the loaded information
(see Figure 2-22).
79