Man pages sections > man3 > CatalystX::SimpleLogin::TraitFor::Controller::Login::Logout

CatalystX::SimpleLogin::TraitFor::Controller::Login::Logout - log users out

CatalystX::SimpleLogin::TraitFor::Controller::Login::Logout(3pm) User Contributed Perl Documentation CatalystX::SimpleLogin::TraitFor::Controller::Login::Logout(3pm)

NAME

CatalystX::SimpleLogin::TraitFor::Controller::Login::Logout - log users out

DESCRIPTION

Simple controller role for logging users out. Provides a "logout" action (at /logout by default) which redirects the user to the homepage by default.

ACTIONS

logout : Chained('/') PathPart('logout') Args(0)

Calls "$c->logout", then redirects to the logout uri retuned by "$self->redirect_after_logout_uri".

METHODS

redirect_after_logout_uri

Returns the uri to redirect to after logout.
Defaults to "$c->uri_for('/');" you can override this by setting the "<redirect_after_logout_uri"> key in config to a path to be passed to "$c->uri_for".
Alternatively, you can write your own redirect_after_logout_uri in your Login controller if you are extending CatalystX::SimpleLogin and it will override the method from this role.

do_clear_session_on_logout

Deletes the session after a logout.
To enable this use the following in your config:
__PACKAGE__->config('Controller::Login' => { clear_session_on_logout => 1 });

SEE ALSO

CatalystX::SimpleLogin::Controller::Login

AUTHORS

See CatalystX::SimpleLogin for authors.

LICENSE

See CatalystX::SimpleLogin for license.
2017-08-26 perl v5.26.0