WWWWWW

Current Directory: /home/.cpanm/work/1729881433.833612/Template-Toolkit-3.102/blib/man3
Viewing File: /home/.cpanm/work/1729881433.833612/Template-Toolkit-3.102/blib/man3/Template::Config.3pm
.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Template::Config 3"
.TH Template::Config 3 "2024-10-25" "perl v5.26.3" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Template::Config \- Factory module for instantiating other TT2 modules
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Template::Config;
.Ve
.SH "DESCRIPTION"
.IX Header "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.
.PP
Package variables such as \f(CW$STASH\fR, \f(CW$SERVICE\fR, \f(CW$CONTEXT\fR, 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 (\fBstash()\fR, \fBservice()\fR and \fBcontext()\fR) 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.
.SH "PUBLIC METHODS"
.IX Header "PUBLIC METHODS"
.SS "load($module)"
.IX Subsection "load($module)"
Load a module using Perl's \fBrequire()\fR. Any occurrences of '\f(CW\*(C`::\*(C'\fR' in the
module name are be converted to '\f(CW\*(C`/\*(C'\fR', and '\f(CW\*(C`.pm\*(C'\fR' is appended. Returns 1 on
success or undef on error.  Use \f(CW\*(C`$class\->error()\*(C'\fR to examine the error
string.
.SS "\fBpreload()\fP"
.IX Subsection "preload()"
This method preloads all the other \f(CW\*(C`Template::*\*(C'\fR modules that are likely to
be used. It is called automatically by the Template module when running
under mod_perl (\f(CW$ENV{MOD_PERL}\fR is set).
.SS "parser(\e%config)"
.IX Subsection "parser(%config)"
Instantiate a new parser object of the class whose name is denoted by
the package variable \f(CW$PARSER\fR (default: Template::Parser).  Returns
a reference to a newly instantiated parser object or undef on error.
.SS "provider(\e%config)"
.IX Subsection "provider(%config)"
Instantiate a new template provider object (default: Template::Provider).
Returns an object reference or undef on error, as above.
.SS "plugins(\e%config)"
.IX Subsection "plugins(%config)"
Instantiate a new plugins provider object (default: Template::Plugins).
Returns an object reference or undef on error, as above.
.SS "filters(\e%config)"
.IX Subsection "filters(%config)"
Instantiate a new filter provider object (default: Template::Filters).
Returns an object reference or undef on error, as above.
.SS "stash(\e%vars)"
.IX Subsection "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.
.SS "context(\e%config)"
.IX Subsection "context(%config)"
Instantiate a new template context object (default: Template::Context).
Returns an object reference or undef on error, as above.
.SS "service(\e%config)"
.IX Subsection "service(%config)"
Instantiate a new template service object (default: Template::Service).
Returns an object reference or undef on error, as above.
.SS "iterator(\e%config)"
.IX Subsection "iterator(%config)"
Instantiate a new template iterator object (default: Template::Iterator).
Returns an object reference or undef on error, as above.
.SS "constants(\e%config)"
.IX Subsection "constants(%config)"
Instantiate a new namespace handler for compile time constant folding
(default: Template::Namespace::Constants). Returns an object reference or
undef on error, as above.
.SS "instdir($dir)"
.IX Subsection "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.
.PP
.Vb 3
\&    # e.g. returns \*(Aq/usr/local/tt2\*(Aq
\&    my $ttroot = Template::Config\->instdir()
\&        || die "$Template::Config::ERROR\en";
\&
\&    # e.g. returns \*(Aq/usr/local/tt2/templates\*(Aq
\&    my $template = Template::Config\->instdir(\*(Aqtemplates\*(Aq)
\&        || die "$Template::Config::ERROR\en";
.Ve
.PP
Returns \f(CW\*(C`undef\*(C'\fR and sets \f(CW$Template::Config::ERROR\fR appropriately if the
optional components of the Template Toolkit have not been installed.
.SH "AUTHOR"
.IX Header "AUTHOR"
Andy Wardley <abw@wardley.org> <http://wardley.org/>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 1996\-2022 Andy Wardley.  All Rights Reserved.
.PP
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Template
F1l3 Manager
