NAME
Text::PSP - Perl extension implementing a JSP-like templating system.
SYNOPSIS
use Text::PSP;
my $psp_engine = Text::PSP->new(
template_root => 'templates',
work_dir => '/tmp/psp_work',
);
my $template_object = $psp_engine->template('/home/joost/templates/index.psp');
my @out = $template_object->run(@arguments);
print @out;DESCRIPTION
The Text::PSP system consists of 3 modules: Text::PSP, Text::PSP::Parser and Text::PSP::Template. The parser creates perl modules from the input files, which are subclasses of Text::PSP::Template. Text::PSP is the module overseeing the creation and caching of the templates.
You can use the basics of the JSP system:
<%
my $self = shift;
# code mode
my @words = qw(zero one two three);
%>
Hello, World - this is text mode
<%=
map { $i++ . ' = ' . $_ } @words
%>
That was an expression
<%!
# define mode
sub method {
return "method called";
}
%>
<%= $self->method %>
And insert mode again
includes
<%@file include="some/page.psp"%>
and includes that search for a file upwards to the template
root
<%@file find="header.psp"%>For a complete description of the template constructs, see Text::PSP::Syntax.
METHODS
new
Instantiates a new Text::PSP object.
Takes two named parameters: template_root and work_dir.
template_root: the root directory for the template files. No templates outside the template_root can be run by this Text::PSP object.
work_dir: the directory in which to store the translated templates.
my $psp = Text::PSP->new(
template_root => './templates',
work_dir => './work',
);template
Get a template object from a template file. This will translate the template file into a Text::PSP::Template module if needed.
my $template = $psp->template("index.psp");find_template
Similar to the template() method, but searches for a file starting at the specified path, working up to the template_root.
The returned template object will behave as if it really were in the specified path, regardless of the real location of the template in the file system, so for instance any include and find directives will work from that path.
my $template = $psp->find_template("some/path/index.psp");clear_workdir
This will remove the entire content of the work directory, cleaning up disk space and forcing new calls to $psp->template() to recompile the template file.
AUTHOR
Joost Diepenmaat, jdiepen@cpan.org