NAME

HTML::Template::Pro::Extension - Extension modules for HTML::Template::Pro

SYNOPSIS

 use HTML::Template::Pro::Extension;

 my $text = qq
    |
     Standard module emulation
     =========================
     If all is ok you can read this here --> <TMPL_VAR NAME="test">

    |;

 my $comp       = new HTML::Template::Pro::Extension(
                                            tmplfile => \$text,
                                            plugins=>["DO_NOTHING"],
                        );

 $comp->param('test' => "It works!!!");
 print $comp->output;

 #   OUTPUT:
 #
 #   Standard module emulation
 #   =========================
 #   If all is ok you can read this here --> It works!!!

 my $text = qq
    |
     SLASH_VAR plugin activation
     ===========================
     Look to see if SLASH_VAR plugin is active  --> <TMPL_VAR NAME="test">NO</TMPL_VAR>

    |;
 $comp->plugin_add("SLASH_VAR");
 $comp->tmplfile(\$text);
 $comp->param('test' => "YES");
 print $comp->output;

 #   OUTPUT:
 #
 #   SLASH_VAR plugin activation
 #   ===========================
 #   Look to see if SLASH_VAR plugin is active  --> YES


 my $text = qq
    |
     <HTML><BODY> HEAD_BODY plugin activation with autoDeleteHeader enabled
     =========================================================
     Look to see if SLASH_VAR plugin is active  --> <TMPL_VAR NAME="test">NO</TMPL_VAR>
     If you don't see HTML and BODY tags then HEAD_BODY plugin is active.
     </BODY>
     </HTML>
     |;
 $comp->plugin_add("HEAD_BODY");
 $comp->tmplfile(\$text);
 $comp->autoDeleteHeader(1);
 print $comp->output;
 print "and the header is..." . $comp->header. "\n";

 #   OUTPUT:
 #
 #   HEAD_BODY plugin activation with autoDeleteHeader enabled
 #   =========================================================
 #   Look to see if SLASH_VAR plugin is active  --> YES
 #   If you don't see HTML and BODY tags then HEAD_BODY plugin is active.
 #   and the header is...
 #   <HTML><BODY>

 my $text = qq
    |
     DOC plugin activation
     =====================
     Look to see if SLASH_VAR plugin is active  --> <TMPL_VAR NAME="test">NO</TMPL_VAR>
     Look to see if DOC plugin is active  --> <TMPL_DOC>DOC plugin is NOT active</TMPL_DOC>


    |;
 $comp->autoDeleteHeader(0);
 $comp->tmplfile(\$text);
 $comp->plugin_add("DOC");
 print $comp->output;

 #   OUTPUT:
 #
 #   DOC plugin activation
 #   =====================
 #   Look to see if SLASH_VAR plugin is active  --> YES
 #   Look to see if DOC plugin is active  -->

 print qq
    |
     CSTART plugin activation
     ========================
    |;
 my $text = qq
    |
     Look to see if SLASH_VAR plugin is active  --> <TMPL_VAR NAME="test">NO</TMPL_VAR>
     Look to see if DOC plugin is active  --> <TMPL_DOC>DOC plugin is NOT active</TMPL_DOC>
     <TMPL_CSTART> If you see ONLY this line then CSTART plugin is active.</TMPL_CSTART>

    |;
 $comp->plugin_add("CSTART");
 $comp->tmplfile(\$text);
 print $comp->output . "\n";

 #   OUTPUT:
 #
 #   CSTART plugin activation
 #   ========================
 #   If you see ONLY this line then CSTART plugin is active.

 print qq
    |
     IF_TERN plugin activation
     =========================
    |;

 my $text = qq
    |
     If all is ok you can read this here --> %test?It works!!!:It's BAD%
    |;

 $comp->plugin_add("IF_TERN");
 $comp->tmplfile(\$text);
 $comp->param('test' => 1);
 print $comp->output . "\n";

 #   OUTPUT:
 #
 #   IF_TERN plugin activation
 #   =========================
 #   If all is ok you can read this here --> It works!!!

DESCRIPTION

