added methods: joinlist, scrap2file, printscrap

[selfforum.git] / selfforum-cgi / shared / Template.pm

diff --git a/selfforum-cgi/shared/Template.pm b/selfforum-cgi/shared/Template.pm
index ece7eaa2f132bf6a0e79f08549c6179c65f32fb9..5dc6322a6d2f173385fccb98dc721e06197c7cdc 100644 (file)
--- a/selfforum-cgi/shared/Template.pm
+++ b/selfforum-cgi/shared/Template.pm
@@ -4,17 +4,19 @@ package Template;
 #                                                                              #
 # File:        shared/Template.pm                                              #
 #                                                                              #
-# Authors:     André Malo <nd@o3media.de>, 2001-04-12                          #
-#              Frank Schoenmann <fs@tower.de>, 2001-06-04                      #
+# Authors:     André Malo <nd@o3media.de>                                      #
+#              Frank Schönmann <fs@tower.de>                                   #
 #                                                                              #
 # Description: Handle XML based HTML-Templates                                 #
 #                                                                              #
 ################################################################################
 
 use strict;
-use vars qw($xml_dom_used);
+use vars qw(
+  $xml_dom_used
+);
 
-use Carp qw(croak confess);
+use Carp qw(croak);
 
 BEGIN {
   $xml_dom_used = eval q[
@@ -24,7 +26,18 @@ BEGIN {
   ];
 }
 
-### sub new ####################################################################
+################################################################################
+#
+# Version check
+#
+# last modified:
+#    $Date$ (GMT)
+# by $Author$
+#
+sub VERSION {(q$Revision$ =~ /([\d.]+)\s*$/)[0] or '0.0'}
+
+
+### new () #####################################################################
 #
 # constructor
 #
@@ -43,7 +56,7 @@ sub new {
   $self;
 }
 
-### sub file ###################################################################
+### file () ####################################################################
 #
 # assign new template file to object
 # parse the template file
@@ -64,7 +77,7 @@ sub file {
   $old;
 }
 
-### sub insert #################################################################
+### insert () ##################################################################
 #
 # return the placeholder surrounded by meta delimiters
 #
@@ -83,7 +96,7 @@ sub insert {
   $self -> {metaon} . $name . $self -> {metaoff};
 }
 
-### sub list ###################################################################
+### list () ####################################################################
 #
 # fill in a complete list
 #
@@ -94,19 +107,36 @@ sub insert {
 #
 sub list {
   my $self = shift;
-  my $name = shift;
 
   croak "no template file specified"
     unless (defined $self -> {file});
 
-#  no warnings 'uninitialized';
-  my $list = join '' => map { ${ $self -> scrap ($name, $_) } } @{ +shift };
+  $self -> joinlist ('' => @_);
+}
+
+### joinlist () ################################################################
+#
+# fill in a complete list, using a scrap between the list elements
+#
+# Params: $join  - joining string (or stringref)
+#         $name  - name of the atomic list scrap
+#         $array - list of hashes (same strcuture like the hash used by 'scrap')
+#
+# Return: scalar reference - filled in list
+#
+sub joinlist {
+  my $self = shift;
+  my $join = shift;
+  $join = $$join if ref($join);
+  my $name = shift;
+
+  my $list = join $join => map { ${ $self -> scrap ($name, $_) } } @{ +shift };
 
   # return
   \$list;
 }
 
-### sub scrap ##################################################################
+### scrap () ###################################################################
 #
 # fill in a template scrap
 #
@@ -178,13 +208,50 @@ sub scrap {
   );
 
   # remove newlines
-  $scrap =~ s/\n|\r\n|\n\r|\r//g if ($no_nl);
+  #
+  $scrap =~ s/\015\012|\015|\012//g if ($no_nl);
 
   # return
   \$scrap;
 }
 
-### sub parse_file #############################################################
+### printscrap () ##############################################################
+#
+# fill in a template scrap and print to STDOUT
+#
+# Params: $name    name of the scrap
+#         ...
+#         $no_nl   1 - remove newlines (\n)
+#                  0 - do no such thing
+#
+# Return: success code (boolean)
+#
+sub printscrap {
+  my $self = shift;
+
+  $self -> scrap2file (\*STDOUT, @_);
+}
+
+### scrap2file () ##############################################################
+#
+# fill in a template scrap and print to a file handle
+#
+# Params: $handle  filehandle
+#         $name    name of the scrap
+#         ...
+#         $no_nl   1 - remove newlines (\n)
+#                  0 - do no such thing
+#
+# Return: success code (boolean)
+#
+sub scrap2file {
+  my $self = shift;
+  my $handle = shift;
+
+  print $handle ${$self->scrap(@_)};
+}
+
+### parse_file () ##############################################################
 #
 # read in and parse template file
 #
@@ -284,7 +351,7 @@ sub parse_file {
   return; # anything failed (??)
 }
 
-### sub parse_if ###############################################################
+### parse_if () ################################################################
 #
 # parse conditional blocks
 #
@@ -345,9 +412,9 @@ sub parse_if {
   return;
 }
 
-# keeping 'require' happy
+# keep 'require' happy
 1;
 
 #
 #
-### end of Template ############################################################
+### end of Template ############################################################
\ No newline at end of file