Cataly...sLogin(3pm)

💖 Catalyst::ActionRole::NeedsLogin(3pm) 💖

okay so bestie, gather round, because this one is short but it is mighty. This is the manual page for Catalyst::ActionRole::NeedsLogin — a little ActionRole that checks if somebody's logged in, and if they're not? It yeets them straight to the login page. No cap. 🚪✨

---

🌸 NAME 🌸

Catalyst::ActionRole::NeedsLogin — checks if a user is logged in and if not redirects him to login page

it's giving "bouncer at the club but for your web app" 💅

---

✨ SYNOPSIS ✨

package MyApp::Controller::NeedsAuth;

use Moose;
use namespace::autoclean;

# One needs to inherit from Catalyst::Controller in order
# to get the Does('NeedsLogin') functionality.
BEGIN { extends 'Catalyst::Controller'; }

sub inbox : Path Does('NeedsLogin') {
    # Redirects to /login if not logged in
    my ($self, $c) = @_;

    $c->stash->{template} = "inbox.tt2";

    return;
}

sub inbox : Path Does('NeedsLogin') :LoginRedirectMessage('Your custom Message') {
    # Redirects to /login if not logged in-
}

# Turn on in config
MyApp->config('Contoller::Login' => { traits => ['WithRedirect'] });

lowkey the whole plot is right there: slap Does('NeedsLogin') on an action, and boom, that action is now members-only. 🔐 You can even hand it a :LoginRedirectMessage('...') attribute so the redirect says your custom thing instead of the default vibe. And yes, that config line up there says 'Contoller::Login' — copy it exactly as written, bestie, I do not make the rules, I just report them fr fr 🫶

---

🦋 DESCRIPTION 🦋

Provides a ActionRole for forcing the user to login.

that's it. that's the whole description. short, sweet, and iconic. it exists to make your users prove who they are before they get the goods. 👑

---

🎀 WRAPPED METHODS 🎀

execute

• If there is no logged-in user, it calls the login_redirect() method in the 'Login' controller with the Catalyst context object, $c, and the message specified by the :LoginRedirectMessage('Message here') method attribute (peep the synopsis, it's all there 👀).
• If there is a user logged-in (i.e: $c->user is true), it executes the body of the action as it is. Like, just runs it normally. Business as usual. 💖

so: no user → redirected. user → your code runs. the vibe check happens automatically and you didn't even have to lift a finger. 🌈

---

🌟 SEE ALSO 🌟

go read these next, besties, they're the extended universe:

• CatalystX::SimpleLogin::TraitFor::Controller::Login::WithRedirect
• CatalystX::SimpleLogin::Controller::Login
• CatalystX::SimpleLogin::Form::Login

---

👑 AUTHORS 👑

See CatalystX::SimpleLogin for authors.

(the authors are being mysterious and forwarding you to the other page. respect the mystery. 🫡)

---

💜 LICENSE 💜

See CatalystX::SimpleLogin for license.

---

aaaand that's the whole page, you ate it, you read the entire thing, I'm so proud 🥹

this little beauty shipped as part of perl v5.36.0, dated 2022-08-28 — so give it a kiss goodbye and go protect your inbox, main character. 🎀✨💅