The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Template-Toolkit-2.00
River stage three • 561 direct dependents • 959 total dependents
146 ++
/ Template::Config

NAME

Template::Config - factory module for loading and instantiating other toolkit 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 Template::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: Template::Parser). Returns a reference to a newly instantiated parser object or undef on error.

provider(\%config)

Instantiate a new template provider object (default: Template::Provider). Returns an object reference or undef on error, as above.

plugins(\%config)

Instantiate a new plugins provider object (default: Template::Plugins). Returns an object reference or undef on error, as above.

filters(\%config)

Instantiate a new filter provider object (default: Template::Filters). Returns an object reference or undef on error, as above.

stash(\%vars)

Instantiate a new stash object (default: Template::Templates) 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: Template::Context). Returns an object reference or undef on error, as above.

service(\%config)

Instantiate a new template service object (default: Template::Service). Returns an object reference or undef on error, as above.

AUTHOR

Andy Wardley <abw@kfs.org>

    http://www.template-toolkit.org/
    http://www.kfs.org/~abw/

REVISION

$Revision: 1.1 $

COPYRIGHT

    Copyright (C) 1996-2000 Andy Wardley.  All Rights Reserved.
    Copyright (C) 1998-2000 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