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