aboutsummaryrefslogtreecommitdiffstats
path: root/lib/Youri/Check/Maintainer/Preferences.pm
blob: 5fbe2039aa8f6353d4d55c9c3219d51f4d2affa4 (plain)
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
# $Id: Preferences.pm 1179 2006-08-05 08:30:57Z warly $
package Youri::Check::Maintainer::Preferences;

=head1 NAME

Youri::Check::Maintainer::Preferences - Abstract maintainer preferences

=head1 DESCRIPTION

This abstract class defines Youri::Check::Maintainer::Preferences interface.

=head1 SYNOPSIS

    use Youri::Check::Maintainer::Preferences::Foo;

    my $preferences = Youri::Check::Maintainer::Preferences::Foo->new();

=cut

use warnings;
use strict;
use Carp;

=head1 CLASS METHODS

=head2 new(%args)

Creates and returns a new Youri::Check::Maintainer::Preferences object.

Warning: do not call directly, call subclass constructor instead.

=cut

sub new {
    my $class = shift;
    croak "Abstract class" if $class eq __PACKAGE__;

    my %options = (
        test    => 0,     # test mode
        verbose => 0,     # verbose mode
        @_
    );

    my $self = bless {
        _test    => $options{test},
        _verbose => $options{verbose},
    }, $class;

    $self->_init(%options);

    return $self;
}

sub _init {
    # do nothing
}

=head2 get_preference($maintainer, $plugin, $item)

Returns preference of given maintainer for given plugin and configuration item.

=head1 SUBCLASSING

The following methods have to be implemented:

=over

=item get

=back

=head1 COPYRIGHT AND LICENSE

Copyright (C) 2002-2006, YOURI project

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

=cut

1;