NAME

Template::Constants - Defines constants for the Template Toolkit

SYNOPSIS

use Template::Constants qw( :status :error :all );

DESCRIPTION

The Template::Constants modules defines, and optionally exports into the caller's namespace, a number of constants used by the Template package.

Constants may be used by specifying the Template::Constants package explicitly:

use Template::Constants;

print Template::Constants::STATUS_DECLINED;

Constants may be imported into the caller's namespace by naming them as options to the use Template::Constants statement:

use Template::Constants qw( STATUS_DECLINED );

print STATUS_DECLINED;

Alternatively, one of the following tagset identifiers may be specified to import sets of constants; :status, :error, :all.

use Template::Constants qw( :status );

print STATUS_DECLINED;

See Exporter for more information on exporting variables.

EXPORTABLE TAG SETS

The following tag sets and associated constants are defined:

:status
  STATUS_OK                 # no problem, continue
  STATUS_RETURN             # ended current block then continue (ok)
  STATUS_STOP               # controlled stop (ok) 
  STATUS_DONE               # iterator is all done (ok)
  STATUS_DECLINED           # provider declined to service request (ok)
  STATUS_ERROR              # general error condition (not ok)

:error
  ERROR_RETURN              # return a status code (e.g. 'stop')
  ERROR_FILE                # file error: I/O, parse, recursion
  ERROR_UNDEF               # undefined variable value used
  ERROR_PERL                # error in [% PERL %] block

:chomp                      # for PRE_CHOMP and POST_CHOMP
  CHOMP_NONE                # do not remove whitespace
  CHOMP_ALL                 # remove whitespace
  CHOMP_COLLAPSE            # collapse whitespace to a single space

:all         All the above constants.

AUTHOR

Andy Wardley <abw@kfs.org>

http://www.andywardley.com/

VERSION

2.18, distributed as part of the Template Toolkit version 2.04, released on 29 June 2001.

COPYRIGHT

Copyright (C) 1996-2001 Andy Wardley.  All Rights Reserved.
Copyright (C) 1998-2001 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, CPAN::Exporter