summaryrefslogtreecommitdiff
path: root/lib/Template/Exception.pm
diff options
context:
space:
mode:
authorAndreas Brachold <vdr07@deltab.de>2007-11-11 06:55:13 +0000
committerAndreas Brachold <vdr07@deltab.de>2007-11-11 06:55:13 +0000
commit3282be229999dc36c197b264d63063a18d136331 (patch)
tree98a42db29d955b39e7bed1b599fdcc56c3a29de9 /lib/Template/Exception.pm
parentcfdd733c17cfa4f1a43b827a656e9e53cc2524ac (diff)
downloadxxv-3282be229999dc36c197b264d63063a18d136331.tar.gz
xxv-3282be229999dc36c197b264d63063a18d136331.tar.bz2
* Update installation list with required modules
* Remove unused/doubled provided external perl moduls
Diffstat (limited to 'lib/Template/Exception.pm')
-rw-r--r--lib/Template/Exception.pm254
1 files changed, 0 insertions, 254 deletions
diff --git a/lib/Template/Exception.pm b/lib/Template/Exception.pm
deleted file mode 100644
index 9a95af7..0000000
--- a/lib/Template/Exception.pm
+++ /dev/null
@@ -1,254 +0,0 @@
-#============================================================= -*-Perl-*-
-#
-# Template::Exception
-#
-# DESCRIPTION
-# Module implementing a generic exception class used for error handling
-# in the Template Toolkit.
-#
-# AUTHOR
-# Andy Wardley <abw@kfs.org>
-#
-# COPYRIGHT
-# Copyright (C) 1996-2000 Andy Wardley. All Rights Reserved.
-# Copyright (C) 1998-2000 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.
-#
-#------------------------------------------------------------------------
-#
-# $Id: Exception.pm,v 2.64 2004/01/13 16:19:10 abw Exp $
-#
-#========================================================================
-
-
-package Template::Exception;
-
-require 5.005;
-
-use strict;
-use vars qw( $VERSION );
-
-use constant TYPE => 0;
-use constant INFO => 1;
-use constant TEXT => 2;
-use overload q|""| => "as_string", fallback => 1;
-
-
-$VERSION = sprintf("%d.%02d", q$Revision: 2.64 $ =~ /(\d+)\.(\d+)/);
-
-
-#------------------------------------------------------------------------
-# new($type, $info, \$text)
-#
-# Constructor method used to instantiate a new Template::Exception
-# object. The first parameter should contain the exception type. This
-# can be any arbitrary string of the caller's choice to represent a
-# specific exception. The second parameter should contain any
-# information (i.e. error message or data reference) relevant to the
-# specific exception event. The third optional parameter may be a
-# reference to a scalar containing output text from the template
-# block up to the point where the exception was thrown.
-#------------------------------------------------------------------------
-
-sub new {
- my ($class, $type, $info, $textref) = @_;
- bless [ $type, $info, $textref ], $class;
-}
-
-
-#------------------------------------------------------------------------
-# type()
-# info()
-# type_info()
-#
-# Accessor methods to return the internal TYPE and INFO fields.
-#------------------------------------------------------------------------
-
-sub type {
- $_[0]->[ TYPE ];
-}
-
-sub info {
- $_[0]->[ INFO ];
-}
-
-sub type_info {
- my $self = shift;
- @$self[ TYPE, INFO ];
-}
-
-#------------------------------------------------------------------------
-# text()
-# text(\$pretext)
-#
-# Method to return the text referenced by the TEXT member. A text
-# reference may be passed as a parameter to supercede the existing
-# member. The existing text is added to the *end* of the new text
-# before being stored. This facility is provided for template blocks
-# to gracefully de-nest when an exception occurs and allows them to
-# reconstruct their output in the correct order.
-#------------------------------------------------------------------------
-
-sub text {
- my ($self, $newtextref) = @_;
- my $textref = $self->[ TEXT ];
-
- if ($newtextref) {
- $$newtextref .= $$textref if $textref && $textref ne $newtextref;
- $self->[ TEXT ] = $newtextref;
- return '';
-
- }
- elsif ($textref) {
- return $$textref;
- }
- else {
- return '';
- }
-}
-
-
-#------------------------------------------------------------------------
-# as_string()
-#
-# Accessor method to return a string indicating the exception type and
-# information.
-#------------------------------------------------------------------------
-
-sub as_string {
- my $self = shift;
- return $self->[ TYPE ] . ' error - ' . $self->[ INFO ];
-}
-
-
-#------------------------------------------------------------------------
-# select_handler(@types)
-#
-# Selects the most appropriate handler for the exception TYPE, from
-# the list of types passed in as parameters. The method returns the
-# item which is an exact match for TYPE or the closest, more
-# generic handler (e.g. foo being more generic than foo.bar, etc.)
-#------------------------------------------------------------------------
-
-sub select_handler {
- my ($self, @options) = @_;
- my $type = $self->[ TYPE ];
- my %hlut;
- @hlut{ @options } = (1) x @options;
-
- while ($type) {
- return $type if $hlut{ $type };
-
- # strip .element from the end of the exception type to find a
- # more generic handler
- $type =~ s/\.?[^\.]*$//;
- }
- return undef;
-}
-
-1;
-
-__END__
-
-
-#------------------------------------------------------------------------
-# 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.
-#------------------------------------------------------------------------
-
-=head1 NAME
-
-Template::Exception - Exception handling class module
-
-=head1 SYNOPSIS
-
- use Template::Exception;
-
- my $exception = Template::Exception->new($type, $info);
- $type = $exception->type;
- $info = $exception->info;
- ($type, $info) = $exception->type_info;
-
- print $exception->as_string();
-
- $handler = $exception->select_handler(\@candidates);
-
-=head1 DESCRIPTION
-
-The Template::Exception module defines an object class for
-representing exceptions within the template processing life cycle.
-Exceptions can be raised by modules within the Template Toolkit, or
-can be generated and returned by user code bound to template
-variables.
-
-
-Exceptions can be raised in a template using the THROW directive,
-
- [% THROW user.login 'no user id: please login' %]
-
-or by calling the throw() method on the current Template::Context object,
-
- $context->throw('user.passwd', 'Incorrect Password');
- $context->throw('Incorrect Password'); # type 'undef'
-
-or from Perl code by calling die() with a Template::Exception object,
-
- die (Template::Exception->new('user.denied', 'Invalid User ID'));
-
-or by simply calling die() with an error string. This is
-automagically caught and converted to an exception of 'undef'
-type which can then be handled in the usual way.
-
- die "I'm sorry Dave, I can't do that";
-
-
-
-Each exception is defined by its type and a information component
-(e.g. error message). The type can be any identifying string and may
-contain dotted components (e.g. 'foo', 'foo.bar', 'foo.bar.baz').
-Exception types are considered to be hierarchical such that 'foo.bar'
-would be a specific type of the more general 'foo' type.
-
-=head1 AUTHOR
-
-Andy Wardley E<lt>abw@andywardley.comE<gt>
-
-L<http://www.andywardley.com/|http://www.andywardley.com/>
-
-
-
-
-=head1 VERSION
-
-2.64, distributed as part of the
-Template Toolkit version 2.13, released on 30 January 2004.
-
-=head1 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.
-
-=head1 SEE ALSO
-
-L<Template|Template>, L<Template::Context|Template::Context>
-
-=cut
-
-# Local Variables:
-# mode: perl
-# perl-indent-level: 4
-# indent-tabs-mode: nil
-# End:
-#
-# vim: expandtab shiftwidth=4: