template::config(3)
NAME
Template::Config - Factory module for instantiating other
TT2 modules
SYNOPSIS
use Template::Config;
DESCRIPTION
This module implements various methods for loading and
instantiating other modules that comprise the Template
Toolkit. It provides a consistent way to create toolkit
components and allows custom modules to be used in place
of the regular ones.
Package variables such as $STASH, $SERVICE, $CONTEXT,
etc., contain the default module/package name for each
component (Template::Stash, Template::Service and Tem
plate::Context, respectively) and are used by the various
factory methods (stash(), service() and context()) to load
the appropriate module. Changing these package variables
will cause subsequent calls to the relevant factory method
to load and instantiate an object from the new class.
PUBLIC METHODS
load($module)
Load a module via require(). Any occurences of '::' in
the module name are be converted to '/' and '.pm' is
appended. Returns 1 on success or undef on error. Use
$class->error() to examine the error string.
parser%(config)
Instantiate a new parser object of the class whose name is
denoted by the package variable $PARSER (default: Tem
plate::Parser). Returns a reference to a newly instanti
ated parser object or undef on error.
provider%(config)
Instantiate a new template provider object (default: Tem
plate::Provider). Returns an object reference or undef on
error, as above.
plugins%(config)
Instantiate a new plugins provider object (default: Tem
plate::Plugins). Returns an object reference or undef on
error, as above.
filters%(config)
Instantiate a new filter provider object (default: Tem
plate::Filters). Returns an object reference or undef on
error, as above.
stash%(vars)
Instantiate a new stash object (default: Template::Tem
plates) using the contents of the optional hash array
passed by parameter as initial variable definitions.
Returns an object reference or undef on error, as above.
context%(config)
Instantiate a new template context object (default: Tem
plate::Context). Returns an object reference or undef on
error, as above.
service%(config)
Instantiate a new template service object (default: Tem
plate::Service). Returns an object reference or undef on
error, as above.
instdir($dir)
- Returns the root directory of the Template Toolkit instal
lation under which optional components are installed. Any
relative directory specified as an argument will be
appended to the returned directory. - # e.g. returns '/usr/local/tt2'
my $ttroot = Template::Config->instdir()|| die "$Template::Config::ERROR0; - # e.g. returns '/usr/local/tt2/templates'
my $template = Template::Config->instdir('templates')|| die "$Template::Config::ERROR0; - Returns undef and sets $Template::Config::ERROR appropri
ately if the optional components of the Template Toolkit
have not been installed.
AUTHOR
Andy Wardley <abw@andywardley.com>
<http://www.andywardley.com/|http://www.andywardley.com/>
VERSION
2.54, distributed as part of the Template Toolkit version
2.08, released on 30 July 2002.
COPYRIGHT
- Copyright (C) 1996-2002 Andy Wardley. All Rights Re
- served.
Copyright (C) 1998-2002 Canon Research Centre Europe - Ltd.
- This module is free software; you can redistribute it
and/or modify it under the same terms as Perl itself.
SEE ALSO
- Template