home *** CD-ROM | disk | FTP | other *** search
/ PC Professionell 2004 December / PCpro_2004_12.ISO / files / webserver / tsw / TSW_3.4.0.exe / Apache2 / perl / CGI.pm < prev    next >
Encoding:
Perl POD Document  |  2004-01-30  |  4.0 KB  |  169 lines
  1. #============================================================= -*-Perl-*-
  2. #
  3. # Template::Plugin::CGI
  4. #
  5. # DESCRIPTION
  6. #
  7. #   Simple Template Toolkit plugin interfacing to the CGI.pm module.
  8. #
  9. # AUTHOR
  10. #   Andy Wardley   <abw@kfs.org>
  11. #
  12. # COPYRIGHT
  13. #   Copyright (C) 1996-2000 Andy Wardley.  All Rights Reserved.
  14. #   Copyright (C) 1998-2000 Canon Research Centre Europe Ltd.
  15. #
  16. #   This module is free software; you can redistribute it and/or
  17. #   modify it under the same terms as Perl itself.
  18. #
  19. #----------------------------------------------------------------------------
  20. #
  21. # $Id: CGI.pm,v 2.64 2004/01/13 16:20:38 abw Exp $
  22. #
  23. #============================================================================
  24.  
  25. package Template::Plugin::CGI;
  26.  
  27. require 5.004;
  28.  
  29. use strict;
  30. use vars qw( $VERSION );
  31. use base qw( Template::Plugin );
  32. use Template::Plugin;
  33. use CGI;
  34.  
  35. $VERSION = sprintf("%d.%02d", q$Revision: 2.64 $ =~ /(\d+)\.(\d+)/);
  36.  
  37. sub new {
  38.     my $class   = shift;
  39.     my $context = shift;
  40.     CGI->new(@_);
  41. }
  42.  
  43. package CGI;
  44.  
  45. sub params {
  46.     my $self = shift;
  47.     local $" = ', ';
  48.  
  49.     return $self->{ _TT_PARAMS } ||= do {
  50.         # must call Vars() in a list context to receive
  51.         # plain list of key/vals rather than a tied hash
  52.         my $params = { $self->Vars() };
  53.  
  54.         # convert any null separated values into lists
  55.         @$params{ keys %$params } = map { 
  56.             /\0/ ? [ split /\0/ ] : $_ 
  57.         } values %$params;
  58.  
  59.         $params;
  60.     };
  61. }
  62.  
  63. 1;
  64.  
  65. __END__
  66.  
  67.  
  68. #------------------------------------------------------------------------
  69. # IMPORTANT NOTE
  70. #   This documentation is generated automatically from source
  71. #   templates.  Any changes you make here may be lost.
  72. # 
  73. #   The 'docsrc' documentation source bundle is available for download
  74. #   from http://www.template-toolkit.org/docs.html and contains all
  75. #   the source templates, XML files, scripts, etc., from which the
  76. #   documentation for the Template Toolkit is built.
  77. #------------------------------------------------------------------------
  78.  
  79. =head1 NAME
  80.  
  81. Template::Plugin::CGI - Interface to the CGI module
  82.  
  83. =head1 SYNOPSIS
  84.  
  85.     [% USE CGI %]
  86.     [% CGI.param('parameter') %]
  87.  
  88.     [% USE things = CGI %]
  89.     [% things.param('name') %]
  90.     
  91.     # see CGI docs for other methods provided by the CGI object
  92.  
  93. =head1 DESCRIPTION
  94.  
  95. This is a very simple Template Toolkit Plugin interface to the CGI module.
  96. A CGI object will be instantiated via the following directive:
  97.  
  98.     [% USE CGI %]
  99.  
  100. CGI methods may then be called as follows:
  101.  
  102.     [% CGI.header %]
  103.     [% CGI.param('parameter') %]
  104.  
  105. An alias can be used to provide an alternate name by which the object should
  106. be identified.
  107.  
  108.     [% USE mycgi = CGI %]
  109.     [% mycgi.start_form %]
  110.     [% mycgi.popup_menu({ Name   => 'Color'
  111.               Values => [ 'Green' 'Black' 'Brown' ] }) %]
  112.  
  113. Parenthesised parameters to the USE directive will be passed to the plugin 
  114. constructor:
  115.     
  116.     [% USE cgiprm = CGI('uid=abw&name=Andy+Wardley') %]
  117.     [% cgiprm.param('uid') %]
  118.  
  119. =head1 METHODS
  120.  
  121. In addition to all the methods supported by the CGI module, this
  122. plugin defines the following.
  123.  
  124. =head2 params()
  125.  
  126. This method returns a reference to a hash of all the CGI parameters.
  127. Any parameters that have multiple values will be returned as lists.
  128.  
  129.     [% USE CGI('user=abw&item=foo&item=bar') %]
  130.  
  131.     [% CGI.params.user %]            # abw
  132.     [% CGI.params.item.join(', ') %] # foo, bar
  133.  
  134. =head1 AUTHOR
  135.  
  136. Andy Wardley E<lt>abw@andywardley.comE<gt>
  137.  
  138. L<http://www.andywardley.com/|http://www.andywardley.com/>
  139.  
  140.  
  141.  
  142.  
  143. =head1 VERSION
  144.  
  145. 2.64, distributed as part of the
  146. Template Toolkit version 2.13, released on 30 January 2004.
  147.  
  148. =head1 COPYRIGHT
  149.  
  150.   Copyright (C) 1996-2004 Andy Wardley.  All Rights Reserved.
  151.   Copyright (C) 1998-2002 Canon Research Centre Europe Ltd.
  152.  
  153. This module is free software; you can redistribute it and/or
  154. modify it under the same terms as Perl itself.
  155.  
  156. =head1 SEE ALSO
  157.  
  158. L<Template::Plugin|Template::Plugin>, L<CGI|CGI>
  159.  
  160. =cut
  161.  
  162. # Local Variables:
  163. # mode: perl
  164. # perl-indent-level: 4
  165. # indent-tabs-mode: nil
  166. # End:
  167. #
  168. # vim: expandtab shiftwidth=4:
  169.