File Coverage

blib/lib/Data/Phrasebook/Loader/Base.pm

Criterion	Covered	Total	%
statement	27	27	100.0
branch	2	2	100.0
condition			n/a
subroutine	11	11	100.0
pod	6	6	100.0
total	46	46	100.0

package Data::Phrasebook::Loader::Base;
use strict;
use warnings FATAL => 'all';
use base qw( Data::Phrasebook::Debug );
use Carp qw( croak );

use vars qw($VERSION);
$VERSION = '0.35';

=head1 NAME

Data::Phrasebook::Loader::Base - Base loader plugin class.

=head1 SYNOPSIS

  $class->new( %attributes );

=head1 DESCRIPTION

C acts as a base class for phrasebook
plugins.

=cut

my $something = 0;

=head1 CONSTRUCTOR

=head2 new

C instantiates the plugin object, creating a blessed hash of any
attributes passed as arguments.

=cut

sub new {
    my $self = shift;
    my %hash = @_;
    ($hash{class}) = $self =~ /.*::(.*)$/;
    $self->store(3,"$self->new IN")	if($self->debug);
    my $atts = \%hash;
    bless $atts, $self;
    return $atts;
}

=head1 INHERITABLE METHODS

=head2 load

C is an abstract method here. You must define your own in your
subclass. Loads the phrasebook.

=head2 get

C is an abstract method here. You must define your own in your
subclass. Gets the phrase.

=head2 dicts

C is an abstract method here. You must define your own in your
subclass. Returns the list of dictionaries available.

=head2 keywords

C is an abstract method here. You must define your own in your
subclass. Returns the list of keywords available.

=head2 class

Returns the current C of loader.

=cut

sub load     { return }
sub get      { return }
sub dicts    { return () }
sub keywords { return () }
sub class    { return shift->{class} }

1;

__END__