lib/Maypole/Constants.pm

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