|  | Tutorial |  |

|  | Manual |  |

|  | Modules |  |

|  | Library |  |

|  | Tools |  |

|  | FAQ |  |

|  | Release |  |

| Template Toolkit | Modules | Template::Plugin::Dumper |

## Template::Plugin::Dumper

| Template::Plugin::Directory

Template::Plugin::File |

Plugin interface to Data::Dumper

### Table of Contents

- SYNOPSIS
- DESCRIPTION
- METHODS
  - dump()
  - dump_html()
- AUTHOR
- VERSION
- COPYRIGHT
- SEE ALSO

SYNOPSIS | [ Index ] [ Modules ] [ Top ]

        [% USE Dumper %]

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

DESCRIPTION | [ Index ] [ Modules ] [ 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::Dumperfor further details.

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

These options can also be specified in lower case.

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

METHODS | [ Index ] [ Modules ] [ 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()

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

AUTHOR | [ Index ] [ Modules ] [ Top ]

Simon Matthews <sam@knowledgepool.com>

VERSION | [ Index ] [ Modules ] [ Top ]

2.65, distributed as part of the Template Toolkit version 2.14, released on 04 October 2004.

COPYRIGHT | [ Index ] [ Modules ] [ 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 | [ Index ] [ Modules ] [ Top ]

Template::Plugin, Data::Dumper

| Template::Plugin::Directory

Template::Plugin::File |

| Tutorial |

| Manual |

| Modules |

| Library |

| Tools |

| FAQ |

| Release |

| http://www.template-toolkit.org/ |