Template::Plugin::Dumper(3pm)

1Template::Plugin::DumpeUrs(e3r)Contributed Perl DocumentTaetmipolnate::Plugin::Dumper(3)
2
3
4

NAME

6       Template::Plugin::Dumper - Plugin interface to Data::Dumper
7

SYNOPSIS

9           [% USE Dumper %]
10
11           [% Dumper.dump(variable) %]
12           [% Dumper.dump_html(variable) %]
13

DESCRIPTION

15       This is a very simple Template Toolkit Plugin Interface to the
16       Data::Dumper module.  A Dumper object will be instantiated via the fol‐
17       lowing directive:
18
19           [% USE Dumper %]
20
21       As a standard plugin, you can also specify its name in lower case:
22
23           [% USE dumper %]
24
25       The Data::Dumper 'Pad', 'Indent' and 'Varname' options are supported as
26       constructor arguments to affect the output generated.  See Data::Dumper
27       for further details.
28
29           [% USE dumper(Indent=0, Pad="<br>") %]
30
31       These options can also be specified in lower case.
32
33           [% USE dumper(indent=0, pad="<br>") %]
34

METHODS

36       There are two methods supported by the Dumper object.  Each will output
37       into the template the contents of the variables passed to the object
38       method.
39
40       dump()
41
42       Generates a raw text dump of the data structure(s) passed
43
44           [% USE Dumper %]
45           [% Dumper.dump(myvar) %]
46           [% Dumper.dump(myvar, yourvar) %]
47
48       dump_html()
49
50       Generates a dump of the data structures, as per dump(), but with the
51       characters <, > and & converted to their equivalent HTML entities and
52       newlines converted to <br>.
53
54           [% USE Dumper %]
55           [% Dumper.dump_html(myvar) %]
56

AUTHOR

58       Simon Matthews <sam@knowledgepool.com>
59

VERSION

61       2.7, distributed as part of the Template Toolkit version 2.18, released
62       on 09 February 2007.
63

COPYRIGHT

65       Copyright (C) 2000 Simon Matthews All Rights Reserved.
66
67       This module is free software; you can redistribute it and/or modify it
68       under the same terms as Perl itself.
69