SUPPORTED USAGE¶

By default, the "[% %]" tag style is used. You can change the start tag and end tag by specifying them at object creation :

  my $template = Dancer2::Template::Implementation::ForkedTiny->new(
      start_tag => '<%',
      end_tag => '%>,
  );

In the rest of the documentation, "[% %]" will be used, but it can be of course your specified start / end tags.

Both the "[%+ +%]" style explicit whitespace and the "[%- -%]" style explicit chomp are support, although the "[%+ +%]" version is unneeded in practice as Dancer2::Template::Implementation::ForkedTiny does not support default-enabled "PRE_CHOMP" or "POST_CHOMP".

Variable expressions in the form "[% foo.bar.baz %]" are supported.

Appropriate simple behaviours for "ARRAY" references, "HASH" references and objects are supported. "VMethods" such as [% array.length %] are not supported at this time.

If the resulting expression is a CodeRef, it'll be evaluated.

"IF", "ELSE" and "UNLESS" conditional blocks are supported, but only with simple "[% foo.bar.baz %]" conditions.

Support for looping (or rather iteration) is available in simple "[% FOREACH item IN list %]" form is supported. Other loop structures are not supported. Because support for arbitrary or infinite looping is not available, Dancer2::Template::Implementation::ForkedTiny templates are not turing complete. This is intentional.

All of the four supported control structures "IF"/"ELSE"/"UNLESS"/"FOREACH" can be nested to arbitrary depth.

The treatment of "_private" hash and method keys is compatible with Template Toolkit, returning null or false rather than the actual content of the hash key or method.

Anything beyond the above is currently out of scope.

new¶

  my $template = Dancer2::Template::Implementation::ForkedTiny->new(
      TRIM => 1,
  );

The "new" constructor is provided for compatibility with Template Toolkit.

The only parameter it currently supports is "TRIM" (which removes leading and trailing whitespace from processed templates).

Additional parameters can be provided without error, but will be ignored.

process¶

  # DEPRECATED: Return template results (emits a warning)
  my $text = $template->process( \$input, $vars );
  # Print template results to STDOUT
  $template->process( \$input, $vars );
  # Generate template results into a variable
  my $output = '';
  $template->process( \$input, $vars, \$output );

The "process" method is called to process a template.

The first parameter is a reference to a text string containing the template text. A reference to a hash may be passed as the second parameter containing definitions of template variables.

If a third parameter is provided, it must be a scalar reference to be populated with the output of the template.

For a limited amount of time, the old deprecated interface will continue to be supported. If "process" is called without a third parameter, and in scalar or list contest, the template results will be returned to the caller.

If "process" is called without a third parameter, and in void context, the template results will be print()ed to the currently selected file handle (probably "STDOUT") for compatibility with Template.