Constructors¶

Standard Moo with Dancer2::Core::Role::Template extensions.

Accessors¶

$obj->tt()

Returns the Log::Report::Template object which is performing the template processing. This object gets instantiated based on values found in the Dancer2 configuration file.

Action¶

$obj->addTextDomain(%options)

Forwards the %options to Log::Report::Template::addTextdomain().

example:

  my $lexicon = $directory;  # f.i. $directory/<domain>/nl_NL.utf-8.po
  my $tables  = Log::Report::Translator::POT->new(lexicon => $lexicon);
  (engine 'template')->addTextdomain(name => 'mydomain')->configure(translator => $tables);
    

$obj->render($template, \%tokens)

Renders the template. The first arg is a filename for the template file or a reference to a string that contains the template. The second arg is a hashref for the tokens that you wish to pass to Template::Toolkit for rendering.

When a translation language is set, then this renderer adds the following variables: "language" (like "nl"), "language_territory" (like "nl_BE"), and "locale" (like "nl_BE.utf8").

Dancer2 Configuration¶

Most configuration variables are available when creating a new instance of a Template::Toolkit object can be declared in your config.yml file. For example:

  template: TTLogReport
  engines:
    template:
      TTLogReport:
        start_tag: '<%'
        end_tag:   '%>'

(Note: "start_tag" and "end_tag" are regexes. If you want to use PHP-style tags, you will need to list them as "<\?" and "\?>".) See Template::Manual::Config for the configuration variables.

In addition to the standard configuration variables, the option "show_private_variables" is also available. Template::Toolkit, by default, does not render private variables (the ones starting with an underscore). If in your project it gets easier to disable this feature than changing variable names, add this option to your configuration.

  show_private_variables: true

Warning: Given the way Template::Toolkit implements this option, different Dancer2 applications running within the same interpreter will share this option!

Advanced Customization¶

Module Dancer2::Template::TemplateToolkit describes how to extend the Template by wrapping the "_build_engine" method. The instantiation trick is insufficient for a bit more complex modules, like our Log::Report translation feature. You may be able to extend this module with your own templater, however.

  # in config.yml
  engines:
    template:
      TTLogReport:
        start_tag: '<%'
        end_tag:   '%>'
        templater: Log::Report::Template  # default