|AppConfig::CGI(3pm)||User Contributed Perl Documentation||AppConfig::CGI(3pm)|
NAME¶AppConfig::CGI - Perl5 module for processing CGI script parameters.
use AppConfig::CGI; my $state = AppConfig::State->new(\%cfg); my $cgi = AppConfig::CGI->new($state); $cgi->parse($cgi_query); $cgi->parse(); # looks for CGI query in environment
OVERVIEW¶AppConfig::CGI is a Perl5 module which implements a CGI interface to AppConfig. It examines the QUERY_STRING environment variable, or a string passed explicitly by parameter, which represents the additional parameters passed to a CGI query. This is then used to update variable values in an AppConfig::State object accordingly.
AppConfig::CGI is distributed as part of the AppConfig bundle.
USING THE AppConfig::CGI MODULE¶To import and use the AppConfig::CGI module the following line should appear in your Perl script:
AppConfig::CGI is used automatically if you use the AppConfig module and create an AppConfig::CGI object through the cgi() method. AppConfig::CGI is implemented using object-oriented methods. A new AppConfig::CGI object is created and initialised using the new() method. This returns a reference to a new AppConfig::CGI object. A reference to an AppConfig::State object should be passed in as the first parameter:
my $state = AppConfig::State->new(); my $cgi = AppConfig::CGI->new($state);
This will create and return a reference to a new AppConfig::CGI object.
PARSING CGI QUERIES¶The "parse()" method is used to parse a CGI query which can be specified explicitly, or is automatically extracted from the "QUERY_STRING" CGI environment variable. This currently limits the module to only supporting the GET method.
See AppConfig for information about using the AppConfig::CGI module via the cgi() method.
AUTHOR¶Andy Wardley, "<email@example.com>"
COPYRIGHT¶Copyright (C) 1997-2007 Andy Wardley. All Rights Reserved.
Copyright (C) 1997,1998 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¶AppConfig, AppConfig::State