[%# # IMPORTANT NOTE # This documentation is generated automatically from source # templates. Any changes you make here may be lost. # # The 'docsrc' documentation source bundle is available for download # from http://www.template-toolkit.org/docs.html and contains all # the source templates, XML files, scripts, etc., from which the # documentation for the Template Toolkit is built. -%] [% META book = 'Modules' page = 'Config' %] [% WRAPPER toc; PROCESS tocitem title ="SYNOPSIS" subs = []; PROCESS tocitem title ="DESCRIPTION" subs = []; PROCESS tocitem title ="PUBLIC METHODS" subs = [ "load(\$module)", "preload()", "parser(\\%config)", "provider(\\%config)", "plugins(\\%config)", "filters(\\%config)", "stash(\\%vars)", "context(\\%config)", "service(\\%config)", "instdir(\$dir)" ]; PROCESS tocitem title ="AUTHOR" subs = []; PROCESS tocitem title ="VERSION" subs = []; PROCESS tocitem title ="COPYRIGHT" subs = []; PROCESS tocitem title ="SEE ALSO" subs = []; END %] [% WRAPPER section title="SYNOPSIS" -%]

        use Template::Config;

[%- END %] [% WRAPPER section title="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.

[%- END %] [% WRAPPER section title="PUBLIC METHODS" -%][% WRAPPER subsection title = "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.

[%- END %] [% WRAPPER subsection title = "preload()" -%]

This method preloads all the other Template::* modules that are likely to be used. It is called by the Template module when running under mod_perl ($ENV{MOD_PERL} is set).

[%- END %] [% WRAPPER subsection title = "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.

[%- END %] [% WRAPPER subsection title = "provider(\\%config)" -%]

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

[%- END %] [% WRAPPER subsection title = "plugins(\\%config)" -%]

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

[%- END %] [% WRAPPER subsection title = "filters(\\%config)" -%]

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

[%- END %] [% WRAPPER subsection title = "stash(\\%vars)" -%]

Instantiate a new stash object (Template::Stash or Template::Stash::XS depending on the default set at installation time) 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.

[%- END %] [% WRAPPER subsection title = "context(\\%config)" -%]

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

[%- END %] [% WRAPPER subsection title = "service(\\%config)" -%]

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

[%- END %] [% WRAPPER subsection title = "instdir(\$dir)" -%]

Returns the root directory of the Template Toolkit installation 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::ERROR\n";

        # e.g. returns '/usr/local/tt2/templates'
        my $template = Template::Config->instdir('templates')
    	|| die "$Template::Config::ERROR\n";

Returns undef and sets $Template::Config::ERROR appropriately if the optional components of the Template Toolkit have not been installed.

[%- END %] [%- END %] [% WRAPPER section title="AUTHOR" -%]

Andy Wardley <abw@wardley.org>

[% ttlink('http://wardley.org/', 'http://wardley.org/') -%]

[%- END %] [% WRAPPER section title="VERSION" -%]

2.70, distributed as part of the Template Toolkit version 2.15, released on 26 May 2006.

[%- END %] [% WRAPPER section title="COPYRIGHT" -%]

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

[%- END %] [% WRAPPER section title="SEE ALSO" -%]

[% ttlink('Template', 'Template') -%]

[%- END %]