[%# # 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 = 'Namespace_Constants' %] [% WRAPPER toc; PROCESS tocitem title ="SYNOPSIS" subs = []; PROCESS tocitem title ="DESCRIPTION" subs = []; PROCESS tocitem title ="PUBLIC METHODS" subs = [ "new(\\%constants)", "ident(\\@ident)" ]; 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" -%]
# easy way to define constants use Template;
my $tt = Template->new({ CONSTANTS => { pi => 3.14, e => 2.718, }, });
# nitty-gritty, hands-dirty way use Template::Namespace::Constants;
my $tt = Template->new({ NAMESPACE => { constants => Template::Namespace::Constants->new({ pi => 3.14, e => 2.718, }, }, });[%- END %] [% WRAPPER section title="DESCRIPTION" -%]
The Template::Namespace::Constants module implements a namespace handler which is plugged into the Template::Directive compiler module. This then performs compile time constant folding of variables in a particular namespace.
[%- END %] [% WRAPPER section title="PUBLIC METHODS" -%][% WRAPPER subsection title = "new(\\%constants)" -%]The new() constructor method creates and returns a reference to a new Template::Namespace::Constants object. This creates an internal stash to store the constant variable definitions passed as arguments.
my $handler = Template::Namespace::Constants->new({ pi => 3.14, e => 2.718, });[%- END %] [% WRAPPER subsection title = "ident(\\@ident)" -%]
Method called to resolve a variable identifier into a compiled form. In this case, the method fetches the corresponding constant value from its internal stash and returns it.
[%- END %] [%- END %] [% WRAPPER section title="AUTHOR" -%]Andy Wardley <abw@andywardley.com>
[% ttlink('http://www.andywardley.com/', 'http://www.andywardley.com/') -%]
[%- END %] [% WRAPPER section title="VERSION" -%]1.09, distributed as part of the Template Toolkit version 2.08, released on 30 July 2002.
[%- END %] [% WRAPPER section title="COPYRIGHT" -%]Copyright (C) 1996-2002 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::Directive', 'Template::Directive') -%]
[%- END %]