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

BARBIE / Labyrinth-5.32 / lib / Labyrinth / Plugins.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

              
package Labyrinth::Plugins;
use warnings;
use strict;
=head1 NAME
Labyrinth::Plugins - Plugin Manager for Labyrinth
=head1 SYNOPSIS
  load_plugins(@plugins);
  my $plugin  = get_plugin($class);
  my @plugins = get_plugins();
=head1 DESCRIPTION
Although loaded via the main Labyrinth module, this module is used by others
to quickly reference all the available plugins.
=cut
use vars qw($VERSION @ISA %EXPORT_TAGS @EXPORT @EXPORT_OK);
$VERSION = '5.32';
# -------------------------------------
# Export Details
require Exporter;
@ISA = qw(Exporter);
%EXPORT_TAGS = (
    'all' => [ qw(load_plugins get_plugin get_plugins) ],
);
@EXPORT_OK  = ( @{$EXPORT_TAGS{'all'}} );
@EXPORT     = ( @{$EXPORT_TAGS{'all'}} );
# -------------------------------------
# Library Modules
use Labyrinth::Audit;
use Labyrinth::Variables;
# -------------------------------------
# Variables
my (%plugins,%classes);
# -------------------------------------
# The Program
=head1 FUNCTIONS
=over
=item load_plugins()
Loads plugins found under the plugins directory.
=item get_plugin($class)
Returns the appropriate plugin for the given class.
=item get_plugins()
Returns all available plugins.
=back
=cut
sub load_plugins {
    $classes{$_} = 1    for(@_);
}
sub get_plugin {
    my $class = shift;
    my $method = 'new';
     
    return $plugins{$class} if($plugins{$class});
    return                  unless($classes{$class});
    eval { 
        eval "CORE::require $class";
        $plugins{$class} = $class->$method(@_);
    };
    if($@) {
        $tvars{errcode} = 'ERROR';
        LogError("action: class=$class, method=new, FAULT: $@");
    }
    return $plugins{$class} || undef;
}
sub get_plugins {
    return values %plugins;
}
1;
__END__
=head1 AUTHOR
Barbie, <barbie@missbarbell.co.uk> for
Miss Barbell Productions, L<http://www.missbarbell.co.uk/>
=head1 COPYRIGHT & LICENSE
  Copyright (C) 2002-2015 Barbie for Miss Barbell Productions
  All Rights Reserved.
  This module is free software; you can redistribute it and/or
  modify it under the Artistic License 2.0.
=cut