Daisuke Murase > Text-MicroTemplate-0.07 > Text::MicroTemplate

Download:
Text-MicroTemplate-0.07.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.07   Source   Latest Release: Text-MicroTemplate-0.20

NAME ^

Text::MicroTemplate

SYNOPSIS ^

    use Text::MicroTemplate qw(:all);

    # compile template, and render
    $renderer = build_mt('hello, <?= $_[0] ?>');
    $html = $renderer->('John')->as_string;

    # or in one line
    $html = render_mt('hello, <?= $_[0] ?>', 'John')->as_string;

    # complex form
    $mt = Text::MicroTemplate->new(
        template => 'hello, <?= $query->param('user') ?>,
    );
    $code = $mt->code;
    $renderer = eval << "..." or die $@;
    sub {
        my \$query = shift;
        $code->();
    }
    ...
    $html = $renderer->(CGI->new)->as_string;

DESCRIPTION ^

Text::MicroTemplate is a standalone, fast, intelligent, extensible template engine with following features.

standalone

Text::MicroTemplate does not rely on other CPAN modules.

fast

Based on Mojo::Template, expressions in the template is perl code.

intelligent

Text::MicroTemplate automatically escapes variables when and only when necessary.

extensible

Text::MicroTemplate does not provide features like template cache or including other files by itself. However, it is easy to add you own (that suites the most to your application), by wrapping the result of the module (which is a perl expression).

The module only provides basic building blocks for a template engine. Refer to Text::MicroTemplate::File for higher-level interface.

TEMPLATE SYNTAX ^

    # output the result of expression with automatic escape
    <?= $expr ?>             (tag style)
    ?= $expr                 (per-line)

    # execute perl code (tag style)
    <? foo() ?>
    ? foo()

    # comment (tag style)
    <?# comment ?>
    ?# comment

    # loops
    <ul>
    ? for my $item (@list) {
    <li><?= $item ?></li>
    ? }
    </ul>

EXPORTABLE FUNCTIONS ^

build_mt($template)

Returns a subref that renders given template. Parameters are equivalent to Text::MicroTemplate->new.

    # build template renderer at startup time and use it multiple times
    my $renderer = build_mt('hello, <?= $_[0] ?>!');

    sub run {
        ...
        my $hello = $renderer->($query->param('user'));
        ...
    }

render_mt($template, @args)

Utility function that combines build_mt and call to the generated template builder.

    # render
    $hello = render_mt('hello, <?= $_[0] ?>!', 'John');

    # print as HTML
    print $hello->as_string;

    # use the result in another template (no double-escapes)
    $enc = render_mt('<h1><?= $_[0] ?></h1>', $hello);

Intertally, the function is equivalent to:

    build_mt($template)->(@_);

encoded_string($str)

wraps given string to an object that will not be escaped by the template engine

OO-STYLE INTERFACE ^

Text::MicroTemplate provides OO-style interface to handle more complex cases.

new($template)

new(%args)

new(\%args)

Constructs template renderer. In the second or third form, parameters below are recognized.

template

template string (mandatory)

escape_func

escape function (defaults to Text::MicroTemplate::escape_html), no escape when set to undef

package_name

package under where the renderer is compiled (defaults to caller package)

code()

returns perl code that renders the template when evaluated

filter(sub filter_func { ... })->sub({ template lines })

filters given template lines

    ? $_mt->filter(sub { s/Hello/Good bye/g })->sub({
    Hello, John!
    ? })

SEE ALSO ^

Text::MicroTemplate::File

AUTHOR ^

Kazuho Oku <kazuhooku gmail.com>

Tokuhiro Matsuno <tokuhirom AAJKLFJEF GMAIL COM>

The module is based on Mojo::Template by Sebastian Riedel.

LICENSE ^

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

syntax highlighting: