Template Toolkit Modules

Template::Namespace::Constants

Tutorial ][ Manual ][ Modules ][ Library ][ Tools ][ FAQ ][ Release ]

<-[ Template::Iterator ][ Template::Parser ]->

Compile time constant folding

Table of Contents

SYNOPSIS

Index ][ Modules ][ Top ]
    # 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

Index ][ Modules ][ Top ]

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

Index ][ Modules ][ Top ]

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

Index ][ Modules ][ Top ]

Andy Wardley <abw@andywardley.com>

http://www.andywardley.com/

VERSION

Index ][ Modules ][ Top ]

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

COPYRIGHT

Index ][ Modules ][ Top ]
  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

Index ][ Modules ][ Top ]

Template::Directive


<-[ Template::Iterator ][ Template::Parser ]->