ePages 6.11.0 - DE_EPAGES/TLE/API/Template.pm

Package DE_EPAGES::TLE::API::Template

This package provides a basic file based template processing.
The most used template processing is based on page types, see DE_EPAGES::Presentation::API::Template.
A filebased template processing including dictionary files, see DE_EPAGES::Dictionary::API::Template.
A content (perl-string) template processing exists via DE_EPAGES::TLE::API::TLE.

Example
use DE_EPAGES::TLE::API::Template;
my $Template = DE_EPAGES::TLE::API::Template->new;
my $Content = $Template->process( 'PageTemplate.html', \%TemplateVars );
use DE_EPAGES::TLE::API::Template qw (ProcessFileTemplate);
my $Content = ProcessFileTemplate('myTemplate.tmpl', \%TemplateVars);
@EXPORT_OK
ProcessFileTemplate

Functions

INCLUDE
ProcessFileTemplate
perlFileName
process

INCLUDE

Simple include on file base. If the debugging mode for this function is enabled, an html comment wraps result (includes file name and processing time).

Syntax
$Content = $Handler->INCLUDE($Processor, $raParams);
#INCLUDE("FileName")
Example
#INCLUDE("myIncludeTemplate.tmpl")
Input
$FileName (string)
filename of template
Return
$Content (string)
processed template

ProcessFileTemplate

Starts the template processing, which is based on template $FileName. At this template are allowed calls of INCLUDE.

Syntax
$Content = ProcessFileTemplate($FileName, $hVars, $TLEProcessor);
Input
$FileName (string)
filename of template
$hVars (ref.(hash.array.)*string)
template vars (vars and loops)
$TLEProcessor (object)
tle processor (optional, default BaseProcessor)
Return
$Content (string)
replaced content

perlFileName

Returns path to the compiled template for a given template path. This method returns $FileName.'.ctmpl', but it can be overloaded. If the retun value is undef, the compiled template is not saved to disk.

Syntax
$PerlFile = $Template->perlFileName( $FileName );
Example
$PerlFile = $Template->perlFileName( 'Template.tmpl' );
Input
$FileName (string)
template file name
Return
$PerlFile (string)
compiled template file name

process

Replaces TLE variables in the template.

Syntax
$Template = $Package->new;
$Content = $Template->process( $FileName, $hVars );
Input
$FileName (string)
filename of template
$hVars (ref.(hash.array.)*string)
template vars (vars and loops)