Cataly...d::User(3pm)

📦
version 1.006 · 2 versions
  • 1.006 · debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking (latest)
  • 1.006 · ubuntu jammy
, in debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking

✨ NAME ✨

Catalyst::Authentication::Store::Htpasswd::User — bestie, it's a user object. a whole little guy representing one single entry in an htpasswd file. that's the whole assignment. (also the 3pm is just telling you it's a perl module man page, iykyk 💅)

🌸 VERSION 🌸

version 1.006 ✨

💖 DESCRIPTION 💖

okay so picture this: this object is literally just wrapping an Authen::Htpasswd::User object. it's giving "personal assistant to a celebrity." 🫶

an instance of it is what gets returned by $c->user when you're using Catalyst::Authentication::Store::Htpasswd. iconic behaviour, no notes.

and here's the fun part — any methods that aren't defined in this module? they get passed straight through to the Authen::Htpasswd::User object underneath. so like, if you call something this module doesn't know about, the wrapped object handles it. teamwork!! 🧚

also, when you stringify the object, you get the username back. cute. 🎀

👑 METHODS 👑

new($store,$user)

creates a brand new object from two things:

  • a store object — normally an instance of Catalyst::Plugin::Authentication::Store::Htpasswd::Backend
  • a user object — normally an instance of Authen::Htpasswd::User

that's the origin story. 💫

id

returns the username. short. sweet. slay. ⭐

check_password($password)

returns whether the password is valid. yep, that's the whole thing — true or false, bestie, no drama. 🔥

roles

returns an array of roles! and where do these roles come from, you ask? they get extracted from a comma-separated list in the third field of the htpasswd file. that's the source of truth, okay. respect the third field. 💅

for_session

returns the username, which then gets stored in the session. it's the "who even are you" receipt for later. 🎫

supported_features

returns data about which features this user module supports. (heads up, the original page spells it "featurs" — adorable typo, but the meaning is the features. 🫶)

get_object

returns the underlying Authen::Htpasswd::User object for this user. the real one behind the curtain. the main character underneath the wrapper. 🌈

🌟 SUPPORT 🌟

got bugs? bestie, we all do. submit them through the RT bug tracker:

https://rt.cpan.org/Public/Dist/Display.html?Name=Catalyst-Authentication-Store-Htpasswd

or you can email:

bug-Catalyst-Authentication-Store-Htpasswd@rt.cpan.org

there's also a mailing list for users of this distribution, over at:

http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst

and if you wanna just vibe in real time, there's an irc channel for users of this distribution at #catalyst on irc.perl.org:

irc://irc.perl.org/#catalyst

come hang out, we don't bite. 💜

💌 AUTHOR 💌

XXXX XXX'XX (Yuval Kogman) <nothingmuch@woobling.org>

this software is copyright (c) 2005 by XXXX XXX'XX (Yuval Kogman).

it's free software, babes — you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. periodt. 💅

k that's the whole page, no cap. go forth and authenticate responsibly. 🦋

mwah 💋 — this was Cataly...d::User(3pm), brought to you by perl v5.36.0 and dated 2022-12-06. love that for us. 🎀✨

📦 where this page comes from