Perl Diver 2.31
Main Environment Variables Perl Default Values Perl Config - Summary Perl Config - Full Installed Modules List Directory uptime Docs

Module Documentation
Details and documentation about a specific module, including version and documentation (if available). Note that while links to perldoc.com and search.cpan.org are provided, the module may be part of a larger distribution. If you reach a File Not Found page on either site, please try the parent module.

Template::Exception

Name Template::Exception
Version 2.7
Located at /usr/lib64/perl5/vendor_perl
File /usr/lib64/perl5/vendor_perl/Template/Exception.pm
Is Core No
Search CPAN for this module Template::Exception
Documentation Template::Exception
Module Details Template::Exception

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 the Template::Context manpage 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

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, the Template::Context manpage

Perl Diver brought to you by ScriptSolutions.com © 1997- 2024