JavaScript: Form Validation using Ajax
This article follows on from Web Services using XMLHttpRequest (Ajax) and demonstrates the usage of the AjaxRequest.js class for validating online forms.
Real-time Form Validation using Ajax
This example uses the JavaScript XMLHttpRequest object and PHP server-side scripting to check that the Email address entered is valid (at least that it matches a particular regular expression) and that the Age lies between 16 and 100. As the form is completed, the values are passed immediately to the server as POST variables, the server calculates a result, passing back an XML file which is then parsed to trigger various actions on the page as you will see.
If you enter an invalid Email address, or a value for Age outside the specified range, a red warning message will appear and form will not be able to be submitted. Similarly, when you enter a valid value the message will be green. When all fields have been validated the form will be able to be submitted.
Samples of the XML files returned in each case can be found below. These are generated by PHP, but another server-side scripting language would also work.
The onSubmit handler for the form requires also that a value be entered in all fields before the form can be submitted.
The Email field input is tested using Ajax when the onChange event is triggered (when the input value changes and the focus moves to another element). We could have also used onBlur but that's more resource-intensive as it's called even when the value hasn't been modified.
The Age field is checked whenever it's onKeyUp event is triggered - every time a key is pressed and released while the focus is on that element.
Generally onChange is the best option when validating forms, or onKeyUp/Down if you want to control the input character by character.
Markup of the HTML Form and JavaScript
The markup for the HTML form used in the example is as follows:
<form method="POST" action="non-Ajax form handler" onsubmit="
if(this.name.value == '') {
alert('Please enter your Name in the form');
this.name.focus();
return false;
}
if(this.email.value == '' || !this.valid_email.checked) {
alert('Please enter a valid Email address');
this.email.focus();
return false;
}
if(this.age.value == '' || !this.valid_age.checked) {
alert('Please enter an Age between 16 and 100');
this.age.focus();
return false;
}
alert('Success! The form has been completed, validated and is ready to be submitted...');
return false;
">
<fieldset>
<legend>Ajax Form Validation Demo</legend>
<p>Name: <input type="text" size="32" name="name" onchange="this.value = this.value.replace(/^\s+|\s+$/g, ''); valid_name.checked = this.value;">
<input type="checkbox" disabled name="valid_name" onclick="return false;"></p>
<p>Email: <input type="text" size="32" id="email" name="email" onchange="if(this.value != '') callAjax('checkEmail', this.value, this.id);">
<input id="valid_email" type="checkbox" disabled name="valid_email" onclick="return false;"></p>
<div id="rsp_email" style="font-size: 11px;"><!-- --></div>
<p>Age: <input type="text" size="4" id="age" name="age" onkeyup="if(this.value != '') callAjax('checkAge', this.value, this.id);"> <small>(between 16 and 100)</small>
<input id="valid_age" type="checkbox" disabled name="valid_age" onclick="return false;"></p>
<div id="rsp_age" style="font-size: 11px;"><!-- --></div>
<p><input type="submit"></p>
</fieldset>
</form>
Within this code you can see that the Email input field is marked up as follows:
<input type="text" id="email" name="email"
onchange="if(this.value != '') callAjax('checkEmail', this.value, this.id);">
<input id="valid_email" type="checkbox" disabled name="valid_email" onclick="return false;">
<div id="rsp_email"><!-- --></div>
We assign an id to the input box ('email'), to the associated checkbox ('valid_email) and to the DIV where the feedback text is to appear ('rsp_email'). These elements can then be referenced in the XML file that is returned by the Ajax call.
The 'empty comment" in the DIV is just a place-holder - required in some older browsers when a DIV is empty, but needs later to be referenced by a script.
When we call the callAjax() function we pass three parameters: the method (in this case 'checkEmail' or 'checkAge') to use for testing, the value to test, and the id of the input field (target). The target value is also used to work out the id of the relevant checkbox and the DIV that will display feedback.
<script type="text/javascript" src="ajaxrequest.js"></script>
<script type="text/javascript">
function callAjax(method, value, target)
{
if(encodeURIComponent) {
var req = new AjaxRequest();
var params = "method=" + method + "&value=" + encodeURIComponent(value) + "&target=" + target;
req.setMethod("POST");
req.loadXMLDoc('/scripts/validate.php', params);
}
}
</script>
Note: we're using here the ajaxrequest.js rather than the xmlhttp.js library. This is to avoid problems caused by multiple requests and the race condition and so we can set the request method to POST.
Sample Responses
The PHP script that does the processing in this case, /scripts/validate.php accepts the three variables (method, value, target) in POST format and uses them to generate an appropriate response in XML format. We won't go into the details of how the script actually does this as that's been covered elsewhere (see links below).
Example 1
For an Age input value of 12 the validation script returns the following XML document (the commands represented by the XML appear on the right):
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response>
<command method="setcontent">
<target>rsp_age</target>
<content>Sorry, 12 is too young</content>
</command>
<command method="setstyle">
<target>rsp_age</target>
<property>color</property>
<value>red</value>
</command>
<command method="setproperty">
<target>valid_age</target>
<property>checked</property>
<value>false</value>
</command>
<command method="focus">
<target>age</target>
</command>
</response>
The commands executed then in this case are as follows:
- Set content of the div rsp_age to "Sorry, 12 is too young";
- Set color of the div rsp_age to "red";
- Set the checked property of the checkbox for the age to false;
- Set the focus back to the age input.
Example 2
For an Age input value of 30 (or any number between 16 and 100) the XML returned is similar, but displays a positive message in green and marks the age input as valid using the checkbox.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response>
<command method="setcontent">
<target>rsp_age</target>
<content>30 is just right!</content>
</command>
<command method="setstyle">
<target>rsp_age</target>
<property>color</property>
<value>green</value>
</command>
<command method="setproperty">
<target>valid_age</target>
<property>checked</property>
<value>true</value>
</command>
</response>
The commands executed are as follows:
- Set content of the div rsp_age to "30 is just right!";
- Set color of the div rsp_age to "green";
- Set the checked property of the checkbox for age to true.
As discussed previously, all target values need to match ids of elements in the HTML document. See the article Web Services using XMLHttpRequest (Ajax) for details on all avaiable commands and their parameters.
For assistance in generating a valid XML response using PHP, read the article Generating an XML Response for Ajax Applications where you'll find a PHP class that complements the preceding JavaScript functions.
The validate.php script
A couple of people have already asked for a copy of the validate.php script referred to in these examples.
My feeling is that this article already describes how to generate the XMLHttpRequest (Ajax) request, passing GET or POST variables to a server-side script using our JavaScript class, and the related article referred to above provides a complementary PHP class for generating XML responses, so really all that's left is basic programming to process the incoming variables and generate the relevant XML response.
For those having trouble getting started, here's a walk-through:
1) check that the three $_POST variables exist;
2) if $method == 'checkAge' compare $value to 16 and 100;
3) if $method == 'checkEmail' check that $value is a valid email format;
4) generate an XML response to set the response text/style and checkbox state.
And here's some of the code that generates the XML response:
<?PHP
include "class.xmlresponse.php";
# insert code here to:
# - receive and process the $_POST variables: $method, $value and $target
# - check which method is required and set the $retval and $passed variables accordingly
# - the following code will then generate the XML response
$xml = new xmlResponse();
$xml->start();
# set the response text
$xml->command('setcontent',
array('target' => "rsp_$target", 'content' => htmlentities($retval))
);
if($passed) {
# set the text colour to green and the checkbox to checked
$xml->command('setstyle',
array('target' => "rsp_$target", 'property' => 'color', 'value' => 'green')
);
$xml->command('setproperty',
array('target' => "valid_$target", 'property' => 'checked', 'value' => 'true')
);
} else {
# set the text colour to red and the checkbox to unchecked
$xml->command('setstyle',
array('target' => "rsp_$target", 'property' => 'color', 'value' => 'red')
);
$xml->command('setproperty',
array('target' => "valid_$target", 'property' => 'checked', 'value' => 'false')
);
$xml->command('focus', array('target' => $target));
}
$xml->end();
?>
Hopefully that solves some of the problems people are having understanding and implementing the code.
Putting it all togetherA few people have commented that this is all a bit confusing when it comes to implementing it on your own website. That's hardly surprising given the mix of technologies so I've created a graphic (below) showing how the different files fit together and what goes where:
You need to create two files. The first is an HTML file containing the FORM which needs to be validated, and some JavaScript which can be called from different fields in the form using event handlers (e.g. 'onclick', 'onchange', ...).
The JavaScript code then passes data to the second file which is your validation script. In this case it'ss a PHP file, but another server-side scripting language would work just as well. The validation script returns XML data which is then processed and applied to the form to provide feedback to the user.
The other two files (represented in the graphic in green) can be downloaded or copied from this site and included from your files as indicated.
Pros and Cons of using Ajax?
In this particular example, and with form validation in general, the advantage over other techniques (JavaScript and/or server-side validation) is that we can make use of server-side technologies to perform more complex validation and present real-time feedback to the user without reloading the page.
The drawback is that Ajax works only in the most recent browsers, and requires that JavaScript (and sometimes ActiveX as well) be enabled. Another problem is that unless you put a lot of effort into building a complex framework you could end up with three sets of code: one for client-side validation, one for Ajax validation and one for server-side validation which is always necessary in any case.
If you want to do a calculation that can only be done server-side (eg. checking that a username is unique in your database) or you want to update the DOM with data from another script or site then Ajax is the perfect tool. But you still have to cater for (or choose to exclude) non-compatible browsers.
Related Articles
- Web Services using XMLHttpRequest (Ajax)
- Avoiding the Race Condition with Ajax
- Form Validation using Ajax
- Recording Outbound Links using Ajax
- Using XMLHttpRequest to log JavaScript errors
- Making sure form values are unique using Ajax
Feedback and Questions
9 July 2007: Eddie Chin (Pictage) says:
What would happen if you entered valid data in every input field other than the email address, then lastly input an invalid email address and hit the submit button immediately afterwards. Won't you have a race condition between the ajax call and the form submit?
That's correct, using Ajax is not a substitute for properly validating the data after the form is submitted. The reason for using Ajax is to provide real-time feedback to the user, making them less likely to have problems when they do submit the form.
15 February 2008: Ratha says:
You should packed the file for download. The code is so confusing.
There are plenty of sites you can go to to 'download' code. This isn't one of them. If you're having trouble, ask a question and I'll try to explain what's going on. I've added a new section now, "Putting it all together", with a diagram which might also help.
24 December 2008: Michael Christopher says:
Thanks for not supplying all the code. I learned today using your example.
16 April 2009: Aschwin Versteegden (Open University Netherlands) says:
Although i am not using PHP but JSP instead this page helped me a great deal. The Javascript you use is very nice. Thanx a lot!
