1AppConfig::CGI(3)     User Contributed Perl Documentation    AppConfig::CGI(3)
2
3
4

NAME

6       AppConfig::CGI - Perl5 module for processing CGI script parameters.
7

SYNOPSIS

9           use AppConfig::CGI;
10
11           my $state = AppConfig::State->new(\%cfg);
12           my $cgi   = AppConfig::CGI->new($state);
13
14           $cgi->parse($cgi_query);
15           $cgi->parse();               # looks for CGI query in environment
16

OVERVIEW

18       AppConfig::CGI is a Perl5 module which implements a CGI interface to
19       AppConfig.  It examines the QUERY_STRING environment variable, or a
20       string passed explicitly by parameter, which represents the additional
21       parameters passed to a CGI query.  This is then used to update variable
22       values in an AppConfig::State object accordingly.
23
24       AppConfig::CGI is distributed as part of the AppConfig bundle.
25

DESCRIPTION

27       USING THE AppConfig::CGI MODULE
28
29       To import and use the AppConfig::CGI module the following line should
30       appear in your Perl script:
31
32           use AppConfig::CGI;
33
34       AppConfig::CGI is used automatically if you use the AppConfig module
35       and create an AppConfig::CGI object through the cgi() method.  AppCon‐
36       fig::CGI is implemented using object-oriented methods.  A new AppCon‐
37       fig::CGI object is created and initialised using the new() method.
38       This returns a reference to a new AppConfig::CGI object.  A reference
39       to an AppConfig::State object should be passed in as the first parame‐
40       ter:
41
42           my $state = AppConfig::State->new();
43           my $cgi   = AppConfig::CGI->new($state);
44
45       This will create and return a reference to a new AppConfig::CGI object.
46
47       PARSING CGI QUERIES
48
49       The "parse()" method is used to parse a CGI query which can be speci‐
50       fied explicitly, or is automatically extracted from the "QUERY_STRING"
51       CGI environment variable.  This currently limits the module to only
52       supporting the GET method.
53
54       See AppConfig for information about using the AppConfig::CGI module via
55       the cgi() method.
56

AUTHOR

58       Andy Wardley, "<abw@wardley.org<gt">
59

REVISION

61       $Revision: 1.60 $
62

64       Copyright (C) 1997-2003 Andy Wardley.  All Rights Reserved.
65
66       Copyright (C) 1997,1998 Canon Research Centre Europe Ltd.
67
68       This module is free software; you can redistribute it and/or modify it
69       under the same terms as Perl itself.
70

SEE ALSO

72       AppConfig, AppConfig::State
73
74
75
76perl v5.8.8                       2007-01-02                 AppConfig::CGI(3)
Impressum