File Coverage

blib/lib/HTML/Template/Filter/TT2.pm

Criterion	Covered	Total	%
statement	22	24	91.6
branch	6	10	60.0
condition			n/a
subroutine	4	4	100.0
pod	1	1	100.0
total	33	39	84.6

package HTML::Template::Filter::TT2;
use strict;
require Exporter;

{
    no strict "vars";
    $VERSION = '0.03';
    @ISA     = qw(Exporter);
    @EXPORT  = qw(ht_tt2_filter);
}

=head1 NAME

HTML::Template::Filter::TT2 - Template Toolkit 2 syntax for HTML::Template

=head1 VERSION

Version 0.03

=head1 SYNOPSIS

    use HTML::Template::Filter::TT2;

    my $tmpl = HTML::Template->new(filter => \&ht_tt2_filter, ...);

=head1 DESCRIPTION

This C filter allows you to use a subset of the Template Toolkit 2
syntax, which is much less verbose than the default syntax. This is not
an emulation of TT2, so you're still limited to the usual C
semantics. Also, in order to keep the filter fast and simple, the
C<[% end %]> must be written with the block name. See below for details.

=head1 SYNTAX

Here is the syntax recognised by this module.

=head2 Variables

Simple interpolation:

    [% variable %]

Interpolation with default value:

    [% variable :default %]

Interpolation with filter (i.e. a C escape mode):

    [% variable |filter %]

Interpolation with default value and filter:

    [% variable :default |filter %]

=head2 If statements

    [% if condition %] ... [% else %] ... [end_if %]

The difference with the actual TT2 syntax is that you must use C
instead of C

=head2 Loops

    [% loop loop-name %] ... [% end_loop %]

As for the C statement, you must use C instead of C.

=head1 EXPORT

Exports the C function by default.

=head1 FUNCTIONS

=head2 ht_tt2_filter()

Pass a reference to this function to the C parameter when calling
C<< HTML::Template->new() >>

=cut

sub ht_tt2_filter {
    my ($text_ref) = @_;
    $$text_ref =~ s{\[% *(loop|if|unless) +(\w+) *%\]}{}gm;
    $$text_ref =~ s{\[% *(else) *%\]}{}gm;
    $$text_ref =~ s{\[% *end_(\w+) *%\]}{}gm;
    $$text_ref =~ s{
            \[%                     # begin tag
            \s* (\w+) \s*           # variable name
            \s* (?:: \s* (.+?))?    # optional default value
            \s* (?:\| \s* (\w+))?   # optional filter
            \s* %\]                 # end tag
        }
        {__format_variable($1, $2, $3)}gemx;
}

sub __format_variable {
    my ($var, $default, $filter) = @_;

    # variable name
    my $ht_syntax = "

    # handle default value
    if (defined $default) {
        # autoquote unquoted values
        if ($default !~ /^["']/) {
            if    ($default !~ /"/) { $default = qq/"$default"/ }
            elsif ($default !~ /'/) { $default = qq/'$default'/ }
            else  { warn "Can't handle unquoted value '$default' for variable $var" }
        }

        $ht_syntax .= " DEFAULT=$default";
    }

    # handle escape filter
    $ht_syntax .= " ESCAPE=$filter" if defined $filter;

    # end tag
    $ht_syntax .= ">";

    return $ht_syntax;
}


=head1 AUTHOR

SEbastien Aperghis-Tramoni, C<<  >>

=head2 SEE ALSO

L, L

=head1 BUGS

Please report any bugs or feature requests to
C, or through the web interface at
L.
I will be notified, and then you'll automatically be notified of progress on
your bug as I make changes.

=head1 SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc HTML::Template::Filter::TT2

You can also look for information at:

=over 4

=item * AnnoCPAN: Annotated CPAN documentation

L

=item * CPAN Ratings

L

=item * RT: CPAN's request tracker

L

=item * Search CPAN

L

=back

=head1 COPYRIGHT & LICENSE

Copyright 2007 SEbastien Aperghis-Tramoni, all rights reserved.

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

=cut

1; # End of HTML::Template::Filter::TT2