summaryrefslogtreecommitdiff
path: root/lib/Template/Base.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/Base.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/Base.pm')
-rw-r--r--lib/Template/Base.pm314
1 files changed, 0 insertions, 314 deletions
diff --git a/lib/Template/Base.pm b/lib/Template/Base.pm
deleted file mode 100644
index 5f19d78..0000000
--- a/lib/Template/Base.pm
+++ /dev/null
@@ -1,314 +0,0 @@
-#============================================================= -*-perl-*-
-#
-# Template::Base
-#
-# DESCRIPTION
-# Base class module implementing common functionality for various other
-# Template Toolkit modules.
-#
-# 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: Base.pm,v 2.69 2004/01/13 16:19:09 abw Exp $
-#
-#========================================================================
-
-package Template::Base;
-
-require 5.004;
-
-use strict;
-use vars qw( $VERSION );
-use Template::Constants;
-
-$VERSION = sprintf("%d.%02d", q$Revision: 2.69 $ =~ /(\d+)\.(\d+)/);
-
-
-#------------------------------------------------------------------------
-# new(\%params)
-#
-# General purpose constructor method which expects a hash reference of
-# configuration parameters, or a list of name => value pairs which are
-# folded into a hash. Blesses a hash into an object and calls its
-# _init() method, passing the parameter hash reference. Returns a new
-# object derived from Template::Base, or undef on error.
-#------------------------------------------------------------------------
-
-sub new {
- my $class = shift;
- my ($argnames, @args, $arg, $cfg);
-# $class->error(''); # always clear package $ERROR var?
-
- { no strict qw( refs );
- $argnames = \@{"$class\::BASEARGS"} || [ ];
- }
-
- # shift off all mandatory args, returning error if undefined or null
- foreach $arg (@$argnames) {
- return $class->error("no $arg specified")
- unless ($cfg = shift);
- push(@args, $cfg);
- }
-
- # fold all remaining args into a hash, or use provided hash ref
-# local $" = ', ';
-# print STDERR "args: [@_]\n";
- $cfg = defined $_[0] && UNIVERSAL::isa($_[0], 'HASH') ? shift : { @_ };
-
- my $self = bless {
- map { ($_ => shift @args) } @$argnames,
- _ERROR => '',
- DEBUG => 0,
- }, $class;
-
- return $self->_init($cfg) ? $self : $class->error($self->error);
-}
-
-
-#------------------------------------------------------------------------
-# error()
-# error($msg, ...)
-#
-# May be called as a class or object method to set or retrieve the
-# package variable $ERROR (class method) or internal member
-# $self->{ _ERROR } (object method). The presence of parameters indicates
-# that the error value should be set. Undef is then returned. In the
-# abscence of parameters, the current error value is returned.
-#------------------------------------------------------------------------
-
-sub error {
- my $self = shift;
- my $errvar;
-
- {
- no strict qw( refs );
- $errvar = ref $self ? \$self->{ _ERROR } : \${"$self\::ERROR"};
- }
- if (@_) {
- $$errvar = ref($_[0]) ? shift : join('', @_);
- return undef;
- }
- else {
- return $$errvar;
- }
-}
-
-
-#------------------------------------------------------------------------
-# _init()
-#
-# Initialisation method called by the new() constructor and passing a
-# reference to a hash array containing any configuration items specified
-# as constructor arguments. Should return $self on success or undef on
-# error, via a call to the error() method to set the error message.
-#------------------------------------------------------------------------
-
-sub _init {
- my ($self, $config) = @_;
- return $self;
-}
-
-
-sub DEBUG {
- my $self = shift;
- print STDERR "DEBUG: ", @_;
-}
-
-sub debug {
- my $self = shift;
- my $msg = join('', @_);
- my ($pkg, $file, $line) = caller();
-
- unless ($msg =~ /\n$/) {
- $msg .= ($self->{ DEBUG } & Template::Constants::DEBUG_CALLER)
- ? " at $file line $line\n"
- : "\n";
- }
-
- print STDERR "[$pkg] $msg";
-}
-
-
-#------------------------------------------------------------------------
-# module_version()
-#
-# Returns the current version number.
-#------------------------------------------------------------------------
-
-sub module_version {
- my $self = shift;
- my $class = ref $self || $self;
- no strict 'refs';
- return ${"${class}::VERSION"};
-}
-
-
-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::Base - Base class module implementing common functionality
-
-=head1 SYNOPSIS
-
- package My::Module;
- use base qw( Template::Base );
-
- sub _init {
- my ($self, $config) = @_;
- $self->{ doodah } = $config->{ doodah }
- || return $self->error("No 'doodah' specified");
- return $self;
- }
-
- package main;
-
- my $object = My::Module->new({ doodah => 'foobar' })
- || die My::Module->error();
-
-=head1 DESCRIPTION
-
-Base class module which implements a constructor and error reporting
-functionality for various Template Toolkit modules.
-
-=head1 PUBLIC METHODS
-
-=head2 new(\%config)
-
-Constructor method which accepts a reference to a hash array or a list
-of C<name =E<gt> value> parameters which are folded into a hash. The
-_init() method is then called, passing the configuration hash and should
-return true/false to indicate success or failure. A new object reference
-is returned, or undef on error. Any error message raised can be examined
-via the error() class method or directly via the package variable ERROR
-in the derived class.
-
- my $module = My::Module->new({ ... })
- || die My::Module->error(), "\n";
-
- my $module = My::Module->new({ ... })
- || die "constructor error: $My::Module::ERROR\n";
-
-=head2 error($msg, ...)
-
-May be called as an object method to get/set the internal _ERROR member
-or as a class method to get/set the $ERROR variable in the derived class's
-package.
-
- my $module = My::Module->new({ ... })
- || die My::Module->error(), "\n";
-
- $module->do_something()
- || die $module->error(), "\n";
-
-When called with parameters (multiple params are concatenated), this
-method will set the relevant variable and return undef. This is most
-often used within object methods to report errors to the caller.
-
- package My::Module;
-
- sub foobar {
- my $self = shift;
-
- # some other code...
-
- return $self->error('some kind of error...')
- if $some_condition;
- }
-
-=head2 debug($msg, ...)
-
-Generates a debugging message by concatenating all arguments
-passed into a string and printing it to STDERR. A prefix is
-added to indicate the module of the caller.
-
- package My::Module;
-
- sub foobar {
- my $self = shift;
-
- $self->debug('called foobar()');
-
- # some other code...
- }
-
-When the foobar() method is called, the following message
-is sent to STDERR:
-
- [My::Module] called foobar()
-
-Objects can set an internal DEBUG value which the debug()
-method will examine. If this value sets the relevant bits
-to indicate DEBUG_CALLER then the file and line number of
-the caller will be appened to the message.
-
- use Template::Constants qw( :debug );
-
- my $module = My::Module->new({
- DEBUG => DEBUG_SERVICE | DEBUG_CONTEXT | DEBUG_CALLER,
- });
-
- $module->foobar();
-
-This generates an error message such as:
-
- [My::Module] called foobar() at My/Module.pm line 6
-
-=head1 AUTHOR
-
-Andy Wardley E<lt>abw@andywardley.comE<gt>
-
-L<http://www.andywardley.com/|http://www.andywardley.com/>
-
-
-
-
-=head1 VERSION
-
-2.69, 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>
-
-=cut
-
-# Local Variables:
-# mode: perl
-# perl-indent-level: 4
-# indent-tabs-mode: nil
-# End:
-#
-# vim: expandtab shiftwidth=4: