cvsuser 02/01/03 10:32:58
Modified: P5EEx/Blue/P5EEx/Blue/Context CGI.pm
Log:
fixed missing POD section
Revision Changes Path
1.2 +37 -1 p5ee/P5EEx/Blue/P5EEx/Blue/Context/CGI.pm
Index: CGI.pm
===================================================================
RCS file: /cvs/public/p5ee/P5EEx/Blue/P5EEx/Blue/Context/CGI.pm,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -w -r1.1 -r1.2
--- CGI.pm 3 Jan 2002 18:19:16 -0000 1.1
+++ CGI.pm 3 Jan 2002 18:32:58 -0000 1.2
@@ -1,6 +1,6 @@
#############################################################################
-## $Id: CGI.pm,v 1.1 2002/01/03 18:19:16 spadkins Exp $
+## $Id: CGI.pm,v 1.2 2002/01/03 18:32:58 spadkins Exp $
#############################################################################
package P5EEx::Blue::Context::CGI;
@@ -12,6 +12,42 @@
use strict;
use CGI;
+
+=head1 NAME
+
+P5EEx::Blue::Context::CGI - CGI context in which we are currently running
+
+=head1 SYNOPSIS
+
+ # ... official way to get a Context object ...
+ use P5EEx::Blue::P5EE;
+ $context = P5EEx::Blue::P5EE->context();
+ $config = $context->config(); # get the configuration
+ $config->dispatch_events(); # dispatch events
+
+ # ... alternative way (used internally) ...
+ use P5EEx::Blue::Context::CGI;
+ $context = P5EEx::Blue::Context::CGI->new();
+
+=cut
+
+#############################################################################
+# DESCRIPTION
+#############################################################################
+
+=head1 DESCRIPTION
+
+A Context class models the environment (aka "context)
+in which the current process is running.
+For the P5EEx::Blue::Context::CGI class, this models the CGI environment.
+
+The role of the Context::CGI class is to abstract the details of the
+CGI runtime environments (including the "event loop", which spans
+multiple HTTP requests).
+
+The Context object is a singleton per process.
+
+=cut
#############################################################################
# PROTECTED METHODS
