The Perl and Raku Conference 2025: Greenville, South Carolina - June 27-29 Learn more

TWITTEK / Konstrukt-0.5-beta5 / lib / Konstrukt / Plugin / usermanagement.pm 

            

              
1
2
—
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
—
58
59
60
61
62
63
64
65
66
67
68
—
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
—
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
—
112
113
114
115
116
117
118
119
120
121
122
123
124
—
125
126
127
128
129
130
131
132
133
134
135
136
137
138

              
#FEATURE: user administration: manually add, delete, modify users
#FEATURE: access control lists: user/group/object
=head1 NAME
Konstrukt::Plugin::usermanagement - User management. Extensible with plugins.
=head1 SYNOPSIS
         
=head2 Tag interface
        <!-- show basic user management -->
        <& usermanagement::basic / &>
         
        <!-- show personal data -->
        <& usermanagement::personal / &>
         
        <!-- show user levels -->
        <& usermanagement::personal / &>
         
        <!-- ... see the docs of each usermanagement plugin -->
=head2 Perl interface
        #within your plugin's init sub you should use the wanted modules
        use Konstrukt::Plugin;
        sub init {
                #...
                #example for the basic plugin. the usage of the others is similar.
                $self->{user_basic} = use_plugin 'usermanagement::basic' or return undef;
        }
        #then you may use the plugin
        sub my_method {
                my $uid = $self->{user_basic}->id();
        }
=head1 DESCRIPTION
Parent class for the Konstrukt user management plugins.
Actually this one doesn't do anything. All work is done in each
usermanagement::* plugin (see L</SEE ALSO>).
=head1 CONFIGURATION
See the documentation for each usermanagement plugin (see L</SEE ALSO>).
=cut
package Konstrukt::Plugin::usermanagement;
use strict;
use warnings;
use base 'Konstrukt::Plugin'; #inheritance
use Konstrukt::Debug;
=head1 METHODS
=head2 execute_again
No, this plugin won't return dynamic nodes.
=cut
sub execute_again {
        return 0;
}
=head2 prepare
Prepare method
B<Parameters>:
=over
=item * $tag - Reference to the tag (and its children) that shall be handled.
=back
=cut
sub prepare { 
        my ($self, $tag) = @_;
        #Don't do anything beside setting the dynamic-flag
        $tag->{dynamic} = 1;
         
        return undef;
}
#= /prepare
=head2 execute
Execute method
B<Parameters>:
=over
=item * $tag - Reference to the tag (and its children) that shall be handled.
=back
=cut
sub execute {
        my ($self, $tag) = @_;
        #the work is done each plugin
        return undef;
}
#= /execute
=head2 init
Initializes this object. Will load the plugins.
init will be called by the constructor.
=cut
sub init {
        return 1;
}
#= /init
1;
=head1 AUTHOR
Copyright 2006 Thomas Wittek (mail at gedankenkonstrukt dot de). All rights reserved. 
This document is free software.
It is distributed under the same terms as Perl itself.
=head1 SEE ALSO
L<Konstrukt::Plugin::usermanagement::basic>, L<Konstrukt::Plugin::usermanagement::level>,
L<Konstrukt::Plugin::usermanagement::personal>, L<Konstrukt::Plugin>, L<Konstrukt>
=cut