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

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

💖 CGI::Application::Plugin::AnyTemplate::Driver::Petal ✨

okay bestie, so this whole page is literally about CGI::Application::Plugin::AnyTemplate::Driver::Petal (the 3pm one, yes) — it's the driver that plugs Petal into AnyTemplate. Let's get into it 🫶

🌸 DESCRIPTION 🌸

This is a driver for CGI::Application::Plugin::AnyTemplate, and what it does is hold all the implementation details that are specific to rendering templates through the Petal templating system. That's the whole job. Iconic.

The way that all AnyTemplate drivers work? They're all designed to be used the exact same way, no cap. So for the general usage instructions, go read the docs for CGI::Application::Plugin::AnyTemplate. This page is just the Petal-specific tea ☕

🎀 EMBEDDED COMPONENT SYNTAX (Petal) 🎀

ngl, there's a little gotcha here. For embedding components to work properly in Petal, you need to enclose the contents of the included file in tags — like <span> tags, for example:

<span>
var: <span petal:replace="var"></span>
</span>

The Petal syntax for embedding components is literally this:

<span tal:replace="structure CGIAPP/embed 'some_run_mode' some_param1 some_param2 'some literal string 3'">
    this text gets replaced by the output of some_run_mode
</span>

And you can override that with the following configuration variables:

embed_tag_name       # default 'CGIAPP'

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

embed_tag_name       'MYAPP'

then the embedded component tag is gonna look like:

<span tal:replace="structure MYAPP/embed 'some_run_mode'">
    this text gets replaced by the output of some_run_mode
</span>
⚠️ heads up bestie: when you're creating documents to be included as components, they must be complete XML documents. No half-finished vibes, the parser will not be slaying.

✨ CONFIGURATION ✨

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

  • embed_tag_name — the name of the tag used for embedding components. Defaults to "CGIAPP".
  • 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 .xhtml.
  • emulate_associate_query — sooooo this feature is now deprecated and will be removed in a future release, fr fr. 😭

If this config parameter is true, then CGI::Application::Plugin::AnyTemplate::Driver::Petal will copy all of the webapp's query params into the template.

This is similar to what would happen if you used HTML::Template's "associate" feature with the webapp's query object:

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

By default "emulate_associate_query" is false.

All other configuration parameters are passed on unchanged to Petal. Like, they just get handed straight over, no notes 💅

🦋 required_modules 🦋

The "required_modules" function returns the modules required for this driver to operate. In this case: Petal. That's it. That's the list. One module. Main character energy.

💜 DRIVER METHODS 💜

  • initialize — initializes the Petal driver. See the docs for CGI::Application::Plugin::AnyTemplate::Base for details.
  • render_template — fills the Petal object with $self->param

If the param "emulate_associate_query" is true, then it sets params for each of $self->{'webapp'}->query, mimicking HTML::Template's associate mechanism.

It also sets up a CGI::Application::Plugin::AnyTemplate::ComponentHandler object so that the "CGIAPP.embed" callback will work. 🫶

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::HTMLTemplate
  • 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

👑 AUTHOR 👑

Michael Graham, "<mgraham@cpan.org>" — shoutout to the author, absolute legend ✨

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.

and that's the whole page bestie!! this beauty shipped as perl v5.30.3, dated 2020-10-26, and it's part of the CGI::A...:Petal(3pm) manual — go forth and render some templates, you've got this 🦋💅🍓

📦 where this page comes from