Andy Wardley > Template-Toolkit-2.14 > Template::Namespace::Constants

Download:
Template-Toolkit-2.14.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  49
Open  15
View/Report Bugs
Module Version: 1.23   Source   Latest Release: Template-Toolkit-2.25

NAME ^

Template::Namespace::Constants - Compile time constant folding

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,
            },
        },
    });

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.

PUBLIC METHODS ^

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,
    });

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.

AUTHOR ^

Andy Wardley <abw@andywardley.com>

http://www.andywardley.com/

VERSION ^

1.23, distributed as part of the Template Toolkit version 2.14, released on 04 October 2004.

COPYRIGHT ^

  Copyright (C) 1996-2004 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.

SEE ALSO ^

Template::Directive

syntax highlighting: