CGI::A...::Store(3pm)

okay bestie, welcome to CGI::Application::Plugin::Authentication::Store(3pm) — a User Contributed Perl Documentation page that is literally the base-class blueprint for storage classes. It’s giving “build your own store” energy, and we’re gonna read it together like a group chat. 💅✨

🌸 NAME 🌸

CGI::Application::Plugin::Authentication::Store — Base module for building storage classes for the CGI::Application::Plugin::Authentication plugin. That’s the whole assignment, no cap. 👑

🎀 SYNOPSIS 🎀

so your subclass setup looks like this, and yes you’re gonna override the methods:

package CGI::Application::Plugin::Authentication::Store::MyStore;
use base qw(CGI::Application::Plugin::Authentication::Store);

 sub fetch {
     my $self   = shift;
     my @params = @_;
     ...
 }

 sub save {
     my $self   = shift;
     my %params = @_;
     ...
 }

 sub delete {
     my $self   = shift;
     my @params = @_;
     ...
 }

🦋 DESCRIPTION 🦋

This module is the base class for all storage classes for the CGI::Application::Plugin::Authentication plugin. Each storage class is required to provide three methods — fetch, save, and delete — that fetch, save, and delete data from the store. The information that is saved will be text based, so there is no need to flatten any of the data that is to be stored. bestie, that’s a win. 🌈

🛠️ METHODS TO OVERRIDE 🛠️

The following three (and one optional) methods should be provided by the subclass. Yes, the optional one still matters, iykyk. 💅

🍓 fetch 🍓

This method accepts a list of parameters and will return a list of values from the store matching those parameters. Slay. 💖

🍓 save 🍓

This method accepts a hash of parameters and values and will save those parameters in the store. Iconic behavior. ✨

🍓 delete 🍓

This method accepts a list of parameters and will delete those parameters from the store. Bye bestie. 💀

🍓 clear 🍓

A call to this method will remove all information about the current user out of the store. It should be provided by the subclass, but it is not required to be. So like, optional but highly encouraged, fr fr. 🫶

💫 OTHER METHODS 💫

The following methods are also provided by the CGI::Application::Plugin::Authentication::Store base class.

🌟 new 🌟

This is a constructor that can create a new Store object. It requires an Authentication object as its first parameter, and any number of other parameters that will be used as options depending on which Store object is being created. You shouldn't need to call this as the Authentication plugin takes care of creating Store objects. So don’t stress, bestie. 💅

🌟 initialize 🌟

This method will be called right after a new Store object is created. So any startup customizations can be dealt with here. Main character setup energy. 🎀

🌟 options 🌟

This will return a list of options that were provided when this store was configured by the user. Options on options, periodt. 👑

🌟 authen 🌟

This will return the underlying CGI::Application::Plugin::Authentication object. In most cases it will not be necessary to access this. So like, it’s there if you need it, but don’t make it your whole personality. 🙈

🔗 SEE ALSO 🔗

• CGI::Application::Plugin::Authentication::Store
• CGI::Application::Plugin::Authentication
• perl(1)

💌 AUTHOR 💌

The author is Cees Hek <ceeshek@gmail.com>. Respect the author, bestie. 🫶

📜 LICENCE AND COPYRIGHT 📜

Copyright (c) 2005, SiteSuite. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. 💖

⚠️ DISCLAIMER OF WARRANTY ⚠️

okay so legally, because this software is licensed free of charge, there is no warranty for the software, to the extent permitted by applicable law. Except when otherwise stated in writing, the copyright holders and/or other parties provide the software "AS IS" without warranty of any kind, either expressed or implied, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. The entire risk as to the quality and performance of the software is with you. Should the software prove defective, you assume the cost of all necessary servicing, repair, or correction. 😭 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 💀

mwah 💋 — footer tea: this page is from perl v5.38.2, dated 2024-06-29, and the manpage tag is CGI::A...::Store(3pm). Byeee, go build that store bestie 🫶✨