Templat...xception(3)

💖 NAME 💖

Okay bestie, this is the Template::Exception page — yep, the Templat...xception(3) manual from the User Contributed Perl Documentation girlies 💅.

Template::Exception — exception handling class module. Periodt. 👑

---

✨ SYNOPSIS ✨

Here’s the exact little code moment from the top, no cap:

           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, bestie. Exceptions can be raised by modules within the Template Toolkit, or can be generated and returned by user code bound to template variables. It’s giving “error handling but make it object-oriented” energy. 💅

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 — and yes, that’s the literal string "undef", not Perl’s undefined value, iykyk — 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 an information component (e.g. an 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. Obsessed with the structure, honestly. 🦋

---

🎀 METHODS 🎀

✨ type() ✨

Returns the exception type. Slay.

🌸 info() 🌸

Returns the exception information. Iconic.

---

👑 AUTHOR 👑

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

---

💜 COPYRIGHT 💜

Copyright (C) 1996-2022 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. Fr fr. 🫶

---

🌈 SEE ALSO 🌈

• Template
• Template::Context

---

okay that’s the whole page, bestie — brought to you by perl v5.42.0, dated 2024-06-23, and filed under Templat...xception(3). mwah 💋✨