1CGI::Application::PlugiUns:e:rAuCtoChnGetInr:ti:ibAcupatptelidiocnPa:et:riSlotnoD:ro:ecP(ul3mu)egnitna:t:iAounthentication::Store(3)
2
3
4

NAME

6       CGI::Application::Plugin::Authentication::Store - Base module for
7       building storage classes for the
8       CGI::Application::Plugin::Authentication plugin
9

SYNOPSIS

11        package CGI::Application::Plugin::Authentication::Store::MyStore;
12        use base qw(CGI::Application::Plugin::Authentication::Store);
13
14         sub fetch {
15             my $self   = shift;
16             my @params = @_;
17             ...
18         }
19
20         sub save {
21             my $self   = shift;
22             my %params = @_;
23             ...
24         }
25
26         sub delete {
27             my $self   = shift;
28             my @params = @_;
29             ...
30         }
31

DESCRIPTION

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

METHODS TO OVERRIDE

40       The following three (and one optional) methods should be provided by
41       the subclass.
42
43   fetch
44       This method accepts a list of parameters and will return a list of
45       values from the store matching those parameters.
46
47   save
48       This method accepts a hash of parameters and values and will save those
49       parameters in the store.
50
51   delete
52       This method accepts a list of parameters and will delete those
53       parameters from the store.
54
55   clear
56       A call to this method will remove all information about the current
57       user out of the store (should be provided by the subclass, but is not
58       required to be).
59

OTHER METHODS

61       The following methods are also provided by the
62       CGI::Application::Plugin::Authentication::Store base class.
63
64   new
65       This is a constructor that can create a new Store object.  It requires
66       an Authentication object as its first parameter, and any number of
67       other parameters that will be used as options depending on which Store
68       object is being created.  You shouldn't need to call this as the
69       Authentication plugin takes care of creating Store objects.
70
71   initialize
72       This method will be called right after a new Store object is created.
73       So any startup customizations can be dealt with here.
74
75   options
76       This will return a list of options that were provided when this store
77       was configured by the user.
78
79   authen
80       This will return the underlying
81       CGI::Application::Plugin::Authentication object.  In most cases it will
82       not be necessary to access this.
83

SEE ALSO

85       CGI::Application::Plugin::Authentication::Store,
86       CGI::Application::Plugin::Authentication, perl(1)
87

AUTHOR

89       Cees Hek <ceeshek@gmail.com>
90

92       Copyright (c) 2005, SiteSuite. All rights reserved.
93
94       This module is free software; you can redistribute it and/or modify it
95       under the same terms as Perl itself.
96

DISCLAIMER OF WARRANTY

98       BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
99       FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT
100       WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER
101       PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND,
102       EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
103       WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
104       ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
105       YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
106       NECESSARY SERVICING, REPAIR, OR CORRECTION.
107
108       IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
109       WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
110       REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE
111       TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR
112       CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
113       SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
114       RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
115       FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
116       SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
117       DAMAGES.
118
119
120
121perl v5.30.1                CGI::A2p0p2l0i-c0a1t-i2o9n::Plugin::Authentication::Store(3)
Impressum