| mod_perl documentation | view source | Contained in the mod_perl distribution. |
Apache2::Command - Perl API for accessing Apache module command information
use Apache2::Module ();
use Apache2::Command ();
my $module = Apache2::Module::find_linked_module('mod_perl.c');
for (my $cmd = $module->cmds; $cmd; $cmd = $cmd->next) {
$cmd->args_how();
$cmd->errmsg();
$cmd->name();
$cmd->req_override();
}
Apache2::Command provides the Perl API for accessing Apache module
command information
Apache2::Command provides the following functions and/or methods:
args_howWhat the command expects as arguments:
$how = $cmd->args_how();
$cmd
( Apache2::Command object (docs::2.0::api::Apache2::Command) )$how ( Apache2::Const :cmd_how constant (C__cmd_how_ in docs::2.0::api::Apache2::Const) )The flag value representing the type of this command
(i.e. Apache2::Const::ITERATE, Apache2::Const::TAKE2).
errmsgGet usage message for that command, in case of syntax errors:
$error = $cmd->errmsg();
$cmd
( Apache2::Command object (docs::2.0::api::Apache2::Command) )$error ( string )The error message
nameGet the name of this command:
$name = $cmd->name();
$cmd
( Apache2::Command object (docs::2.0::api::Apache2::Command) )$name ( string )The command name
nextGet the next command in the chain of commands for this module:
$next = $cmd->next();
$cmd
( Apache2::Command object (docs::2.0::api::Apache2::Command) )$next
( Apache2::Command object (docs::2.0::api::Apache2::Command) )Returns the next command in the chain for this module, undef for
the last command.
req_overrideWhat overrides need to be allowed to enable this command:
$override = $cmd->req_override
$cmd
( Apache2::Command object (docs::2.0::api::Apache2::Command) )$override ( Apache2::Const :override constant (C__override_ in docs::2.0::api::Apache2::Const) )The bit mask representing the overrides this command is allowed in
(i.e Apache2::Const::OR_ALL/Apache2::Const::ACCESS_CONF).
For example:
use Apache2::Const -compile => qw(:override); $cmd->req_override() & Apache2::Const::OR_AUTHCFG; $cmd->req_override() & Apache2::Const::OR_LIMIT;
mod_perl 2.0 documentation (docs::2.0::index).
mod_perl 2.0 and its core modules are copyrighted under The Apache Software License, Version 2.0.
The mod_perl development team and numerous contributors (about::contributors::people).
| mod_perl documentation | view source | Contained in the mod_perl distribution. |