joes 2004/07/13 13:42:46
Modified: glue/perl/xsbuilder/Apache/Request Request_pod
Log:
Document param() exceptions.
Revision Changes Path
1.20 +10 -3
httpd-apreq-2/glue/perl/xsbuilder/Apache/Request/Request_pod
Index: Request_pod
===================================================================
RCS file:
/home/cvs/httpd-apreq-2/glue/perl/xsbuilder/Apache/Request/Request_pod,v
retrieving revision 1.19
retrieving revision 1.20
diff -u -r1.19 -r1.20
--- Request_pod 11 Jul 2004 06:31:44 -0000 1.19
+++ Request_pod 13 Jul 2004 20:42:46 -0000 1.20
@@ -132,13 +132,20 @@
blocks of the incoming request body until it has found the
the "foo" param or parsing is completed.
+Observe that C<< scalar $req->param("foo") >> will not raise
+an exception if it can locate "foo" in the existing body or
+args tables, even if the query-string parser or the body parser
+has failed. In all other circumstances C<param> will throw an
+Apache::Request::Error object into $@ should either parser fail.
+
Note: modifications to the C<< scalar $req->param() >> table only
affect the returned table object (the underlying C apr_table_t is
-generated by apreq_params()). They do not affect the actual
-request data, and will not be seen by other libapreq2 applications.
+I<generated> from the parse data by apreq_params()). Modifications
+do not affect the actual request data, and will not be seen by other
+libapreq2 applications.
-XXX EXCEPTIONS XXX
+XXX Need to document all Apache::*::Error classes XXX
=head2 C<parms>, C<params> [DEPRECATED]
