TWiki/CGISessionErrorHandlerDotPm.mdwn

   1 # <a name="Package &lt;code&gt;="></a> Package =
   2
   3 <div>
   4   <ul>
   5     <li><a href="#Package =="> Package ==</a></li>
   6   </ul>
   7 </div>
   8
   9 =head1 NAME
  10
  11 CGI::Session::ErrorHandler - error handling routines for CGI::Session
  12
  13 =head1 SYNOPSIS
  14
  15 require CGI::Session::ErrorHandler @ISA = qw( CGI::Session::ErrorHandler );
  16
  17 sub some\_method \{ my $self = shift; unless ( $some\_condition ) \{ return $self-&gt;set\_error("some\_method(): \\$some\_condition isn't met"); \} \}
  18
  19 =head1 DESCRIPTION
  20
  21 CGI::Session::ErrorHandler provides set\_error() and errstr() methods for setting and accessing error messages from within CGI::Session's components. This method should be used by driver developers for providing CGI::Session-standard error handling routines for their code
  22
  23 =head2 METHODS
  24
  25 =over 4
  26
  27 =item set\_error($message)
  28
  29 Implicitly defines $pkg\_name::errstr and sets its value to $message. Return value is B undef.