/ 
mod_perl-1.99_13
River stage three • 156 direct dependents • 184 total dependents
/ Apache::Access

NAME

Apache::Access - A Perl API for Apache request object

Synopsis

META: needs to be completed

use Apache::Access ();

Description

Apache::Access provides the Perl API for Apache request object.

API

Apache::Access provides the following functions and/or methods:

allow_options

META: Autogenerated - needs to be reviewed/completed

Retrieve the value of Options for this request

$ret = $r->allow_options();
arg1: $r (Apache::RequestRec)

The current request

ret: $ret (integer)

the Options bitmask

allow_overrides

META: Autogenerated - needs to be reviewed/completed

Retrieve the value of the AllowOverride for this request

$ret = $r->allow_overrides();
arg1: $r (Apache::RequestRec)

The current request

ret: $ret (integer)

the overrides bitmask

get_remote_logname

META: Autogenerated - needs to be reviewed/completed

Retrieve the login name of the remote user. Undef if it could not be determined

$ret = $r->get_remote_logname();
arg1: $r (Apache::RequestRec)

The current request

ret: $ret (string)

The user logged in to the client machine

note_auth_failure

META: Autogenerated - needs to be reviewed/completed

Setup the output headers so that the client knows how to authenticate itself the next time, if an authentication request failed. This function works for both basic and digest authentication

$r->note_auth_failure();
arg1: $r (Apache::RequestRec)

The current request

ret: no return value

note_basic_auth_failure

META: Autogenerated - needs to be reviewed/completed

Setup the output headers so that the client knows how to authenticate itself the next time, if an authentication request failed. This function works only for basic authentication

$r->note_basic_auth_failure();
arg1: $r (Apache::RequestRec)

The current request

ret: no return value

note_digest_auth_failure

META: Autogenerated - needs to be reviewed/completed

Setup the output headers so that the client knows how to authenticate itself the next time, if an authentication request failed. This function works only for digest authentication

$r->note_digest_auth_failure();
arg1: $r (Apache::RequestRec)

The current request

ret: no return value

satisfies

META: Autogenerated - needs to be reviewed/completed

How the requires lines must be met.

$ret = $r->satisfies();
arg1: $r (Apache::RequestRec)

The current request

ret: $ret (integer)

How the requirements must be met. One of:

Apache::SATISFY_ANY    -- any of the requirements must be met.
Apache::SATISFY_ALL    -- all of the requirements must be met.
Apache::SATISFY_NOSPEC -- There are no applicable satisfy lines

some_auth_required

META: Autogenerated - needs to be reviewed/completed

Can be used within any handler to determine if any authentication is required for the current request

$ret = $r->some_auth_required();
arg1: $r (Apache::RequestRec)

The current request

ret: $ret (integer)

1 if authentication is required, 0 otherwise

See Also

mod_perl 2.0 documentation.

Copyright

mod_perl 2.0 and its core modules are copyrighted under The Apache Software License, Version 1.1.

Authors

The mod_perl development team and numerous contributors.