---
name: "CatalystX::SimpleLogin::TraitFor::Controller::Login::Logout"
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::TraitFor::Controller::Login::Logout"
---

# CatalystX::SimpleLogin::TraitFor::Controller::Login::Logout(3pm)

log users out

## 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.