Andy Wardley > Template-Toolkit-2.14 > Template::Plugin::CGI

Download:
Template-Toolkit-2.14.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  49
Open  16
View/Report Bugs
Module Version: 2.65   Source   Latest Release: Template-Toolkit-2.25

NAME ^

Template::Plugin::CGI - Interface to the CGI module

SYNOPSIS ^

    [% USE CGI %]
    [% CGI.param('parameter') %]

    [% USE things = CGI %]
    [% things.param('name') %]
    
    # see CGI docs for other methods provided by the CGI object

DESCRIPTION ^

This is a very simple Template Toolkit Plugin interface to the CGI module. A CGI object will be instantiated via the following directive:

    [% USE CGI %]

CGI methods may then be called as follows:

    [% CGI.header %]
    [% CGI.param('parameter') %]

An alias can be used to provide an alternate name by which the object should be identified.

    [% USE mycgi = CGI %]
    [% mycgi.start_form %]
    [% mycgi.popup_menu({ Name   => 'Color'
                          Values => [ 'Green' 'Black' 'Brown' ] }) %]

Parenthesised parameters to the USE directive will be passed to the plugin constructor:

    [% USE cgiprm = CGI('uid=abw&name=Andy+Wardley') %]
    [% cgiprm.param('uid') %]

METHODS ^

In addition to all the methods supported by the CGI module, this plugin defines the following.

params()

This method returns a reference to a hash of all the CGI parameters. Any parameters that have multiple values will be returned as lists.

    [% USE CGI('user=abw&item=foo&item=bar') %]

    [% CGI.params.user %]            # abw
    [% CGI.params.item.join(', ') %] # foo, bar

AUTHOR ^

Andy Wardley <abw@andywardley.com>

http://www.andywardley.com/

VERSION ^

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

COPYRIGHT ^

  Copyright (C) 1996-2004 Andy Wardley.  All Rights Reserved.
  Copyright (C) 1998-2002 Canon Research Centre Europe Ltd.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

SEE ALSO ^

Template::Plugin, CGI

syntax highlighting: