Cataly...:Logout(3pm)

✨ CatalystX::SimpleLogin::TraitFor::Controller::Login::Logout ✨

okay bestie, so this one is a CatalystX::SimpleLogin trait — a Perl module, (3pm) manual, and it lives in the TraitFor::Controller::Login namespace under CatalystX::SimpleLogin. It's the Logout one. You already know what it does from the name but let me say it anyway 💅

---

🌸 NAME 🌸

CatalystX::SimpleLogin::TraitFor::Controller::Login::Logout — literally just logging users out. that's it. that's the whole job. 🫶

---

🦋 DESCRIPTION 🦋

It's a simple controller role whose entire main character era is logging users out. It hands you a "logout" action — which sits at /logout by default, no cap — and that action redirects the user to the homepage. also by default. defaults everywhere, we love a low-maintenance icon ✨

---

🎀 ACTIONS 🎀

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

So the way this works: it calls $c->logout first, and then it redirects over to whatever logout uri gets returned by $self->redirect_after_logout_uri. that's the whole flow. serve, log out, redirect, slay. 💅

---

💖 METHODS 💖

🌈 redirect_after_logout_uri

Returns the uri to redirect to after logout. yes bestie, it's giving navigator. it tells you where to go next 🧚

It defaults to $c->uri_for('/'); — iconic, predictable, home sweet home. But you can override it by setting the <redirect_after_logout_uri"> key in config to a path, and that path gets passed straight into $c->uri_for.

OR, if you're feeling extra: you can write your own redirect_after_logout_uri inside your Login controller if you're extending CatalystX::SimpleLogin. Do that and it will override the method from this role. you're the main character now, go off 👑

🌸 do_clear_session_on_logout

Deletes the session after a logout. bye bye session data, you will not be missed 💀

To enable this, pop the following in your config:

__PACKAGE__->config('Controller::Login' => { clear_session_on_logout => 1 });

that's it. one little flag and the session is GONE. periodt. ✨

---

🔥 SEE ALSO 🔥

• CatalystX::SimpleLogin::Controller::Login

---

👑 AUTHORS 👑

See CatalystX::SimpleLogin for authors. (they're all listed over there, iykyk 💜)

---

🍓 LICENSE 🍓

See CatalystX::SimpleLogin for license. 🎀

---

ngl, this page is short and sweet and i'm obsessed with it. everything you need, nothing you don't, and it still ate. 💅

okay bye bestie, this was documented with perl v5.36.0, dated 2022-08-28, and it's part of the Cataly...:Logout(3pm) page — go log somebody out, you got this 🫶✨🌸