.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "CatalystX::SimpleLogin::Form::Login 3pm"
.TH CatalystX::SimpleLogin::Form::Login 3pm "2022-08-28" "perl v5.34.0" "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"
CatalystX::SimpleLogin::Form::Login \- validation for the login form
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
A HTML::FormHandler form for the login form.
.SH "FIELDS"
.IX Header "FIELDS"
.IP "username" 4
.IX Item "username"
.PD 0
.IP "password" 4
.IX Item "password"
.IP "remember" 4
.IX Item "remember"
.IP "submit" 4
.IX Item "submit"
.PD
.SH "METHODS"
.IX Header "METHODS"
.IP "validate" 4
.IX Item "validate"
.PD 0
.IP "add_auth_errors" 4
.IX Item "add_auth_errors"
.PD
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "CatalystX::SimpleLogin::Controller::Login" 4
.IX Item "CatalystX::SimpleLogin::Controller::Login"
.SH "CUSTOMIZATION"
.IX Header "CUSTOMIZATION"
By default, the params passed to \fBauthenticate()\fR are 'username' and
\&'password'. If you need to use different names, then you'll need to
set the correct value(s) via login_form_args in the configuration.
The keys are 'authenticate_username_field_name' and/or
\&'authenticate_password_field_name'.
.PP
.Vb 8
\&    _\|_PACKAGE_\|_\->config(
\&        \*(AqController::Login\*(Aq => {
\&            login_form_args => {
\&               authenticate_username_field_name => \*(Aqname\*(Aq,
\&               authenticate_password_field_name => \*(Aqpassword2\*(Aq,
\&            },
\&        },
\&    );
.Ve
.PP
You can also change the way that the form is displayed by setting
attributes.  In MyApp.pm:
.PP
.Vb 10
\&    _\|_PACKAGE_\|_\->config(
\&        \*(AqController::Login\*(Aq => {
\&            login_form_args => {
\&               login_error_message => \*(AqLogin failed\*(Aq,
\&               field_list => [
\&                   \*(Aq+submit\*(Aq => { value => \*(AqLogin\*(Aq },
\&               ]
\&            }
\&        },
\&    );
.Ve
.PP
Additional fields can be added:
.PP
.Vb 4
\&   field_list => [
\&       \*(Aqfoo\*(Aq => ( type => \*(AqMyField\*(Aq ),
\&       \*(Aqbar\*(Aq => { type => \*(AqText\*(Aq },
\&   ]
.Ve
.PP
Additional arguments to the authenticate call can be added:
If your user table has a column \f(CW\*(C`status\*(C'\fR and you want only those with \f(CW\*(C`status = \*(Aqactive\*(Aq\*(C'\fRto be able to log .in
.PP
.Vb 7
\&    _\|_PACKAGE_\|_\->config(
\&        \*(AqController::Login\*(Aq => {
\&            login_form_args => { 
\&                authenticate_args => { status => 1 },
\&            },
\&        },
\&    };
.Ve
.SH "AUTHORS"
.IX Header "AUTHORS"
See CatalystX::SimpleLogin for authors.
.SH "LICENSE"
.IX Header "LICENSE"
See CatalystX::SimpleLogin for license.