Template::Plugin::Dumper(3pm)

Template::Plugin::Dumper3pm

Plugin interface to data::dumper

Usage

    [% USE Dumper %]
    
    [% Dumper.dump(variable) %]
    [% Dumper.dump_html(variable) %]

Overview

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 following Data::Dumper options are supported as constructor arguments to affect the output generated:

"Indent", "Pad", "Varname", "Purity", "Useqq", "Terse", "Freezer", "Toaster", "Deepcopy", "Quotekeys", "Bless", "Maxdepth", "Sortkeys".

See Data::Dumper for further details on each option.

    [% USE dumper(Indent=0, Pad="<br>") %]
    [% USE dumper(Sortkeys=1, Terse=1) %]

These options can also be specified in lower case.

    [% USE dumper(indent=0, pad="<br>") %]

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.

dump()

Generates a raw text dump of the data structure(s) passed

    [% USE Dumper %]
    [% Dumper.dump(myvar) %]
    [% Dumper.dump(myvar, yourvar) %]

dump_html()

Generates a dump of the data structures, as per dump(), but with the characters <, > and & converted to their equivalent HTML entities and newlines converted to <br>.

    [% USE Dumper %]
    [% Dumper.dump_html(myvar) %]

Releases

13 releases since Debian 3.0 (Woody); the text changed 11 times.

  1. 3.0
  2. 3.1–4.0
  3. 5.0
  4. 6.0
  5. 7
  6. 8
  7. 9
  8. 10
  9. 11
  10. 12
  11. 13
  12. Arch

Author

Simon Matthews <[email protected]>

From perl-template-toolkit 3.106-2 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.