Template::Exception
Author: Andy Wardley

TT2 Home Page

- Modules
- Template::*
- Exception.pm

Click to view the menu. It's very nice. Click to hide the menu and go all widescreen!
Back

#### Template::Document

Compiled template document object Up

#### Template::* Modules

Next

#### Template::Filters

Post-processing filters for template blocks

# Template::Exception

## Exception handling class module

# Contents

Top

# SYNOPSIS

Top

    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

Top

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

Top

## type()

Top

Returns the exception type.

## info()

Top

Returns the exception information.

# AUTHOR

Top

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

# COPYRIGHT

Top

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

Top

Template, Template::Context

http://template-toolkit.org/docs/modules/Template/Exception.html