Templat...onstants(3)

💖 NAME 💖

okay bestie, welcome to Templat...onstants(3) from User Contributed Perl Documentation — this is the page for Template::Constants, and it defines constants for the Template Toolkit. slay. 💅

---

✨ SYNOPSIS ✨

use Template::Constants qw( :status :error :all );

---

🦋 DESCRIPTION 🦋

The Template::Constants module defines a bunch of constants used by the Template package, and it can optionally export them into the caller's namespace. cute, useful, iconic. 🎀

You can use the constants by spelling out the Template::Constants package explicitly:

use Template::Constants;
print Template::Constants::STATUS_DECLINED;

You can also import constants into your own namespace by naming them as options to the use Template::Constants statement:

use Template::Constants qw( STATUS_DECLINED );
print STATUS_DECLINED;

Alternatively, you can specify one of these tagset identifiers to import whole sets of constants: ':status', ':error', ':all'.

use Template::Constants qw( :status );
print STATUS_DECLINED;

Want the full lore on exporting variables? Consult the documentation for the Exporter module. it's giving reference material, and honestly? valid. 📚✨

---

🌈 EXPORTABLE TAG SETS 🌈

The following tag sets and associated constants are defined — here's the whole roster, no cap:

• :status
  • STATUS_OK — no problem, continue
  • STATUS_RETURN — ended current block then continue (ok)
  • STATUS_STOP — controlled stop (ok)
  • STATUS_DONE — iterator is all done (ok)
  • STATUS_DECLINED — provider declined to service request (ok)
  • STATUS_ERROR — general error condition (not ok)
• :error
  • ERROR_RETURN — return a status code (e.g. 'stop')
  • ERROR_FILE — file error: I/O, parse, recursion
  • ERROR_UNDEF — undefined variable value used
  • ERROR_PERL — error in [% PERL %] block
  • ERROR_FILTER — filter error
  • ERROR_PLUGIN — plugin error
• :chomp — for PRE_CHOMP and POST_CHOMP
  • CHOMP_NONE — do not remove whitespace
  • CHOMP_ONE — remove whitespace to newline
  • CHOMP_ALL — old name for CHOMP_ONE (deprecated)
  • CHOMP_COLLAPSE — collapse whitespace to a single space
  • CHOMP_GREEDY — remove all whitespace including newlines
• :debug
  • DEBUG_OFF — do nothing
  • DEBUG_ON — basic debugging flag
  • DEBUG_UNDEF — throw undef on undefined variables
  • DEBUG_VARS — general variable debugging
  • DEBUG_DIRS — directive debugging
  • DEBUG_STASH — general stash debugging
  • DEBUG_CONTEXT — context debugging
  • DEBUG_PARSER — parser debugging
  • DEBUG_PROVIDER — provider debugging
  • DEBUG_PLUGINS — plugins debugging
  • DEBUG_FILTERS — filters debugging
  • DEBUG_SERVICE — context debugging
  • DEBUG_ALL — everything
  • DEBUG_CALLER — add caller file/line info
  • DEBUG_FLAGS — bitmap used internally
• :all
  • All the above constants.

---

👑 AUTHOR 👑

the icon behind this page is Andy Wardley <abw@wardley.org> <http://wardley.org/>. periodt. 💜

---

📜 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.

---

🎀 SEE ALSO 🎀

Template, "Exporter"

---

that's the whole page, bestie 💖 this one's from perl v5.42.0, dated 2024-06-23 — go be iconic with your constants 🌈✨