This module extends HTML::Template::Pro to easily support methods and tags not implemented in parent module. Piece of code needed to add new tags syntax and new functionality are called plugins. All plugins can be dynamically loaded for supporing needed syntax and functionality. This module has origin from HTML::Template::Extension to make use of the extensions in HTML::Template::Pro too. This module is a derivated class of HTML::Template::Pro base module and, like so, works exactly ad HTML::Template::Pro do. But, relative to original module, it differ from:

  • activation ad usage of vanguard_compatible_mode.

    I like TMPL_* tags but there is scope where %...% costruct is very usefull for readability;

  • die_on_bad_params is disabled by default.

    I don't like errors is i wish not to set params or if i try to set some unexistent parameters;

  • "output" method is oveloaded

    to support an hash item "as" to set params directly without setting them befor using param method;

  • added a new method "html"

    with two arguments, an hash ref for setting parameters directly and a scalar argument to set here the file name of template to use. If file name is the same of one just setting in, cache is used;

  • a costructor parameter "plugins" is added

    relative to an array ref with all plugins module to load;

  • a "plugin_add" method was implemented

    to add a single plugin to those already loaded. If a string is passed as plugin_add argument, then HTML::Template::Extention::*** is loaded. If a obj reference is passed, it's used as object Extension. The object passed must implements an init and a push_filter extension. It's better to wrote you own object plugin implements HTML::Template::Extension::ObjBase as parent object.

  • a "plugins_clear" method was added

    to unload all plugins

  • added a single "tmplfile" method

    to pass template in scalar, scalarref, arrayref and filehandle mode. A

  • pass template after module initialization

    use "tmplfile" method to modify template text after class initialization.

All dynamic plugins live in the HTML::Template::Pro::Extension namespace and you can built your own extension to support you prefered tags and functionality. A plugin named DO_NOTHING is present in this package and can be use like a skeleton to built your own plugin. DO_NOTHING, as name says, add nothing to standard HTML::Template::Pro::Extension but there are other plugins just available:

  • HTML::Template::Pro::Extension::DOC

    to support comment text

  • HTML::Template::Pro::Extension::SLASH_VAR

    to support <TMPL_VAR>....</TMPL_VAR> syntax

  • HTML::Template::Pro::Extension::CSTART

    to select what parts of your template must be returned by "output" and "html" method

  • HTML::Template::Pro::Extension::HEAD_BODY

    that don't add tag syntax but some method for easily working with html files

  • HTML::Template::Pro::Extension::IF_TERN

    that add syntax for ternary if operator %bool_var?if_is_true:if_is_false%

  • HTML::Template::Pro::Extension::DO_NOTHING

    that do nothing :-)

  • HTML::Template::Pro::Extension::TAG_ATTRIBUTE_NORMALIZED

    that makes possible to add HTML attributes to TMPL_* tags.

For more information about this plugins see relative pods file.

METHODS

For method also present in the SUPER class there are only described differens. for a complete description of this methods take a look to SUPER class HTML::Template.

output( 'as' => \%params)

Return text present in filename file using %params hash to set TMPL_* parameters present in this template

html(\%params,$filename)

Under costruction

tmplfile( [ $filepath | \$text | \@lines | *FH ] )

Set the template. See filename, scalarref, arrayref, filehandle methods of HTML::Template::Pro to understand difference between different data type.

LICENSE

HTML::Template::Pro::Extension - Extension plugins for HTML::Template::Pro with Perl Copyright (C) 2001-2005 Bruni Emiliano <info AT ebruni DOT it>

This module is free software; you can redistribute it and/or modify it under the terms of either:

a) the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version, or

b) the "Artistic License" which comes with this module.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See either the GNU General Public License or the Artistic License for more details.

You should have received a copy of the Artistic License with this module, in the file ARTISTIC. If not, I'll be glad to provide one.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

AUTHOR

Bruni Emiliano, <info/at/ebruni_dot_it>

SEE ALSO

HTML::Template, HTML::Template::Pro, HTML::Template::Extension, HTML::Template::Extension::DO_NOTHING, HTML::Template::Extension::SLASH_VAR, HTML::Template::Extension::CSTART, HTML::Template::Extension::DOC, HTML::Template::Extension::HEAD_BODY, HTML::Template::Extension::IF_TERN, HTML::Template::Extension::ObjBase