oracular (3) Template::Exception.3pm.gz

Provided by: libtemplate-perl_2.27-1build10_amd64 bug

NAME
       Template::Exception - Exception handling class module


SYNOPSIS
           use Template::Exception;

           my $exception = Template::Exception->new($type, $info);
           $type = $exception->type;
           $info = $exception->info;
           ($type, $info) = $exception->type_info;

           print $exception->as_string();

           $handler = $exception->select_handler(\@candidates);


DESCRIPTION
       The "Template::Exception" module defines an object class for representing exceptions within the template
       processing life cycle.  Exceptions can be raised by modules within the Template Toolkit, or can be
       generated and returned by user code bound to template variables.

       Exceptions can be raised in a template using the "THROW" directive,

           [% THROW user.login 'no user id: please login' %]

       or by calling the throw() method on the current Template::Context object,

           $context->throw('user.passwd', 'Incorrect Password');
           $context->throw('Incorrect Password');    # type 'undef'

       or from Perl code by calling die() with a "Template::Exception" object,

           die (Template::Exception->new('user.denied', 'Invalid User ID'));

       or by simply calling die() with an error string.  This is automagically caught and converted to an
       exception of '"undef"' type (that's the literal string '"undef"' rather than Perl's undefined value)
       which can then be handled in the usual way.

           die "I'm sorry Dave, I can't do that";

       Each exception is defined by its type and a information component (e.g. error message).  The type can be
       any identifying string and may contain dotted components (e.g. '"foo"', '"foo.bar"', '"foo.bar.baz"').
       Exception types are considered to be hierarchical such that '"foo.bar"' would be a specific type of the
       more general '"foo"' type.


METHODS
   type()
       Returns the exception type.

   info()
       Returns the exception information.


AUTHOR
       Andy Wardley <abw@wardley.org> <http://wardley.org/>


       Copyright (C) 1996-2007 Andy Wardley.  All Rights Reserved.

       This module is free software; you can redistribute it and/or modify it under the same terms as Perl
       itself.


SEE ALSO
       Template, Template::Context