3
Apache::Access -- A Perl API for Apache request object
11
my $auth_type = $r->auth_type;
3
Apache::Access - A Perl API for Apache request object
10
META: needs to be completed
12
use Apache::Access ();
17
18
C<Apache::Access> provides the Perl API for Apache request object.
21
Function arguments (if any) and return values are shown in the
28
C<$r-E<gt>auth_type> gets or sets the value of the I<AuthType>
29
configuration directive for the current request.
31
my $auth_type = $r->auth_type;
35
$r->auth_type('Basic');
25
C<Apache::Access> provides the following functions and/or methods:
30
=head2 C<allow_options>
32
META: Autogenerated - needs to be reviewed/completed
34
Retrieve the value of Options for this request
36
$ret = $r->allow_options();
40
=item obj: C<$r> (C<L<Apache::RequestRec|docs::2.0::api::Apache::RequestRec>>)
44
=item ret: C<$ret> (integer)
54
=head2 C<allow_overrides>
56
META: Autogenerated - needs to be reviewed/completed
58
Retrieve the value of the AllowOverride for this request
60
$ret = $r->allow_overrides();
64
=item obj: C<$r> (C<L<Apache::RequestRec|docs::2.0::api::Apache::RequestRec>>)
68
=item ret: C<$ret> (integer)
78
=head2 C<get_remote_logname>
80
META: Autogenerated - needs to be reviewed/completed
82
Retrieve the login name of the remote user. Undef if it could not be
85
$ret = $r->get_remote_logname();
89
=item obj: C<$r> (C<L<Apache::RequestRec|docs::2.0::api::Apache::RequestRec>>)
93
=item ret: C<$ret> (string)
95
The user logged in to the client machine
103
=head2 C<note_auth_failure>
105
META: Autogenerated - needs to be reviewed/completed
107
Setup the output headers so that the client knows how to authenticate
108
itself the next time, if an authentication request failed. This function
109
works for both basic and digest authentication
111
$r->note_auth_failure();
115
=item obj: C<$r> (C<L<Apache::RequestRec|docs::2.0::api::Apache::RequestRec>>)
119
=item ret: no return value
127
=head2 C<note_basic_auth_failure>
129
META: Autogenerated - needs to be reviewed/completed
131
Setup the output headers so that the client knows how to authenticate
132
itself the next time, if an authentication request failed. This function
133
works only for basic authentication
135
$r->note_basic_auth_failure();
139
=item obj: C<$r> (C<L<Apache::RequestRec|docs::2.0::api::Apache::RequestRec>>)
143
=item ret: no return value
151
=head2 C<note_digest_auth_failure>
153
META: Autogenerated - needs to be reviewed/completed
155
Setup the output headers so that the client knows how to authenticate
156
itself the next time, if an authentication request failed. This function
157
works only for digest authentication
159
$r->note_digest_auth_failure();
163
=item obj: C<$r> (C<L<Apache::RequestRec|docs::2.0::api::Apache::RequestRec>>)
167
=item ret: no return value
177
META: Autogenerated - needs to be reviewed/completed
179
How the requires lines must be met.
181
$ret = $r->satisfies();
185
=item obj: C<$r> (C<L<Apache::RequestRec|docs::2.0::api::Apache::RequestRec>>)
189
=item ret: C<$ret> (integer)
191
How the requirements must be met. One of:
193
Apache::SATISFY_ANY -- any of the requirements must be met.
194
Apache::SATISFY_ALL -- all of the requirements must be met.
195
Apache::SATISFY_NOSPEC -- There are no applicable satisfy lines
203
=head2 C<some_auth_required>
205
META: Autogenerated - needs to be reviewed/completed
207
Can be used within any handler to determine if any authentication
208
is required for the current request
210
$ret = $r->some_auth_required();
214
=item obj: C<$r> (C<L<Apache::RequestRec|docs::2.0::api::Apache::RequestRec>>)
218
=item ret: C<$ret> (integer)
220
1 if authentication is required, 0 otherwise
229
L<mod_perl 2.0 documentation|docs::2.0::index>.
236
mod_perl 2.0 and its core modules are copyrighted under
237
The Apache Software License, Version 1.1.
244
L<The mod_perl development team and numerous
245
contributors|about::contributors::people>.
added
removed
docs/api/Apache/Access.pod
