stas 2003/02/23 16:14:27
Modified: src/docs/2.0/api config.cfg
src/docs/2.0/api/Apache RequestRec.pod
Added: src/docs/2.0/api/Apache Access.pod
Log:
- start Apache::Access + document $r->auth_type;
- document $r->ap_auth_type
Submitted by: Geoffrey Young <[EMAIL PROTECTED]>
Reviewed by: stas
Revision Changes Path
1.16 +1 -0 modperl-docs/src/docs/2.0/api/config.cfg
Index: config.cfg
===================================================================
RCS file: /home/cvs/modperl-docs/src/docs/2.0/api/config.cfg,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -r1.15 -r1.16
--- config.cfg 29 Jan 2003 03:40:38 -0000 1.15
+++ config.cfg 24 Feb 2003 00:14:26 -0000 1.16
@@ -17,6 +17,7 @@
group => 'Apache:: Core API',
chapters => [qw(
+ Apache/Access.pod
Apache/Log.pod
Apache/Directive.pod
Apache/RequestRec.pod
1.2 +21 -0 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.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- RequestRec.pod 27 Jan 2003 04:05:12 -0000 1.1
+++ RequestRec.pod 24 Feb 2003 00:14:27 -0000 1.2
@@ -75,6 +75,27 @@
values associated with the key C<$key> (and the key itself) will be
deleted.
+=item * ap_auth_type()
+
+C<$r-E<gt>ap_auth_type> gets or sets the I<ap_auth_type> slot in the
+request record.
+
+ $r->ap_auth_type('Basic');
+
+or
+
+ my $auth_type = $r->ap_auth_type;
+
+I<ap_auth_type> holds the authentication type that has been negotiated
+between the client and server during the actual request. Generally,
+I<ap_auth_type> is populated automatically when you call
+C<$r-E<gt>get_basic_auth_pw> so you don't really need to worry
+too much about it, but if you want to roll your own authentication
+mechanism then you will have to populate I<ap_auth_type> yourself.
+
+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 *
=back
1.1 modperl-docs/src/docs/2.0/api/Apache/Access.pod
Index: Access.pod
===================================================================
=head1 NAME
Apache::Access -- A Perl API for Apache request object
=head1 SYNOPSIS
use Apache::Access;
sub handler{
my $r = shift;
...
my $auth_type = $r->auth_type;
...
}
=head1 DESCRIPTION
C<Apache::Access> provides the Perl API for Apache request object.
=head1 API
Function arguments (if any) and return values are shown in the
function's synopsis.
=over
=item * auth_type()
C<$r-E<gt>auth_type> gets or sets the value of the I<AuthType>
configuration directive for the current request.
my $auth_type = $r->auth_type;
or
$r->auth_type('Basic');
=item *
=back
=cut
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
