Author: randyk
Date: Sat Apr 2 14:03:19 2005
New Revision: 159826
URL: http://svn.apache.org/viewcvs?view=rev&rev=159826
Log:
s/Apache/Apache2/
Modified:
perl/modperl/docs/trunk/src/docs/2.0/api/Apache2/RequestUtil.pod
Modified: perl/modperl/docs/trunk/src/docs/2.0/api/Apache2/RequestUtil.pod
URL:
http://svn.apache.org/viewcvs/perl/modperl/docs/trunk/src/docs/2.0/api/Apache2/RequestUtil.pod?view=diff&r1=159825&r2=159826
==============================================================================
--- perl/modperl/docs/trunk/src/docs/2.0/api/Apache2/RequestUtil.pod (original)
+++ perl/modperl/docs/trunk/src/docs/2.0/api/Apache2/RequestUtil.pod Sat Apr 2
14:03:19 2005
@@ -1,13 +1,13 @@
=head1 NAME
-Apache::RequestUtil - Perl API for Apache request record utils
+Apache2::RequestUtil - Perl API for Apache request record utils
=head1 Synopsis
- use Apache::RequestUtil ();
+ use Apache2::RequestUtil ();
# add httpd config dynamically
$r->add_config(['require valid-user']);
@@ -44,7 +44,7 @@
$port = $r->get_server_port();
# what string Apache is going to send for a given status code
- $status_line = Apache::RequestUtil::get_status_line(404);
+ $status_line = Apache2::RequestUtil::get_status_line(404);
# are we in the main request?
$is_initial = $r->is_initial_req();
@@ -58,8 +58,8 @@
# merge a <Location> container in a request object
$r->location_merge($location);
- # create a new Apache::RequestRec object
- $r = Apache::RequestRec->new($c);
+ # create a new Apache2::RequestRec object
+ $r = Apache2::RequestRec->new($c);
# tell the client not to cache the response
$r->no_cache($boolean);
@@ -71,7 +71,7 @@
$sig = $r->psignature($prefix);
# get the global request object (requires PerlOptions +GlobalRequest)
- $r = Apache->request;
+ $r = Apache2->request;
# insert auth credentials into the request as if the client did that
$r->set_basic_credentials($username, $password);
@@ -90,8 +90,8 @@
=head1 Description
-C<Apache::RequestUtil> provides the L<Apache request
-object|docs::2.0::api::Apache::RequestRec> utilities API.
+C<Apache2::RequestUtil> provides the L<Apache request
+object|docs::2.0::api::Apache2::RequestRec> utilities API.
@@ -112,7 +112,7 @@
=over 4
=item obj: C<$r>
-( C<L<Apache::RequestRec object|docs::2.0::api::Apache::RequestRec>> )
+( C<L<Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec>> )
=item arg1: C<$lines> (ARRAY ref)
@@ -125,7 +125,7 @@
Which allow-override bits are set
Default value is:
-C<L<Apache::OR_AUTHCFG|docs::2.0::api::Apache::Const/C_Apache__OR_AUTHCFG_>>
+C<L<Apache2::OR_AUTHCFG|docs::2.0::api::Apache2::Const/C_Apache2__OR_AUTHCFG_>>
=item ret: no return value
@@ -134,11 +134,11 @@
=back
See also:
-C<L<$s-E<gt>add_config|docs::2.0::api::Apache::ServerUtil/C_add_config_>>
+C<L<$s-E<gt>add_config|docs::2.0::api::Apache2::ServerUtil/C_add_config_>>
For example:
- use Apache::ServerUtil ();
+ use Apache2::ServerUtil ();
$r->add_config(['require valid-user']);
@@ -156,7 +156,7 @@
=over 4
=item obj: C<$r>
-( C<L<Apache::RequestRec object|docs::2.0::api::Apache::RequestRec>> )
+( C<L<Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec>> )
=item ret: C<$dump> ( string )
@@ -180,7 +180,7 @@
=over 4
=item obj: C<$r>
-( C<L<Apache::RequestRec object|docs::2.0::api::Apache::RequestRec>> )
+( C<L<Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec>> )
=item ret: no return value
@@ -202,7 +202,7 @@
=over 4
=item obj: C<$r>
-( C<L<Apache::RequestRec object|docs::2.0::api::Apache::RequestRec>> )
+( C<L<Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec>> )
The current request
@@ -234,7 +234,7 @@
=over 4
=item obj: C<$r>
-( C<L<Apache::RequestRec object|docs::2.0::api::Apache::RequestRec>> )
+( C<L<Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec>> )
=item opt arg2: C<$key> ( string )
@@ -308,7 +308,7 @@
=over 4
=item obj: C<$r>
-( C<L<Apache::RequestRec object|docs::2.0::api::Apache::RequestRec>> )
+( C<L<Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec>> )
The current request
@@ -318,7 +318,7 @@
current request>.
Note the L<limited functionality under threaded
-MPMs|docs::2.0::api::Apache::ServerRec/Limited_Functionality_under_Threaded_MPMs>.
+MPMs|docs::2.0::api::Apache2::ServerRec/Limited_Functionality_under_Threaded_MPMs>.
=item ret: C<$docroot> ( string )
@@ -344,7 +344,7 @@
=over 4
=item obj: C<$r>
-( C<L<Apache::RequestRec object|docs::2.0::api::Apache::RequestRec>> )
+( C<L<Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec>> )
=item arg1: C<$hook_name> ( string )
@@ -359,7 +359,7 @@
=back
See also:
-C<L<$s-E<gt>add_config|docs::2.0::api::Apache::ServerUtil/C_get_handlers_>>
+C<L<$s-E<gt>add_config|docs::2.0::api::Apache2::ServerUtil/C_get_handlers_>>
For example:
@@ -382,7 +382,7 @@
=over 4
=item obj: C<$r>
-( C<L<Apache::RequestRec object|docs::2.0::api::Apache::RequestRec>> )
+( C<L<Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec>> )
The current request
@@ -407,7 +407,7 @@
=over 4
=item obj: C<$r>
-( C<L<Apache::RequestRec object|docs::2.0::api::Apache::RequestRec>> )
+( C<L<Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec>> )
The current request
@@ -421,7 +421,7 @@
For example, consruct a hostport string:
- use Apache::RequestUtil ();
+ use Apache2::RequestUtil ();
my $hostport = join ':', $r->get_server_name, $r->get_server_port;
@@ -437,7 +437,7 @@
=over 4
=item obj: C<$r>
-( C<L<Apache::RequestRec object|docs::2.0::api::Apache::RequestRec>> )
+( C<L<Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec>> )
The current request
@@ -451,7 +451,7 @@
For example, consruct a hostport string:
- use Apache::RequestUtil ();
+ use Apache2::RequestUtil ();
my $hostport = join ':', $r->get_server_name, $r->get_server_port;
@@ -465,7 +465,7 @@
Return the C<Status-Line> for a given status code (excluding the
HTTP-Version field).
- $status_line = Apache::RequestUtil::get_status_line($status);
+ $status_line = Apache2::RequestUtil::get_status_line($status);
=over 4
@@ -486,8 +486,8 @@
For example:
- use Apache::RequestUtil ();
- print Apache::RequestUtil::get_status_line(400);
+ use Apache2::RequestUtil ();
+ print Apache2::RequestUtil::get_status_line(400);
will print:
@@ -507,7 +507,7 @@
=over 4
=item obj: C<$r>
-( C<L<Apache::RequestRec object|docs::2.0::api::Apache::RequestRec>> )
+( C<L<Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec>> )
A request or a sub-request object
@@ -534,7 +534,7 @@
=over 4
=item obj: C<$r>
-( C<L<Apache::RequestRec object|docs::2.0::api::Apache::RequestRec>> )
+( C<L<Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec>> )
=item arg1: C<$flag> ( string )
@@ -553,7 +553,7 @@
See also:
L<PerlOptions|docs::2.0::user::config::config/C_PerlOptions_> and
L<the equivalent function for server level PerlOptions
-flags|docs::2.0::api::Apache::ServerUtil/C_is_perl_option_enabled_>.
+flags|docs::2.0::api::Apache2::ServerUtil/C_is_perl_option_enabled_>.
@@ -569,7 +569,7 @@
=over 4
=item obj: C<$r>
-( C<L<Apache::RequestRec object|docs::2.0::api::Apache::RequestRec>> )
+( C<L<Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec>> )
=item ret: C<$location> ( string )
@@ -592,7 +592,7 @@
=over 4
=item obj: C<$r>
-( C<L<Apache::RequestRec object|docs::2.0::api::Apache::RequestRec>> )
+( C<L<Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec>> )
=item arg1: C<$location> ( string )
@@ -615,8 +615,8 @@
=back
Useful for insertion of a configuration section into a custom
-C<Apache::RequestRec> object, created via the
-C<Apache::RequestRec-E<gt>new()> method. See for example the L<Command
+C<Apache2::RequestRec> object, created via the
+C<Apache2::RequestRec-E<gt>new()> method. See for example the L<Command
Server protocol
example|docs::2.0::user::handlers::protocols/Command_Server>.
@@ -626,27 +626,27 @@
=head2 C<new>
-Create a new C<Apache::RequestRec> object.
+Create a new C<Apache2::RequestRec> object.
- $r = Apache::RequestRec->new($c);
- $r = Apache::RequestRec->new($c, $pool);
+ $r = Apache2::RequestRec->new($c);
+ $r = Apache2::RequestRec->new($c, $pool);
=over 4
-=item obj: C<Apache::RequestRec>
-( C<L<Apache::RequestRec class name|docs::2.0::api::Apache::RequestRec>> )
+=item obj: C<Apache2::RequestRec>
+( C<L<Apache2::RequestRec class name|docs::2.0::api::Apache2::RequestRec>> )
=item arg1: C<$c>
-(C<L<Apache::Connection object|docs::2.0::api::Apache::Connection>>)
+(C<L<Apache2::Connection object|docs::2.0::api::Apache2::Connection>>)
=item opt arg2: C<$pool>
If no C<$pool> argument is passed, C<$c-E<gt>pool> is used. That means
-that the created C<Apache::RequestRec> object will be valid as long as
+that the created C<Apache2::RequestRec> object will be valid as long as
the connection object is valid.
=item ret: C<$r>
-( C<L<Apache::RequestRec object|docs::2.0::api::Apache::RequestRec>> )
+( C<L<Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec>> )
=item since: 1.99_10
@@ -655,7 +655,7 @@
It's possible to reuse the HTTP framework features outside the
familiar HTTP request cycle. It's possible to write your own full or
partial HTTP implementation without needing a running Apache
-server. You will need the C<Apache::RequestRec> object in order to be
+server. You will need the C<Apache2::RequestRec> object in order to be
able to reuse the rich functionality supplied via this object.
See for example the L<Command Server protocol
@@ -677,7 +677,7 @@
=over 4
=item obj: C<$r>
-( C<L<Apache::RequestRec object|docs::2.0::api::Apache::RequestRec>> )
+( C<L<Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec>> )
=item arg1: C<$boolean> ( boolean )
@@ -720,7 +720,7 @@
=over 4
=item obj: C<$r>
-( C<L<Apache::RequestRec object|docs::2.0::api::Apache::RequestRec>> )
+( C<L<Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec>> )
=item opt arg1: C<$key> ( string )
@@ -747,7 +747,7 @@
=back
This method provides functionality similar to
-(C<L<Apache::RequestRec::notes|docs::2.0::api::Apache::RequestRec/C_notes_>>),
+(C<L<Apache2::RequestRec::notes|docs::2.0::api::Apache2::RequestRec/C_notes_>>),
but values can be any Perl variables. That also means that it can be
used only between Perl modules.
@@ -823,7 +823,7 @@
=over 4
=item obj: C<$r>
-( C<L<Apache::RequestRec|docs::2.0::api::Apache::RequestRec>> )
+( C<L<Apache2::RequestRec|docs::2.0::api::Apache2::RequestRec>> )
=item arg1: C<$prefix> ( string )
@@ -847,24 +847,24 @@
=head2 C<request>
-Get/set the ( C<L<Apache::RequestRec
-object|docs::2.0::api::Apache::RequestRec>> ) object for the current
+Get/set the ( C<L<Apache2::RequestRec
+object|docs::2.0::api::Apache2::RequestRec>> ) object for the current
request.
- $r = Apache->request;
- Apache->request($new_r);
+ $r = Apache2->request;
+ Apache2->request($new_r);
=over 4
-=item obj: C<Apache> (class name)
+=item obj: C<Apache2> (class name)
The Apache class name
=item opt arg1: C<$new_r>
-( C<L<Apache::RequestRec object|docs::2.0::api::Apache::RequestRec>> )
+( C<L<Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec>> )
=item ret: C<$r>
-( C<L<Apache::RequestRec object|docs::2.0::api::Apache::RequestRec>> )
+( C<L<Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec>> )
=item since: 1.99_17
@@ -872,7 +872,7 @@
The get-able part of this method is only available if C<L<PerlOptions
+GlobalRequest|docs::2.0::user::config::config/C_GlobalRequest_>> is
-in effect or if C<Apache-E<gt>request($new_r)> was called earlier. So
+in effect or if C<Apache2-E<gt>request($new_r)> was called earlier. So
instead of setting C<L<PerlOptions
+GlobalRequest|docs::2.0::user::config::config/C_GlobalRequest_>>, one
can set the global request from within the handler.
@@ -893,7 +893,7 @@
=over 4
=item obj: C<$r>
-( C<L<Apache::RequestRec object|docs::2.0::api::Apache::RequestRec>> )
+( C<L<Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec>> )
=item arg1: C<$hook_name> ( string )
@@ -914,13 +914,13 @@
=item since: 1.99_10
See also:
-C<L<$s-E<gt>add_config|docs::2.0::api::Apache::ServerUtil/C_push_handlers_>>
+C<L<$s-E<gt>add_config|docs::2.0::api::Apache2::ServerUtil/C_push_handlers_>>
Note that to push input/output filters you have to use
-C<L<Apache::Filter|docs::2.0::api::Apache::Filter>> methods:
-C<L<add_input_filter|docs::2.0::api::Apache::Filter/C_add_input_filter_>>
+C<L<Apache2::Filter|docs::2.0::api::Apache2::Filter>> methods:
+C<L<add_input_filter|docs::2.0::api::Apache2::Filter/C_add_input_filter_>>
and
-C<L<add_output_filter|docs::2.0::api::Apache::Filter/C_add_output_filter_>>.
+C<L<add_output_filter|docs::2.0::api::Apache2::Filter/C_add_output_filter_>>.
=back
@@ -936,7 +936,7 @@
Anonymous functions:
- $r->push_handlers(PerlLogHandler => sub { return Apache::OK });
+ $r->push_handlers(PerlLogHandler => sub { return Apache2::OK });
@@ -954,7 +954,7 @@
=over 4
=item obj: C<$r>
-( C<L<Apache::RequestRec object|docs::2.0::api::Apache::RequestRec>> )
+( C<L<Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec>> )
=item arg1: C<$username> ( string )
@@ -989,7 +989,7 @@
=over 4
=item obj: C<$r>
-( C<L<Apache::RequestRec object|docs::2.0::api::Apache::RequestRec>> )
+( C<L<Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec>> )
=item arg1: C<$hook_name> ( string )
@@ -1015,7 +1015,7 @@
=back
See also:
-C<L<$s-E<gt>add_config|docs::2.0::api::Apache::ServerUtil/C_set_handlers_>>
+C<L<$s-E<gt>add_config|docs::2.0::api::Apache2::ServerUtil/C_set_handlers_>>
Examples:
@@ -1029,7 +1029,7 @@
Anonymous functions:
- $r->set_handlers(PerlLogHandler => sub { return Apache::OK });
+ $r->set_handlers(PerlLogHandler => sub { return Apache2::OK });
Reset any previously set handlers:
@@ -1054,7 +1054,7 @@
=over 4
=item obj: C<$r>
-( C<L<Apache::RequestRec object|docs::2.0::api::Apache::RequestRec>> )
+( C<L<Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec>> )
=item arg1: C<$tainted> (number)
@@ -1089,7 +1089,7 @@
=back
Note that if you assign to C<$r-E<gt>filename> you need to L<update
-its stat record|docs::2.0::api::Apache::RequestRec/C_filename_>.
+its stat record|docs::2.0::api::Apache2::RequestRec/C_filename_>.
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
