1docs::api::Apache2::ComUmsaenrd(C3o)ntributed Perl Documdeonctsa:t:iaopni::Apache2::Command(3)
2
3
4
6 Apache2::Command - Perl API for accessing Apache module command
7 information
8
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
22 "Apache2::Command" provides the Perl API for accessing Apache module
23 command information
24
26 "Apache2::Command" provides the following functions and/or methods:
27
28 "args_how"
29 What the command expects as arguments:
30
31 $how = $cmd->args_how();
32
33 obj: $cmd ( "Apache2::Command object" )
34 ret: $how ( "Apache2::Const :cmd_how constant" )
35 The flag value representing the type of this command (i.e.
36 "Apache2::Const::ITERATE", "Apache2::Const::TAKE2").
37
38 since: 2.0.00
39
40 "errmsg"
41 Get usage message for that command, in case of syntax errors:
42
43 $error = $cmd->errmsg();
44
45 obj: $cmd ( "Apache2::Command object" )
46 ret: $error ( string )
47 The error message
48
49 since: 2.0.00
50
51 "name"
52 Get the name of this command:
53
54 $name = $cmd->name();
55
56 obj: $cmd ( "Apache2::Command object" )
57 ret: $name ( string )
58 The command name
59
60 since: 2.0.00
61
62 "next"
63 Get the next command in the chain of commands for this module:
64
65 $next = $cmd->next();
66
67 obj: $cmd ( "Apache2::Command object" )
68 ret: $next ( "Apache2::Command object" )
69 Returns the next command in the chain for this module, "undef" for
70 the last command.
71
72 since: 2.0.00
73
74 "req_override"
75 What overrides need to be allowed to enable this command:
76
77 $override = $cmd->req_override
78
79 obj: $cmd ( "Apache2::Command object" )
80 ret: $override ( "Apache2::Const :override constant" )
81 The bit mask representing the overrides this command is allowed in
82 (i.e "Apache2::Const::OR_ALL"/"Apache2::Const::ACCESS_CONF").
83
84 since: 2.0.00
85
86 For example:
87
88 use Apache2::Const -compile => qw(:override);
89 $cmd->req_override() & Apache2::Const::OR_AUTHCFG;
90 $cmd->req_override() & Apache2::Const::OR_LIMIT;
91
93 mod_perl 2.0 documentation.
94
96 mod_perl 2.0 and its core modules are copyrighted under The Apache
97 Software License, Version 2.0.
98
100 The mod_perl development team and numerous contributors.
101
102
103
104perl v5.12.0 2007-11-12 docs::api::Apache2::Command(3)