summaryrefslogtreecommitdiff
path: root/lib/Template/Plugin/Datafile.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/Plugin/Datafile.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/Plugin/Datafile.pm')
-rw-r--r--lib/Template/Plugin/Datafile.pm198
1 files changed, 0 insertions, 198 deletions
diff --git a/lib/Template/Plugin/Datafile.pm b/lib/Template/Plugin/Datafile.pm
deleted file mode 100644
index 5cf53af..0000000
--- a/lib/Template/Plugin/Datafile.pm
+++ /dev/null
@@ -1,198 +0,0 @@
-#============================================================= -*-Perl-*-
-#
-# Template::Plugin::Datafile
-#
-# DESCRIPTION
-#
-# Template Toolkit Plugin which reads a datafile and constructs a
-# list object containing hashes representing records in the file.
-#
-# 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: Datafile.pm,v 2.66 2004/01/13 16:20:38 abw Exp $
-#
-#============================================================================
-
-package Template::Plugin::Datafile;
-
-require 5.004;
-
-use strict;
-use vars qw( @ISA $VERSION );
-use base qw( Template::Plugin );
-use Template::Plugin;
-
-$VERSION = sprintf("%d.%02d", q$Revision: 2.66 $ =~ /(\d+)\.(\d+)/);
-
-sub new {
- my ($class, $context, $filename, $params) = @_;
- my ($delim, $line, @fields, @data, @results);
- my $self = [ ];
- local *FD;
- local $/ = "\n";
-
- $params ||= { };
- $delim = $params->{'delim'} || ':';
- $delim = quotemeta($delim);
-
- return $class->fail("No filename specified")
- unless $filename;
-
- open(FD, $filename)
- || return $class->fail("$filename: $!");
-
- # first line of file should contain field definitions
- while (! $line || $line =~ /^#/) {
- $line = <FD>;
- chomp $line;
- $line =~ s/\r$//;
- }
-
- (@fields = split(/\s*$delim\s*/, $line))
- || return $class->fail("first line of file must contain field names");
-
- # read each line of the file
- while (<FD>) {
- chomp;
- s/\r$//;
-
- # ignore comments and blank lines
- next if /^#/ || /^\s*$/;
-
- # split line into fields
- @data = split(/\s*$delim\s*/);
-
- # create hash record to represent data
- my %record;
- @record{ @fields } = @data;
-
- push(@$self, \%record);
- }
-
-# return $self;
- bless $self, $class;
-}
-
-
-sub as_list {
- return $_[0];
-}
-
-
-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::Plugin::Datafile - Plugin to construct records from a simple data file
-
-=head1 SYNOPSIS
-
- [% USE mydata = datafile('/path/to/datafile') %]
- [% USE mydata = datafile('/path/to/datafile', delim = '|') %]
-
- [% FOREACH record = mydata %]
- [% record.this %] [% record.that %]
- [% END %]
-
-=head1 DESCRIPTION
-
-This plugin provides a simple facility to construct a list of hash
-references, each of which represents a data record of known structure,
-from a data file.
-
- [% USE datafile(filename) %]
-
-A absolute filename must be specified (for this initial implementation at
-least - in a future version it might also use the INCLUDE_PATH). An
-optional 'delim' parameter may also be provided to specify an alternate
-delimiter character.
-
- [% USE userlist = datafile('/path/to/file/users') %]
- [% USE things = datafile('items', delim = '|') %]
-
-The format of the file is intentionally simple. The first line
-defines the field names, delimited by colons with optional surrounding
-whitespace. Subsequent lines then defines records containing data
-items, also delimited by colons. e.g.
-
- id : name : email : tel
- abw : Andy Wardley : abw@cre.canon.co.uk : 555-1234
- neilb : Neil Bowers : neilb@cre.canon.co.uk : 555-9876
-
-Each line is read, split into composite fields, and then used to
-initialise a hash array containing the field names as relevant keys.
-The plugin returns a blessed list reference containing the hash
-references in the order as defined in the file.
-
- [% FOREACH user = userlist %]
- [% user.id %]: [% user.name %]
- [% END %]
-
-The first line of the file B<must> contain the field definitions.
-After the first line, blank lines will be ignored, along with comment
-line which start with a '#'.
-
-=head1 BUGS
-
-Should handle file names relative to INCLUDE_PATH.
-Doesn't permit use of ':' in a field. Some escaping mechanism is required.
-
-=head1 AUTHOR
-
-Andy Wardley E<lt>abw@andywardley.comE<gt>
-
-L<http://www.andywardley.com/|http://www.andywardley.com/>
-
-
-
-
-=head1 VERSION
-
-2.66, 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::Plugin|Template::Plugin>
-
-=cut
-
-# Local Variables:
-# mode: perl
-# perl-indent-level: 4
-# indent-tabs-mode: nil
-# End:
-#
-# vim: expandtab shiftwidth=4: