NAME

Apache::Command - Perl API for accessing Apache module command information

Synopsis

  use Apache::Module ();
  use Apache::Command ();
  my $module = Apache::Module::find_linked_module('mod_perl.c');
  my $cmd = $module->cmds();


  while ($cmd) {
    $cmd->args_how();
    $cmd->errmsg();
    $cmd->req_override();
    $cmd = $cmd->next();
  }

Description

Each Apache module can define a list of configuration commands it offers. This interface gives access to information about these configuration commands. Each module contains a chained-list of Apache::Command objects, each representing a single directive.

For example, PerlRequire is a command offered by mod_perl.

API

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

`args_how`

What the command expects as arguments

  $obj->args_how();

obj: $obj ( Apache::Command object|docs::2.0::api::Apache::Command )
ret: ( integer ): The flag value representing the type of command (i.e. ITERATE/TAKE2)
since: 1.99_12

`errmsg`

'usage' message for that command, in case of syntax errors

  $obj->errmsg();

obj: $obj ( Apache::Command object|docs::2.0::api::Apache::Command )
ret: ( string ): The error message
since: 1.99_12

`name`

Name of this command

  $name      = $obj->name();

obj: $obj ( Apache::Command object|docs::2.0::api::Apache::Command )
ret: ( string ): The command name
since: 1.99_12

`next`

The next command in the chain of commands for this module

  $ret = $cmd->next();

obj: $cmd ( Apache::Command object|docs::2.0::api::Apache::Command )
ret: $ret ( Apache::Command object|docs::2.0::api::Apache::Command )
since: 1.99_12

`req_override`

What overrides need to be allowed to enable this command.

  $obj->req_override

obj: $obj ( Apache::Command object|docs::2.0::api::Apache::Command )
ret: ( integer ): The bit mask representing the overrides this command is allowed in (i.e OR_ALL/ACCESS_CONF)
since: 1.99_12

Copyright

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

Authors

The mod_perl development team and numerous contributors.

Apache::Command - Perl API for accessing Apache module command information