NAME

OpenFrame::WebApp::Error - base class for WebApp Errors.

SYNOPSIS

  # meant to be sub-classed:
  use OpenFrame::WebApp::Error::SomeClass;

  # should export some error flags to your namespace

  use Error qw( :try );
  try {
      throw OpenFrame::WebApp::Error::SomeClass( flag => eSomeError );
  } catch OpenFrame::WebApp::Error::SomeClass with {
      my $e = shift;
      do { ... } if ($e->flag == eSomeError);
  }

DESCRIPTION

This is the base class for Error exceptions in OpenFrame-WebApp. It introduces an error flag to the Error module in an attempt to make localization easier.

Descriptive error flags should be exported from each subclass:

  use base qw( Exporter OpenFrame::WebApp::Error );
  our @EXPORT = qw( eSomethingBad );
  use constant eSomethingBad => 'something.bad';

The value of these constants can then be used as localization keys with the likes of Locale::Gettext or Locale::Maketext.

CONSTRUCTOR

new recognizes '-flag' as a synonym for '-text'. The '-' is optional:

  throw Some::Error( flag => eSomethingBad );

METHODS

flag: set/get the error flag.

AUTHOR

Steve Purkis <spurkis@epn.nu>