stas 2003/03/12 17:05:33
Modified: src/docs/2.0/api/Apache RequestRec.pod RequestUtil.pod
Log:
document $r->main/ add an xref to is_initial_req
Revision Changes Path
1.3 +13 -7 modperl-docs/src/docs/2.0/api/Apache/RequestRec.pod
Index: RequestRec.pod
===================================================================
RCS file: /home/cvs/modperl-docs/src/docs/2.0/api/Apache/RequestRec.pod,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- RequestRec.pod 24 Feb 2003 00:14:27 -0000 1.2
+++ RequestRec.pod 13 Mar 2003 01:05:33 -0000 1.3
@@ -22,16 +22,14 @@
Function arguments (if any) and return values are shown in the
function's synopsis.
-=over
-
-=item * server()
+=head2 server()
$s = $r->server;
Gets the C<Apache::Server> object for the server the request C<$r> is
running under.
-=item * dir_config()
+=head2 dir_config()
dir_config() provides an interface for the per-directory variable
specified by the C<PerlSetVar> and C<PerlAddVar> directives, and also
@@ -75,7 +73,7 @@
values associated with the key C<$key> (and the key itself) will be
deleted.
-=item * ap_auth_type()
+=head2 ap_auth_type()
C<$r-E<gt>ap_auth_type> gets or sets the I<ap_auth_type> slot in the
request record.
@@ -96,9 +94,17 @@
Note that C<$r-E<gt>ap_auth_type> was C<$r-E<gt>connection-E<gt>auth_type>
in the mod_perl 1.0 API.
-=item *
+=head2 main()
+
+ $main_r = $r->main;
+
+If the current request is a sub-request, this method returns a blessed
+reference to the main request structure. If the current request is the
+main request, then this method returns undef.
-=back
+To figure out whether you are inside a main request or a
+sub-request/internal redirect, use
+C<L<$r-E<gt>is_initial_req|docs::2.0::api::Apache::RequestUtil/is_initial_req__>>.
=cut
1.3 +20 -30 modperl-docs/src/docs/2.0/api/Apache/RequestUtil.pod
Index: RequestUtil.pod
===================================================================
RCS file: /home/cvs/modperl-docs/src/docs/2.0/api/Apache/RequestUtil.pod,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- RequestUtil.pod 20 Feb 2003 05:01:45 -0000 1.2
+++ RequestUtil.pod 13 Mar 2003 01:05:33 -0000 1.3
@@ -17,48 +17,42 @@
Function arguments (if any) and return values are shown in the
function's synopsis.
-=head2 FUNCTIONS
+=head1 FUNCTIONS
-=over
+=head2 * Apache-E<gt>request()
-=item * Apache-E<gt>request()
-=back
+=head1 METHODS
+=head2 new()
-=head2 METHODS
+=head2 get_server_name()
-=over
+=head2 get_server_port()
-=item * new()
+=head2 dir_config()
-=item * get_server_name()
+=head2 get_status_line()
-=item * get_server_port()
+=head2 is_initial_req()
-=item * dir_config()
+=head2 method_register()
-=item * get_status_line()
+=head2 add_config()
-=item * is_initial_req()
+=head2 location()
-=item * method_register()
+=head2 location_merge()
-=item * add_config()
+=head2 no_cache()
-=item * location()
+=head2 pnotes()
-=item * location_merge()
+=head2 set_basic_credentials()
-=item * no_cache()
+=head2 as_string()
-=item * pnotes()
-
-=item * set_basic_credentials()
-
-=item * as_string()
-
-=item * push_handlers()
+=head2 push_handlers()
$r->push_handlers(PerlResponseHandler => \&handler);
$r->push_handlers(PerlResponseHandler => [\&handler, \&handler2]);
@@ -66,12 +60,8 @@
# XXX: not implemented yet
$r->push_handlers(PerlResponseHandler => sub {...});
-=item * add_handlers()
-
-=item * get_handlers()
-
-
-=back
+=head2 add_handlers()
+=head2 get_handlers()
=cut
