1docs::api::Apache2::ComUmsaenrd(C3o)ntributed Perl Documdeonctsa:t:iaopni::Apache2::Command(3)
2
3
4

NAME

6       Apache2::Command - Perl API for accessing Apache module command infor‐
7       mation
8

Synopsis

10         use Apache2::Module ();
11         use Apache2::Command ();
12         my $module = Apache2::Module::find_linked_module('mod_perl.c');
13
14         for (my $cmd = $module->cmds; $cmd; $cmd = $cmd->next) {
15             $cmd->args_how();
16             $cmd->errmsg();
17             $cmd->name();
18             $cmd->req_override();
19         }
20

Description

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

API

26       "Apache2::Command" provides the following functions and/or methods:
27
28       "args_how"
29
30       What the command expects as arguments:
31
32         $how = $cmd->args_how();
33
34       obj: $cmd ( "Apache2::Command object" )
35       ret: $how ( "Apache2::Const :cmd_how constant" )
36           The flag value representing the type of this command (i.e.
37           "Apache2::Const::ITERATE", "Apache2::Const::TAKE2").
38
39       since: 2.0.00
40
41       "errmsg"
42
43       Get usage message for that command, in case of syntax errors:
44
45         $error = $cmd->errmsg();
46
47       obj: $cmd ( "Apache2::Command object" )
48       ret: $error ( string )
49           The error message
50
51       since: 2.0.00
52
53       "name"
54
55       Get the name of this command:
56
57         $name = $cmd->name();
58
59       obj: $cmd ( "Apache2::Command object" )
60       ret: $name ( string )
61           The command name
62
63       since: 2.0.00
64
65       "next"
66
67       Get the next command in the chain of commands for this module:
68
69         $next = $cmd->next();
70
71       obj: $cmd ( "Apache2::Command object" )
72       ret: $next ( "Apache2::Command object" )
73           Returns the next command in the chain for this module, "undef" for
74           the last command.
75
76       since: 2.0.00
77
78       "req_override"
79
80       What overrides need to be allowed to enable this command:
81
82         $override = $cmd->req_override
83
84       obj: $cmd ( "Apache2::Command object" )
85       ret: $override ( "Apache2::Const :override constant" )
86           The bit mask representing the overrides this command is allowed in
87           (i.e "Apache2::Const::OR_ALL"/"Apache2::Const::ACCESS_CONF").
88
89       since: 2.0.00
90
91       For example:
92
93         use Apache2::Const -compile => qw(:override);
94         $cmd->req_override() & Apache2::Const::OR_AUTHCFG;
95         $cmd->req_override() & Apache2::Const::OR_LIMIT;
96

See Also

98       mod_perl 2.0 documentation.
99

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

Authors

105       The mod_perl development team and numerous contributors.
106
107
108
109perl v5.8.8                       2006-11-19    docs::api::Apache2::Command(3)
Impressum