File Coverage

blib/lib/Template/Plugin/CGI.pm

Criterion	Covered	Total	%
statement	22	22	100.0
branch	2	2	100.0
condition	2	3	66.6
subroutine	6	6	100.0
pod	1	2	50.0
total	33	35	94.2

#============================================================= -*-Perl-*-
#
# Template::Plugin::CGI
#
# DESCRIPTION
#   Simple Template Toolkit plugin interfacing to the CGI.pm module.
#
# AUTHOR
#   Andy Wardley
#
# COPYRIGHT
#   Copyright (C) 1996-2007 Andy Wardley.  All Rights Reserved.
#
#   This module is free software; you can redistribute it and/or
#   modify it under the same terms as Perl itself.
#
#============================================================================

package Template::Plugin::CGI;
our $AUTHORITY = 'cpan:TODDR';
# ABSTRACT: Simple Template Toolkit plugin interfacing to the CGI.pm module
$Template::Plugin::CGI::VERSION = '3.101';
use strict;
use warnings;
use base 'Template::Plugin';
use CGI;

sub new {
    my $class   = shift;
    my $context = shift;
    CGI->new(@_);
}

# monkeypatch CGI::params() method to Do The Right Thing in TT land

sub CGI::params {
    my $self = shift;
    local $" = ', ';

    return $self->{ _TT_PARAMS } ||= do {
        # must call Vars() in a list context to receive
        # plain list of key/vals rather than a tied hash
        my $params = { $self->Vars() };

        # convert any null separated values into lists
        @$params{ keys %$params } = map {
            /\0/ ? [ split /\0/ ] : $_
        } values %$params;

        $params;
    };
}

1;

=pod

=encoding UTF-8

=head1 NAME

Template::Plugin::CGI - Simple Template Toolkit plugin interfacing to the CGI.pm module

=head1 VERSION

version 3.101

=head1 SYNOPSIS

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

    [% USE things = CGI %]
    [% things.param('name') %]

    # see CGI docs for other methods provided by the CGI object

=head1 DESCRIPTION

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

    [% USE CGI %]

C 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 C directive will be passed to the plugin
constructor:

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

=head1 NAME

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

=head1 METHODS

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

=head2 params()

This method returns a reference to a hash of all the C 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

=head1 AUTHOR

Andy Wardley [e-mail] L

=head1 COPYRIGHT

Copyright (C) 1996-2007 Andy Wardley.  All Rights Reserved.

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

=head1 SEE ALSO

L, L

=head1 AUTHOR

Andy Wardley

=head1 COPYRIGHT AND LICENSE

This software is Copyright (c) 2022 by Andy Wardley.

This is free software, licensed under:

  The MIT (X11) License

=cut

__END__