Skip to content

Commit

Permalink
Documented more attributes in Controller::Login.
Browse files Browse the repository at this point in the history
I need to be sure they are part of the public, stable, interface. Left a
TODO for BOBTFISH to fill in.
  • Loading branch information
shlomif committed Nov 10, 2010
1 parent 638b65b commit 5be4a0b
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions lib/CatalystX/SimpleLogin/Controller/Login.pm
Original file line number Diff line number Diff line change
Expand Up @@ -172,12 +172,53 @@ for the login and logout actions.
=head1 ATTRIBUTES
=head2 login_form_class
A class attribute containing the class of the form to be initialised. One
can override it in a derived class with the class of a new form, possibly
subclassing L<CatalystX::SimpleLogin::Form::Login>. For example:
package MyApp::Controller::Login;
use Moose;
extends('CatalystX::SimpleLogin::Controller::Login');
has '+login_form_class' => (
default => "MyApp::Form::Login",
);
1;
=head2 login_form_class_roles
An attribute containing an array reference of roles to be consumed by
the form. One can override it in a similar way to C<login_form_class>:
package MyApp::Controller::Login;
use Moose;
extends('CatalystX::SimpleLogin::Controller::Login');
has '+login_form_class_roles' => (
default => sub { [qw(MyApp::FormRole::Foo MyApp::FormRole::Bar)] },
);
1;
=head1 METHODS
=head2 BUILD
Cause form instance to be built at application startup.
=head2 do_post_login_redirect
This method does a post-login redirect. B<TODO> for BOBTFISH - should it even
be public? If it does need to be public, then document it because the Pod
coverage test failed.
=head2 login
Login action.
Expand Down

0 comments on commit 5be4a0b

Please sign in to comment.