home *** CD-ROM | disk | FTP | other *** search
/ PC Professionell 2004 December / PCpro_2004_12.ISO / files / webserver / tsw / TSW_3.4.0.exe / Apache2 / perl / Dumper.pm < prev    next >
Encoding:
Perl POD Document  |  2004-01-30  |  4.4 KB  |  180 lines
  1. #==============================================================================
  2. # 
  3. # Template::Plugin::Dumper
  4. #
  5. # DESCRIPTION
  6. #
  7. # A Template Plugin to provide a Template Interface to Data::Dumper
  8. #
  9. # AUTHOR
  10. #   Simon Matthews <sam@knowledgepool.com>
  11. #
  12. # COPYRIGHT
  13. #
  14. #   Copyright (C) 2000 Simon Matthews.  All Rights Reserved
  15. #
  16. #   This module is free software; you can redistribute it and/or
  17. #   modify it under the same terms as Perl itself.
  18. #
  19. #------------------------------------------------------------------------------
  20. #
  21. # $Id: Dumper.pm,v 2.64 2004/01/13 16:20:38 abw Exp $
  22. # 
  23. #==============================================================================
  24.  
  25. package Template::Plugin::Dumper;
  26.  
  27. require 5.004;
  28.  
  29. use strict;
  30. use Template::Plugin;
  31. use Data::Dumper;
  32.  
  33. use vars qw( $VERSION $DEBUG @DUMPER_ARGS $AUTOLOAD );
  34. use base qw( Template::Plugin );
  35.  
  36. $VERSION = sprintf("%d.%02d", q$Revision: 2.64 $ =~ /(\d+)\.(\d+)/);
  37. $DEBUG   = 0 unless defined $DEBUG;
  38. @DUMPER_ARGS = qw( Indent Pad Varname Purity Useqq Terse Freezer
  39.                    Toaster Deepcopy Quotekeys Bless Maxdepth );
  40.  
  41. #==============================================================================
  42. #                      -----  CLASS METHODS -----
  43. #==============================================================================
  44.  
  45. #------------------------------------------------------------------------
  46. # new($context, \@params)
  47. #------------------------------------------------------------------------
  48.  
  49. sub new {
  50.     my ($class, $context, $params) = @_;
  51.     my ($key, $val);
  52.     $params ||= { };
  53.  
  54.  
  55.     foreach my $arg (@DUMPER_ARGS) {
  56.     no strict 'refs';
  57.     if (defined ($val = $params->{ lc $arg })
  58.         or defined ($val = $params->{ $arg })) {
  59.         ${"Data\::Dumper\::$arg"} = $val;
  60.     }
  61.     }
  62.  
  63.     bless { 
  64.     _CONTEXT => $context, 
  65.     }, $class;
  66. }
  67.  
  68. sub dump {
  69.     my $self = shift;
  70.     my $content = Dumper @_;
  71.     return $content;
  72. }
  73.  
  74.  
  75. sub dump_html {
  76.     my $self = shift;
  77.     my $content = Dumper @_;
  78.     for ($content) {
  79.     s/&/&/g;
  80.     s/</</g;
  81.     s/>/>/g;
  82.     s/\n/<br>\n/g;
  83.     }
  84.     return $content;
  85. }
  86.  
  87. 1;
  88.  
  89. __END__
  90.  
  91.  
  92. #------------------------------------------------------------------------
  93. # IMPORTANT NOTE
  94. #   This documentation is generated automatically from source
  95. #   templates.  Any changes you make here may be lost.
  96. # 
  97. #   The 'docsrc' documentation source bundle is available for download
  98. #   from http://www.template-toolkit.org/docs.html and contains all
  99. #   the source templates, XML files, scripts, etc., from which the
  100. #   documentation for the Template Toolkit is built.
  101. #------------------------------------------------------------------------
  102.  
  103. =head1 NAME
  104.  
  105. Template::Plugin::Dumper - Plugin interface to Data::Dumper
  106.  
  107. =head1 SYNOPSIS
  108.  
  109.     [% USE Dumper %]
  110.  
  111.     [% Dumper.dump(variable) %]
  112.     [% Dumper.dump_html(variable) %]
  113.  
  114. =head1 DESCRIPTION
  115.  
  116. This is a very simple Template Toolkit Plugin Interface to the Data::Dumper
  117. module.  A Dumper object will be instantiated via the following directive:
  118.  
  119.     [% USE Dumper %]
  120.  
  121. As a standard plugin, you can also specify its name in lower case:
  122.  
  123.     [% USE dumper %]
  124.  
  125. The Data::Dumper 'Pad', 'Indent' and 'Varname' options are supported
  126. as constructor arguments to affect the output generated.  See L<Data::Dumper>
  127. for further details.
  128.  
  129.     [% USE dumper(Indent=0, Pad="<br>") %]
  130.  
  131. These options can also be specified in lower case.
  132.  
  133.     [% USE dumper(indent=0, pad="<br>") %]
  134.  
  135. =head1 METHODS
  136.  
  137. There are two methods supported by the Dumper object.  Each will
  138. output into the template the contents of the variables passed to the
  139. object method.
  140.  
  141. =head2 dump()
  142.  
  143. Generates a raw text dump of the data structure(s) passed
  144.  
  145.     [% USE Dumper %]
  146.     [% Dumper.dump(myvar) %]
  147.     [% Dumper.dump(myvar, yourvar) %]
  148.  
  149. =head2 dump_html()
  150.  
  151. Generates a dump of the data structures, as per dump(), but with the 
  152. characters E<lt>, E<gt> and E<amp> converted to their equivalent HTML
  153. entities and newlines converted to E<lt>brE<gt>.
  154.  
  155.     [% USE Dumper %]
  156.     [% Dumper.dump_html(myvar) %]
  157.  
  158. =head1 AUTHOR
  159.  
  160. Simon Matthews E<lt>sam@knowledgepool.comE<gt>
  161.  
  162. =head1 VERSION
  163.  
  164. 2.64, distributed as part of the
  165. Template Toolkit version 2.13, released on 30 January 2004.
  166.  
  167.  
  168.  
  169. =head1 COPYRIGHT
  170.  
  171. Copyright (C) 2000 Simon Matthews All Rights Reserved.
  172.  
  173. This module is free software; you can redistribute it and/or
  174. modify it under the same terms as Perl itself.
  175.  
  176. =head1 SEE ALSO
  177.  
  178. L<Template::Plugin|Template::Plugin>, L<Data::Dumper|Data::Dumper>
  179.  
  180.