Catalyst::Plugin::Captcha(3pm)				User Contributed Perl Documentation			    Catalyst::Plugin::Captcha(3pm)

NAME

       Catalyst::Plugin::Captcha - create and validate Captcha for Catalyst

SYNOPSIS

	 use Catalyst qw/Captcha/;

	 MyApp->config->{ 'Plugin::Captcha' } = {
	   session_name => 'captcha_string',
	   new => {
	     width => 80,
	     height => 30,
	     lines => 7,
	     gd_font => 'giant',
	   },
	   create => [qw/normal rect/],
	   particle => [100],
	   out => {force => 'jpeg'}
	 };

	 sub captcha : Local {
	   my ($self, $c) = @_;
	   $c->create_captcha();
	 }

	 sub do_post : Local {
	   my ($self, $c) = @_;
	   if ($c->validate_captcha($c->req->param('validate')){
	     ..
	   } else {
	     ..
	   }
	 }

	 #validate with CP::FormValidator::Simple
	 sub do_post : Local {
	   my ($self, $c) = @_;
	   $c->form(
	     validate => [['EQUAL_TO',$c->captcha_string]]
	   )
	 }

DESCRIPTION

       This plugin create, validate Captcha.

       Note: This plugin uses GD::SecurityImage and requires a session plugins like Catalyst::Plugin::Session

METHODS

   create_captcha
       Create Captcha image and output it.

   validate_captcha
	 $c->validate_captcha($key);

       validate key

   captcha_string
       Return a string for validation which is stroed in session.

   clear_captcha_string
       Clear a string which is stroed in session.

CONFIGURATION

       session_name
	   The keyword for storing captcha string

       new
       create
       particle
       out These parameters are passed to each GD::Security's method. Please see GD::SecurityImage for details.

SEE ALSO

       GD::SecurityImage, Catalyst

AUTHOR

       Masahiro Nagano <kazeburo@nomadscafe.jp>

COPYRIGHT AND LICENSE

       Copyright (C) 2006 by Masahiro Nagano

       This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.5 or,
       at your option, any later version of Perl 5 you may have available.

perl v5.10.1							    2010-04-03					    Catalyst::Plugin::Captcha(3pm)