lib/Maypole/Constants.pm

   1 package Maypole::Constants;
   2 use strict;
   3 use base 'Exporter';
   4 use constant OK       => 0;
   5 use constant DECLINED => -1;
   6 use constant ERROR    => -1;
   7 our @EXPORT = qw(OK DECLINED ERROR);
   8 our $VERSION = "1." . sprintf "%04d", q$Rev$ =~ /: (\d+)/;
   9
  10 1;
  11
  12 =head1 NAME
  13
  14 Maypole::Constants - Maypole predefined constants
  15
  16 =head1 SYNOPSIS
  17
  18     use Maypole::Constants;
  19
  20     sub authenticate {
  21         if (valid_user()) {
  22             return OK;
  23         } else {
  24             return DECLINED
  25         }
  26     }
  27
  28 =head1 DESCRIPTION
  29
  30 This class defines constants for use with Maypole
  31
  32 =head2 CONSTANTS
  33
  34 =head3 OK
  35
  36 =head3 DECLINED
  37
  38 =head3 ERROR
  39
  40 =head1 SEE ALSO
  41
  42 L<Maypole>
  43
  44 =head1 MAINTAINER
  45
  46 Aaron Trevena, c<teejay@droogs.org>
  47
  48 =head1 AUTHOR
  49
  50 Simon Cozens, C<simon@cpan.org>
  51
  52 =head1 LICENSE
  53
  54 You may distribute this code under the same terms as Perl itself.
  55
  56 =cut