CGI::A...emplate(3pm)

📦 version 0.18, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu resolute, ubuntu stonking

💖 NAME 💖

CGI::Application::Plugin::AnyTemplate::Driver::HTMLTemplate — the HTML::Template driver for AnyTemplate, bestie 💅

✨ DESCRIPTION ✨

okay so listen. This is a driver for CGI::Application::Plugin::AnyTemplate, and what it does is handle all the implementation details that are specific to rendering templates through the HTML::Template templating system. that's its whole job. it's giving specialist 🎀

Every single one of the "AnyTemplate" drivers is designed to be used the exact same way, no cap. So if you wanna know how to actually use it in general, go read the docs for CGI::Application::Plugin::AnyTemplate. that's where the general usage instructions live, iykyk 🦋

🌸 EMBEDDED COMPONENT SYNTAX (HTML::Template) 🌸

Syntax

The HTML::Template syntax for embedding components is, and I'm quoting this <em>verbatim</em> because it matters:

<TMPL_VAR NAME="cgiapp_embed('some_run_mode', param1, param2, 'literal string3')">

(Support for parameter passing is limited. See the note on parameters below. yes, below. keep reading. don't skip 😭)

This can be overridden by the following configuration variables:

embed_tag_name       # default 'cgiapp_embed'

So like, for instance, if you set the following value in your configuration file:

embed_tag_name       '***component***'

Then the embedded component tag will look like:

<TMPL_VAR NAME="***component***('some_run_mode')">

slay. customized. 💅

Parameters

Since HTML::Template doesn't support parameter passing in the template, the HTMLTemplate driver emulates this behaviour. fake it till you make it, honestly 🫶

The parameter list passed to the embed subroutine is parsed before the template is parsed. Literal strings (strings enclosed in single or double quotes) are passed verbatim to the target run mode. Params not enclosed in quotes are looked up in $self->param; the resulting literal or looked-up values are passed to the target run mode. And finally, the return value of the run mode (its output) is passed as a parameter value to the template. it's a whole pipeline bestie 🌈

⚠️ Note that the param lookup scheme is somewhat simplistic. For instance, it does not respect the scope of loops or conditional constructs within the template. so like, don't come for me when your loop-scoped vars act up, it literally says so 😭

For proper parameter handling using HTML::Template-style templates, use either the CGI::Application::Plugin::AnyTemplate::Driver::HTMLTemplateExpr or the CGI::Application::Plugin::AnyTemplate::Driver::HTMLTemplatePluggable driver instead. those are the upgrade. main character drivers 👑

🎀 CONFIGURATION 🎀

The CGI::Application::Plugin::AnyTemplate::Driver::HTMLTemplate driver accepts the following config parameters:

  • embed_tag_name — The name of the tag used for embedding components. Defaults to cgiapp_embed.
  • template_extension — If auto_add_template_extension is true, then CGI::Application::Plugin::AnyTemplate will append the value of template_extension to filename. By default the template_extension is .html.
  • associate_query — This feature is now deprecated and will be removed in a future release. 💀 so like, don't get attached, bestie.

If this config parameter is true, then CGI::Application::Plugin::AnyTemplate::Driver::HTMLTemplate will copy all of the webapp's query params into the template using HTML::Template's associate mechanism:

my $driver = HTML::Template->new(
    associate => $self->query,
);

By default associate_query is false.

If you provide an associate config parameter of your own, that will disable the associate_query functionality. your config, your call ✨

All other configuration parameters are passed on unchanged to HTML::Template. untouched. unbothered. 🌸

required_modules

The required_modules function returns the modules required for this driver to operate. In this case: HTML::Template. that's it. that's the list. one (1) module. minimalism ate 🎀

💅 DRIVER METHODS 💅

  • initialize — Initializes the HTMLTemplate driver. See the docs for CGI::Application::Plugin::AnyTemplate::Base for details.
  • render_template — Fills the HTML::Template object with $self->param, replacing any magic *embed* tags with the content generated by the appropriate runmodes.

Returns the output of the filled template as a string reference.

See the docs for CGI::Application::Plugin::AnyTemplate::Base for details.

🔥 SEE ALSO 🔥

  • CGI::Application::Plugin::AnyTemplate
  • CGI::Application::Plugin::AnyTemplate::Base
  • CGI::Application::Plugin::AnyTemplate::ComponentHandler
  • CGI::Application::Plugin::AnyTemplate::Driver::HTMLTemplateExpr
  • CGI::Application::Plugin::AnyTemplate::Driver::HTMLTemplatePluggable
  • CGI::Application::Plugin::AnyTemplate::Driver::TemplateToolkit
  • CGI::Application::Plugin::AnyTemplate::Driver::Petal
  • CGI::Application
  • Template::Toolkit
  • HTML::Template
  • HTML::Template::Pluggable
  • HTML::Template::Plugin::Dot
  • Petal
  • Exporter::Renaming
  • CGI::Application::Plugin::TT

the whole friend group, assembled 🫶

👑 AUTHOR 👑

Michael Graham, <mgraham@cpan.org> — iconic behavior, honestly 💜

Copyright 2005 Michael Graham, All Rights Reserved.

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

okay bestie that's the whole page, we did it 🎉 this was documented by User Contributed Perl Documentation as CGI::A...emplate(3pm), shipped with perl v5.30.3 and dated 2020-10-26. go forth and render, periodt 💖✨🦋

📦 where this page comes from