Template::Plugin::Dumper
Author: Andy Wardley

TT2 Home Page

- Modules
- Template::*
- Plugin::*
- Dumper.pm

Click to view the menu. It's very nice. Click to hide the menu and go all widescreen!
Back

#### Template::Plugin::Directory

Plugin for generating directory listings Up

#### Template::Plugin::* Modules

Next

#### Template::Plugin::File

Plugin providing information about files

# Template::Plugin::Dumper

## Plugin interface to Data::Dumper

# Contents

Top

# SYNOPSIS

Top

    [% USE Dumper %]

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

# DESCRIPTION

Top

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 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>") %]

# METHODS

Top

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()

Top

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

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

## dump_html()

Top

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) %]

# AUTHOR

Top

Simon Matthews <sam@tt2.org>

# COPYRIGHT

Top

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.

# SEE ALSO

Top

Template::Plugin, Data::Dumper

/modules/Template/Plugin/Dumper.html last modified 10:54:59 31-May-2007