Actions

Difference between revisions of "Client-side form validation"

From Joomla! Documentation

(Creation)
 
m (Adding link to difference client and server)
(17 intermediate revisions by 13 users not shown)
Line 1: Line 1:
== Intro ==
+
==Introduction==
  
Joomla 1.5 contains a behavior '''JHTMLBehavior::formvalidation()''' which enables the script '''validate.js'''.
+
Joomla 1.5 and later versions contain a behavior, which allows your form and its elements to be validated at client side, i.e., before it is submitted to the server. The behavior enables the script '''validate.js''' and uses [http://mootools.net MooTools].
It uses '''mootools''' (I think) and allows your form and its elements to be validated. The only thing you have to do is set the '''classes''' of the form to specified meanings such as
+
 
 +
Note: Validate.js is a validation system different from the one provided by [http://mootools.net/docs/more/Forms/Form.Validator MooTools].
 +
 
 +
==Enable the Validation==
 +
 
 +
Add a behavior to your form view template. For Joomla versions before 1.5.2:
 +
<source lang="php">
 +
JHTMLBehavior::formvalidation();
 +
</source>
 +
For versions from 1.5.2:
 +
<source lang="php">
 +
JHTML::_('behavior.formvalidation');
 +
</source>
 +
 
 +
Add the form-validate class to your form
 +
<source lang="html4strict">
 +
<form class="form-validate"> ... </form>
 +
</source>
 +
 
 +
Add a validation class to your form field declarations. Joomla adds a ''blur'' handler to validate the form field when the user moves away from the field.
 +
<source lang="xml">
 +
<field name="email" type="text" class="required validate-email" size="30" />
 +
 
 +
//For radios make sure the class is applied to the options:
 +
 +
<field name="ThisorThat" type="radio" label="Please say if it was full-time or the part-time equivalent?" >
 +
<option value="This" class="required">This</option>
 +
<option value="That" class="required">That</option>
 +
</field>
 +
</source>
 +
 
 +
The following classes are available:
 
* required
 
* required
* username
+
* validate-username
* password
+
* validate-password
* numeric
+
* validate-numeric
* email
+
* validate-email
 +
* validate-[custom] -> custom defined - see below
 +
 
 +
Note: Joomla 2.5 translates the ''required'' field attribute into a ''required'' class value.
 +
 
 +
Finally, add the ''validate'' class to your submit button. This will cause an ''onclick'' handler to be added that validates the whole form. The form will only be submitted if it is valid.
 +
<source lang="html4strict">
 +
<button type="submit" class="validate">Submit form</button>
 +
</source>
 +
 
 +
==Custom Handlers==
 +
 
 +
If you want a custom handler, you can add one to the class, as in the following example (to be defined AFTER loading validate.js):
 +
<source lang="javascript">
 +
window.addEvent('domready', function(){
 +
  document.formvalidator.setHandler('birth', function(value) {
 +
      regex=/^\d{4}-\d{2}-\d{2}$/;
 +
      return regex.test(value);
 +
  });
 +
});
 +
</source>
 +
You can then assign validate-birth to any field to make it validate as yyyy-mm-dd.  (Valid date is not checked!)
 +
 
 +
If you want a custom handler to check both the passwords (Password and Confirm Password) are same, please add the following script after the validate.js:
 +
<source lang="javascript">
 +
window.addEvent('domready', function(){
 +
    document.formvalidator.setHandler('passverify', function (value) {
 +
        return ($('password').value == value);
 +
    });
 +
});
 +
</source>
 +
Add the class "validate-passverify" to the input field as below:
 +
<source lang="html4strict"><input class="inputbox required validate-passverify" type="password" id="password2" name="password2" size="40" value="" />
 +
</source>
 +
 
 +
==Styling/Templating Invalid Elements==
 +
 
 +
Joomla assigns the ''invalid'' class to form fields that do not pass the validation test. ''invalid'' is also added to the field labels.
 +
If you style the class in the cascading style sheet, your users will be able to see which fields are wrong. For instance:
 +
<source lang="css">
 +
.invalid {
 +
    border-color: red !important;
 +
}
 +
</source>
 +
Some site templates may already contain such definition. (This one is taken from ''beez_20''.)
 +
 
 +
 
 +
<!-- ==Only Accept the Form After Validation==
 +
    This section is not necessary, if it works at all. See validate class on submit buttons.
 +
-->
 +
 
 +
 
 +
==Problem & workaround with JToolBar==
 +
If you are using JHTML::_('behavior.formvalidation') with JToolBar, for example use in backend, the above method will not work. This is because it depends on onSubmit event which did not fire when we call form.submit via JavaScript. To work around this, we have to move the code in onSubmit to be in submitbutton function override. This will look like this:-
 +
<source lang="javascript">
 +
<script type="text/javascript">
 +
/* Override joomla.javascript, as form-validation not work with ToolBar */
 +
function submitbutton(pressbutton) {
 +
    if (pressbutton == 'cancel') {
 +
        submitform(pressbutton);
 +
    }else{
 +
        var f = document.adminForm;
 +
        if (document.formvalidator.isValid(f)) {
 +
            f.check.value='<?php echo JUtility::getToken(); ?>'; //send token
 +
            submitform(pressbutton);   
 +
        }
 +
        else {
 +
            var msg = new Array();
 +
            msg.push('Invalid input, please verify again!');
 +
            if ($('title').hasClass('invalid')) {
 +
                msg.push('<?php echo JText::_('COM_JONGMAN_ERROR_SCHEDULE_TITLE_IS_REQUIRED')?>');   
 +
            }
 +
            if($('admin_email').hasClass('invalid')){
 +
                msg.push('<?php echo JText::_('COM_JONGMAN_ERROR_INVALID_EMAIL')?>');
 +
            }
 +
            alert (msg.join('\n'));
 +
        }
 +
    }   
 +
}
 +
</script>
 +
</source>
 +
 
 +
==More on mootools validation==
 +
More available classes on the mootools site here: [http://mootools.net/docs/more/Forms/Form.Validator#Validators http://mootools.net/docs/more/Forms/Form.Validator#Validators]
  
== To enable the validation ==
 
I believe the only thing to do is set the class "form-validate" to the form. 
 
  
 +
==Server- or Client-side validation?==
 +
[[Form validation]]
  
== TODO ==
+
<noinclude>[[Category:Tutorials]][[Category:Development]][[Category:Component Development]]</noinclude>
* There should be a way to not let your form be submitted in case the javascript isn't loaded or contains an error.
+
How to do this?  Is this done by giving a token to the script receving the form?
+
* How to add your own custom form validators?  setHandler?  If so, how to enable this via Joomla (should this be in the html header??
+

Revision as of 09:40, 1 February 2013

Contents

Introduction

Joomla 1.5 and later versions contain a behavior, which allows your form and its elements to be validated at client side, i.e., before it is submitted to the server. The behavior enables the script validate.js and uses MooTools.

Note: Validate.js is a validation system different from the one provided by MooTools.

Enable the Validation

Add a behavior to your form view template. For Joomla versions before 1.5.2:

JHTMLBehavior::formvalidation();

For versions from 1.5.2:

JHTML::_('behavior.formvalidation');

Add the form-validate class to your form

<form class="form-validate"> ... </form>

Add a validation class to your form field declarations. Joomla adds a blur handler to validate the form field when the user moves away from the field.

<field name="email" type="text" class="required validate-email" size="30" />
 
//For radios make sure the class is applied to the options: 
 
<field name="ThisorThat" type="radio" label="Please say if it was full-time or the part-time equivalent?" >
 <option value="This" class="required">This</option>
 <option value="That" class="required">That</option>
</field>

The following classes are available:

  • required
  • validate-username
  • validate-password
  • validate-numeric
  • validate-email
  • validate-[custom] -> custom defined - see below

Note: Joomla 2.5 translates the required field attribute into a required class value.

Finally, add the validate class to your submit button. This will cause an onclick handler to be added that validates the whole form. The form will only be submitted if it is valid.

<button type="submit" class="validate">Submit form</button>

Custom Handlers

If you want a custom handler, you can add one to the class, as in the following example (to be defined AFTER loading validate.js):

window.addEvent('domready', function(){
   document.formvalidator.setHandler('birth', function(value) {
      regex=/^\d{4}-\d{2}-\d{2}$/;
      return regex.test(value);
   });
});

You can then assign validate-birth to any field to make it validate as yyyy-mm-dd. (Valid date is not checked!)

If you want a custom handler to check both the passwords (Password and Confirm Password) are same, please add the following script after the validate.js:

window.addEvent('domready', function(){
    document.formvalidator.setHandler('passverify', function (value) {
        return ($('password').value == value); 
    });
});

Add the class "validate-passverify" to the input field as below:

<input class="inputbox required validate-passverify" type="password" id="password2" name="password2" size="40" value="" />

Styling/Templating Invalid Elements

Joomla assigns the invalid class to form fields that do not pass the validation test. invalid is also added to the field labels. If you style the class in the cascading style sheet, your users will be able to see which fields are wrong. For instance:

.invalid {
    border-color: red !important;
}

Some site templates may already contain such definition. (This one is taken from beez_20.)



Problem & workaround with JToolBar

If you are using JHTML::_('behavior.formvalidation') with JToolBar, for example use in backend, the above method will not work. This is because it depends on onSubmit event which did not fire when we call form.submit via JavaScript. To work around this, we have to move the code in onSubmit to be in submitbutton function override. This will look like this:-

<script type="text/javascript">
/* Override joomla.javascript, as form-validation not work with ToolBar */
function submitbutton(pressbutton) {
    if (pressbutton == 'cancel') {
        submitform(pressbutton);
    }else{
        var f = document.adminForm;
        if (document.formvalidator.isValid(f)) {
            f.check.value='<?php echo JUtility::getToken(); ?>'; //send token
            submitform(pressbutton);    
        }
        else {
            var msg = new Array();
            msg.push('Invalid input, please verify again!');
            if ($('title').hasClass('invalid')) {
                msg.push('<?php echo JText::_('COM_JONGMAN_ERROR_SCHEDULE_TITLE_IS_REQUIRED')?>');    
            }
            if($('admin_email').hasClass('invalid')){
                msg.push('<?php echo JText::_('COM_JONGMAN_ERROR_INVALID_EMAIL')?>');
            }
            alert (msg.join('\n'));
        }
    }    
}
</script>

More on mootools validation

More available classes on the mootools site here: http://mootools.net/docs/more/Forms/Form.Validator#Validators


Server- or Client-side validation?

Form validation