--- name: "Catalyst::Plugin::FormValidator::Simple" section: "3pm" platform: "linux" package: "libcatalyst-modules-extra-perl" version: "3" release: "Debian 5.0 (Lenny)" platforms: ["linux"] url: "https://new.carta.tech/Catalyst::Plugin::FormValidator::Simple" --- # Catalyst::Plugin::FormValidator::Simple(3pm) Catalyst::Plugin::FormValidator::Simple - Validator for Catalyst with FormValidator::Simple ``` use Catalyst qw/FormValidator::Simple FillInForm/; ``` ``` # set option MyApp->config->{validator} = { plugins => ['CreditCard', 'Japanese'], options => { charset => 'euc'}, } ``` in your controller ``` sub defaulti : Private { ``` ``` my ($self, $c) = @_; ``` ``` $c->form( param1 => [qw/NOT_BLANK ASCII/, [qw/LENGTH 4 10/]], param2 => [qw/NOT_BLANK/, [qw/JLENGTH 4 10/]], mail1 => [qw/NOT_BLANK EMAIL_LOOSE/], mail2 => [qw/NOT_BLANK EMAIL_LOOSE/], { mail => [qw/mail1 mail2/] } => ['DUPLICATION'], ); ``` ``` print $c->form->valid('param1'); ``` ``` if ( some condition... ) { ``` ``` $c->form( other_param => [qw/NOT_INT/], ); } ``` ``` if ( some condition... ) { ``` ``` # set your original invalid type. $c->set_invalid_form( param3 => 'MY_ERROR' ); ``` ``` } ``` ``` if ( $c->form->has_error ) { ``` ``` if ( $c->form->missing('param1') ) { ... } ``` ``` if ( $c->form->invalid( param1 => 'ASCII' ) ) { ... } ``` ``` if ( $c->form->invalid( param3 => 'MY_ERROR' ) ) { ... } ``` ``` } } ``` This plugin allows you to validate request parameters with FormValidator::Simple. See FormValidator::Simple for more information. This behaves like as Catalyst::Plugin::FormValidator. set config with 'validator' key. ``` MyApp->config->{validator} = { ... }; ``` or ``` MyApp->config( validator => { ... }, ); ``` **PLUGINS** If you want to use some plugins for FormValidator::Simple, you can set like following. ``` MyApp->config( validator => { plugins => [qw/Japanese CreditCard DBIC::Unique/], }, ); ``` In this example, FormValidator::Simple::Plugin::Japanese, FormValidator::Simple::Plugin::CreditCard, and FormValidator::Simple::Plugin::DBIC::Unique are loaded.\ **OPTIONS** When you set some options needed by specific validations, do like this. ``` MyApp->config( validator => { plugins => [qw/Japanese CreditCard DBIC::Unique/], options => { charset => 'euc', dbic_base_class => 'MyApp::Model::DBIC', }, }, ); ``` 'charset' is necessary for Plugin::Japanese, and 'dbic\_cbase\_class' is used in Plugin::DBIC::Unique. use 'form' method, see FormValidator::Simple in detail. ``` sub do_add : Local { my ( $self, $c ) = @_; ``` ``` # execute validation. $c->form( name => [qw/NOT_BLANK ASCII/, [qw/LENGTH 0 20/] ], email => [qw/NOT_BLANK EMAIL_LOOSE/, [qw/LENGTH 0 20/] ], { unique => [qw/name email/] } => [qw/DBIC_UNIQUE User name email/], ); ``` ``` if ( ... ) { ``` ``` # execute validation one more time in specific condition. $c->form( ... ); ``` ``` } ``` ``` # See Catalyst::Plugin::RequestToken for '$c->validate_token' if ( $c->validate_token ) { ``` ``` # you can force to set invalid data. $c->set_invalid_form( token => 'TOKEN' ); ``` ``` } ``` ``` # check result. # you can pick up result-object with 'form' method ``` ``` my $result = $c->form; ``` ``` if ( $result->has_error ) { ``` ``` # this is same as # if ( $result->has_missing or $result->has_invalid ) ``` ``` $c->detach('add'); ``` ``` } ``` ``` } ``` After it passes all validations, you may wanna put input-data into database. It's a elegant way to use \[ Class::DBI and Class::DBI::FromForm \] or \[ DBIx::Class and DBIx::Class::WebForm \]. ``` sub do_add : Local { my ( $self, $c ) = @_; ``` ``` $c->form( name => [qw/NOT_BLANK/], email => [qw/NOT_BLANK/], ); ``` ``` my $result = $c->form; if ( $result->has_error ) { $c->detach('add'); } ``` ``` my $user = MyProj::Model::DBIC::User->create_from_form($result); ``` ``` # this behaves like this... # MyProj::Model::DBIC::User->create({ # name => $result->valid('name'), # email => $result->valid('email'), # }); # # if the key exists as the table's column, set the value with 'valid' } ``` Here, I explain about 'valid' method. If the value indicated with key-name passes validations, You can get the data with 'valid', ``` my $result = $c->form( name => [qw/NOT_BLANK/], email => [qw/NOT_BLANK/], ); ``` ``` print $result->valid('name'); ``` ``` print $result->valid('email'); ``` But, this is for only single key validation normally. ``` my $result = $c->form( name => [qw/NOT_BLANK/], # single key validation { mail_dup => [qw/email email2/] } => ['DUPLICATION'] # multiple keys one ); ``` ``` print $result->valid('name'); # print out the value of 'name' ``` ``` print $result->valid('mail_dup'); # no value. ``` There are exceptions. These are 'DATETIME', 'DATE'. ``` my $result = $c->form( { created_on => [qw/created_year created_month created_day/] } => [qw/DATETIME/], ); ``` ``` print $result->valid('created_on'); #print out datetime string like "2005-11-23 00:00:00". ``` If you set some class around datetime in configuration. It returns object of the class you indicate. You can choose from Time::Piece and DateTime. For example... ``` MyApp->config( validator => { plugins => [...], options => { datetime_class => 'Time::Piece', }, }, ); ``` or ``` MyApp->config( validator => { plugins => [...], options => { datetime_class => 'DateTime', time_zone => 'Asia/Tokyo', }, }, ); ``` then ``` my $result = $c->form( { created_on => [qw/created_year created_month created_day/] } => [qw/DATETIME/], ); ``` ``` my $dt = $result->valid('created_on'); ``` ``` print $dt->ymd; ``` ``` MyProj::Model::CDBI::User->create_from_form($result); ``` This may be useful when you define 'has\_a' relation for datetime columns. For example, in your table class inherits 'Class::DBI' ``` __PACKAGE__->has_a( created_on => 'DateTime', inflate => ..., deflate => ..., ); ``` And see also Class::DBI::Plugin::TimePiece, Class::DBI::Plugin::DateTime. in template file, you can handle it in detail. ``` [% IF c.form.has_error %]

Input Error

[% END %] ``` or, make it more easy. ``` [% IF c.form.has_error %]

Input Error