Dancer...Example(3pm)

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

✨ NAME ✨

Dancer::Plugin::Auth::Extensible::Example — it's giving example authentication provider 💅

(that's the Dancer...Example(3pm) page bestie, welcome to the group chat 🫶)

🌸 DESCRIPTION 🌸

okay so. this class is literally meant to be an example of what an authentication provider class should do. that's the whole job. it is not intended for serious use (clearly 💀 like be so for real).

if you wanna know how to actually use the authentication framework — including how to pick a provider that isn't this one — go read Dancer::Plugin::Auth::Extensible. that's the main character fr fr 👑

but — and this is the slay part — if you just wanna test the framework, or you want an example to work from while you build your own authentication provider class, then lowkey this might actually be of use to you 💖

🎀 Class methods 🎀

💫 authenticate_user

Given the username and password entered by the user, return true if they are authenticated, or false if not.

that's it. that's the vibe check. ✨

🦋 get_user_details

Given a username, return details about the user.

the details returned will vary depending on the provider — some providers may be able to return various data about the user, some may not, depending on the authentication source. iykyk 🌈

Details should be returned as a hashref. no cap.

🍓 get_user_roles

Given a username, return a list of roles that user has.

periodt. 👑

and that's the whole page bestie!! this lil icon was documented by the User Contributed Perl Documentation crew, running perl v5.36.0, dated 2023-01-05 — and it's still out here being the Dancer...Example(3pm) moment we all needed. mwah 💋 🎀✨

📦 where this page comes from