---
name: "CatalystX::SimpleLogin::Form::Login"
section: "3pm"
platform: "linux"
package: "libcatalystx-simplelogin-perl"
version: "0.21-2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/CatalystX::SimpleLogin::Form::Login"
---

# CatalystX::SimpleLogin::Form::Login(3pm)

validation for the login form

## NAME

CatalystX::SimpleLogin::Form::Login - validation for the login form

## DESCRIPTION

A HTML::FormHandler form for the login form.

## FIELDS

- username

  - password

  - remember

  - submit

  ## METHODS

- validate

  - add\_auth\_errors

  ## SEE ALSO

- CatalystX::SimpleLogin::Controller::Login

  ## CUSTOMIZATION

By default, the params passed to **authenticate()** 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'.

```
    __PACKAGE__->config(
        'Controller::Login' => {
            login_form_args => {
               authenticate_username_field_name => 'name',
               authenticate_password_field_name => 'password2',
            },
        },
    );
```

You can also change the way that the form is displayed by setting attributes.  In MyApp.pm:

```
    __PACKAGE__->config(
        'Controller::Login' => {
            login_form_args => {
               login_error_message => 'Login failed',
               field_list => [
                   '+submit' => { value => 'Login' },
               ]
            }
        },
    );
```

Additional fields can be added:

```
   field_list => [
       'foo' => ( type => 'MyField' ),
       'bar' => { type => 'Text' },
   ]
```

Additional arguments to the authenticate call can be added: If your user table has a column `"status"` and you want only those with `"status = 'active'"`to be able to log .in

```
    __PACKAGE__->config(
        'Controller::Login' => {
            login_form_args => {
                authenticate_args => { status => 1 },
            },
        },
    };
```

## AUTHORS

See CatalystX::SimpleLogin for authors.

## LICENSE

See CatalystX::SimpleLogin for license.