1. Manuals
  2. Tumbleweed
  3. apache2-mod_perl
  4. Apache2::Command(3pm)

Scroll to navigation

docs::api::Apache2::Command(3) User Contributed Perl Documentation docs::api::Apache2::Command(3)

NAME

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

Synopsis

  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();
  }

Description

"Apache2::Command" provides the Perl API for accessing Apache module command information

API

"Apache2::Command" provides the following functions and/or methods:

"args_how"

What the command expects as arguments:

  $how = $cmd->args_how();
The flag value representing the type of this command (i.e. "Apache2::Const::ITERATE", "Apache2::Const::TAKE2").

"errmsg"

Get usage message for that command, in case of syntax errors:

  $error = $cmd->errmsg();
The error message

"name"

Get the name of this command:

  $name = $cmd->name();
The command name

"next"

Get the next command in the chain of commands for this module:

  $next = $cmd->next();
Returns the next command in the chain for this module, "undef" for the last command.

"req_override"

What overrides need to be allowed to enable this command:

  $override = $cmd->req_override
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;

See Also

mod_perl 2.0 documentation.

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.

2024-09-27 perl v5.40.0