File Coverage

blib/lib/OpenPlugin/Plugin.pm

Criterion	Covered	Total	%
statement	33	40	82.5
branch	4	4	100.0
condition	5	9	55.5
subroutine	8	11	72.7
pod	0	6	0.0
total	50	70	71.4

package OpenPlugin::Plugin;

# $Id: Plugin.pm,v 1.22 2003/04/28 17:43:48 andreychek Exp $

use strict;
use Class::Factory  0.04 qw();
use base                 qw( Class::Factory );
use Log::Log4perl        qw( get_logger );

use constant STATE  => '_state';

$OpenPlugin::Plugin::VERSION = sprintf("%d.%02d", q$Revision: 1.22 $ =~ /(\d+)\.(\d+)/);

my $logger = get_logger();

sub load {
    my $self = shift;
    my $class = ref $self;
    $logger->info( "Calling default method load() for ($class)" );
    return $class;
}

sub OP {
    my $self = shift;
    my $class = ref $self;

    $self->{_m}{OP}->exception->throw("In ($class): OP() must be implemented in plugin");
}

# Constructor for all plugins
sub new {
    my ( $pkg, $type, $OP, @params ) = @_;
    my $class = $pkg->get_factory_class( $type );
    my $self = bless( { _m => { OP => $OP } }, $class );
    $self->OP->state( $class, {} );
    return $self->init( @params );
}

# Retrieve state information for whatever plugin is calling us
sub state {
    my ( $self, $key, $value ) = @_;

    my $plugin = ref $self;

    #$plugin =~ m/OpenPlugin::(\w+)/;
    #$plugin = $1;

    # Just a key passed in, return a single value
    if( defined $key and not defined $value ) {
        $logger->info("Calling state() for [$plugin] with key [$key].");

        return $self->OP->state->{ $plugin }{ $key };
    }

    # We have a key and value, so assign the value to the key
    elsif( defined $key and defined $value ) {
        $logger->info("Calling state() for [$plugin] with key [$key] and ",
                      "value [$value].");

        return $self->OP->state->{ $plugin }{ $key } = $value;
    }

    # No key or value, return the entire state hash
    else {
        $logger->info("Calling state() for [$plugin] with no parameters.");

        return $self->OP->state->{ $plugin };
    }

}

sub cleanup  {
    my ( $self ) = @_;

    my $plugin = ref $self || $self;
    #$plugin =~ m/OpenPlugin::(\w+)/;
    #$plugin = $1;

    return $self->OP->state->{ $plugin } = {};
}

sub shutdown { return 1 }

1;

__END__