.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "HTML::FormHandler::TraitFor::Captcha 3pm"
.TH HTML::FormHandler::TraitFor::Captcha 3pm "2017-11-11" "perl v5.26.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
HTML::FormHandler::TraitFor::Captcha \- generate and validate captchas
.SH "VERSION"
.IX Header "VERSION"
version 0.40068
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
A role to use in a form to implement a captcha field.
.PP
.Vb 3
\&   package MyApp::Form;
\&   use HTML::FormHandler::Moose;
\&   with \*(AqHTML::FormHandler::TraitFor::Captcha\*(Aq;
.Ve
.PP
or
.PP
.Vb 2
\&   my $form = MyApp::Form\->new( traits => [\*(AqHTML::FormHandler::TraitFor::Captcha\*(Aq],
\&       ctx => $c );
.Ve
.PP
Needs a context object set in the form's 'ctx' attribute which has a session
hashref in which to store a 'captcha' hashref, such as is provided by Catalyst
session plugin.
.SH "METHODS"
.IX Header "METHODS"
.SS "get_captcha"
.IX Subsection "get_captcha"
Get a captcha stored in \f(CW\*(C`$form\->ctx\->{session}\*(C'\fR
.SH "set_captcha"
.IX Header "set_captcha"
Set a captcha in \f(CW\*(C`$self\->ctx\->{session}\*(C'\fR
.SS "captcha_image_url"
.IX Subsection "captcha_image_url"
Default is '/captcha/image'. Override in a form to change.
.PP
.Vb 1
\&   sub captcha_image_url { \*(Aq/my/image/url/\*(Aq }
.Ve
.PP
Example of a Catalyst action to handle the image:
.PP
.Vb 10
\&    sub image : Local {
\&        my ( $self, $c ) = @_;
\&        my $captcha = $c\->session\->{captcha};
\&        $c\->response\->body($captcha\->{image});
\&        $c\->response\->content_type(\*(Aqimage/\*(Aq. $captcha\->{type});
\&        $c\->res\->headers\->expires( time() );
\&        $c\->res\->headers\->header( \*(AqLast\-Modified\*(Aq => HTTP::Date::time2str );
\&        $c\->res\->headers\->header( \*(AqPragma\*(Aq        => \*(Aqno\-cache\*(Aq );
\&        $c\->res\->headers\->header( \*(AqCache\-Control\*(Aq => \*(Aqno\-cache\*(Aq );
\&    }
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
FormHandler Contributors \- see HTML::FormHandler
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2017 by Gerda Shank.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.