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 =head1 NAME
  10
  11 Maypole::Constants - Maypole predefined constants
  12
  13 =head1 SYNOPSIS
  14
  15     use Maypole::Constants;
  16
  17     sub authenticate {
  18         if (valid_user()) {
  19             return OK;
  20         } else {
  21             return DECLINED
  22         }
  23     }
  24
  25 =head1 DESCRIPTION
  26
  27 This class defines constants for use with Maypole
  28
  29 =head1 CONSTANTS
  30
  31 =head3 OK
  32
  33 =head3 DECLINED
  34
  35 =head3 ERROR
  36
  37 =head1 SEE ALSO
  38
  39 L<Maypole>
  40
  41 =head1 MAINTAINER
  42
  43 Sebastian Riedel, c<sri@oook.de>
  44
  45 =head1 AUTHOR
  46
  47 Simon Cozens, C<simon@cpan.org>
  48
  49 =head1 LICENSE
  50
  51 You may distribute this code under the same terms as Perl itself.
  52
  53 =cut
  54 1;