FormValidator::Simple - validation with simple chains of constraints
my $query = CGI->new;
$query->param( param1 => 'ABCD' );
$query->param( param2 => 12345 );
$query->param( mail1 => 'lyo.kato@gmail.com' );
$query->param( mail2 => 'lyo.kato@gmail.com' );
$query->param( year => 2005 );
$query->param( month => 11 );
$query->param( day => 27 );
my $result = FormValidator::Simple->check( $query => [
param1 => ['NOT_BLANK', 'ASCII', ['LENGTH', 2, 5]],
param2 => ['NOT_BLANK', 'INT' ],
mail1 => ['NOT_BLANK', 'EMAIL_LOOSE'],
mail2 => ['NOT_BLANK', 'EMAIL_LOOSE'],
{ mails => ['mail1', 'mail2' ] } => ['DUPLICATION'],
{ date => ['year', 'month', 'day'] } => ['DATE'],
] );
if ( $result->has_missing or $results->has_invalid ) {
my $tt = Template->new({ INCLUDE_PATH => './tmpl' });
$tt->process('template.html', { result => $result });
}
template example
[% IF result.has_invalid || result.has_missing %]
<p>Found Input Error</p>
<ul>
[% IF result.missing('param1') %]
<li>param1 is blank.</li>
[% END %]
[% IF result.invalid('param1') %]
<li>param1 is invalid.</li>
[% END %]
[% IF result.invalid('param1', 'ASCII') %]
<li>param1 needs ascii code.</li>
[% END %]
[% IF result.invalid('param1', 'LENGTH') %]
<li>input into param1 with characters that's length should be between two and five. </li>
[% END %]
</ul>
[% END %]
This module provides you a sweet way of form data validation with simple constraints chains. You can write constraints on single line for each input data.
This idea is based on Sledge::Plugin::Validator, and most of validation code is borrowed from this plugin.
(Sledge is a MVC web application framework: http://sl.edge/jp [Japanese] )
The result object this module returns behaves like Data::FormValidator::Results.
FormValidator::Simple->check( $q => [
#profile
] );
Use 'check' method.
A hash reference includes input data, or an object of some class that has a method named 'param', for example CGI, is needed as first argument.
And set profile as array reference into second argument. Profile confists of some pairs of input data and constraints.
my $q = CGI->new;
$q->param( param1 => 'hoge' );
FormValidator::Simple->check( $q => [
param1 => [ ['NOT_BLANK'], ['LENGTH', 4, 10] ],
] );
In this case, param1 is the name of a form element. and the array ref "[ ['NOT_BLANK']... ]" is a constraints chain.
Write constraints chain as arrayref, and you can set some constraints into it. In the last example, two constraints 'NOT_BLANK', and 'LENGTH' are set. Each constraints is should be set as arrayref, but in case the constraint has no argument, it can be written as scalar text.
FormValidator::Simple->check( $q => [
param1 => [ 'NOT_BLANK', ['LENGTH', 4, 10] ],
] );
Now, in this sample 'NOT_BLANK' constraint is not an arrayref, but 'LENGTH' isn't. Because 'LENGTH' has two arguments, 4 and 10.
When you want to check about multiple input data, do like this.
my $q = CGI->new;
$q->param( mail1 => 'lyo.kato@gmail.com' );
$q->param( mail2 => 'lyo.kato@gmail.com' );
my $result = FormValidator::Simple->check( $q => [
{ mails => ['mail1', 'mail2'] } => [ 'DUPLICATION' ],
] )
[% IF result.invalid('mails') %]
<p>mail1 and mail2 aren't same.</p>
[% END %]
and here's an another example.
my $q = CGI->new;
$q->param( year => 2005 );
$q->param( month => 12 );
$q->param( day => 27 );
my $result = FormValidator::Simple->check( $q => [
{ date => ['year', 'month', 'day'] } => [ 'DATE' ],
] );
[% IF result.invalid('date') %]
<p>Set correct date.</p>
[% END %]
my $valid = FormValidator::Simple->new();
$valid->check( $q => [
param1 => [qw/NOT_BLANK ASCII/, [qw/LENGTH 4 10/] ],
] );
$valid->check( $q => [
param2 => [qw/NOT_BLANK/],
] );
my $results = $valid->results;
if ( found some error... ) {
$results->set_invalid('param3' => 'MY_ERROR');
}
template example
[% IF results.invalid('param1') %]
...
[% END %]
[% IF results.invalid('param2') %]
...
[% END %]
[% IF results.invalid('param3', 'MY_ERROR') %]
...
[% END %]
You can use follow variety validations. and each validations can be used as negative validation with 'NOT_' prefix.
FormValidator::Simple->check( $q => [
param1 => [ 'INT', ['LENGTH', 4, 10] ],
param2 => [ 'NOT_INT', ['NOT_LENGTH', 4, 10] ],
] );
check if the data has space or not.
check if the data is integer or not.
check is the data consists of only ascii code.
check the length of the data.
my $result = FormValidator::Simple->check( $q => [
param1 => [ ['LENGTH', 4] ],
] );
check if the length of the data is 4 or not.
my $result = FormValidator::Simple->check( $q => [
param1 => [ ['LENGTH', 4, 10] ],
] );
when you set two arguments, it checks if the length of data is in the range between 4 and 10.
check with regular expression.
my $result = FormValidator::Simple->check( $q => [
param1 => [ ['REGEX', qr/^hoge$/ ] ],
] );
check if the two data are same or not.
my $result = FormValidator::Simple->check( $q => [
{ duplication_check => ['param1', 'param2'] } => [ 'DUPLICATION' ],
] );
check with Email::Valid.
check with Email::Valid, including mx check.
check with Email::Valid::Loose.
check with Email::Valid::Loose, including mx check.
check with Date::Calc
my $result = FormValidator::Simple->check( $q => [
{ date => [qw/year month day/] } => [ 'DATE' ]
] );
check with Date::Calc
my $result = FormValidator::Simple->check( $q => [
{ time => [qw/hour min sec/] } => ['TIME'],
] );
check with Date::Calc
my $result = FormValidator::Simple->check( $q => [
{ datetime => [qw/year month day hour min sec/] } => ['DATETIME']
] );
check if there is not blank data in multiple data.
my $result = FormValidator::Simple->check( $q => [
{ some_data => [qw/param1 param2 param3/] } => ['ANY']
] );
use FormValidator::Simple qw/Japanese CreditCard/;
FormValidator::Simple::Plugin::Japanese, FormValidator::Simple::Plugin::CreditCard are loaded.
or use 'load_plugin' method.
use FormValidator::Simple;
FormValidator::Simple->load_plugin('FormValidator::Simple::Plugin::CreditCard');
sweet solution to put out messages on your application's error page.
to make it easier to find wrong setting.
http://sl.edge/jp/ (Japanese)
http://sourceforge.jp/projects/sledge
Lyo Kato <lyo.kato@gmail.com>
This library is free software. You can redistribute it and/or modify it under the same terms as perl itself.
