.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "docs::api::Apache2::Command 3pm"
.TH docs::api::Apache2::Command 3pm 2024-01-10 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Apache2::Command \- Perl API for accessing Apache module command information
.SH Synopsis
.IX Header "Synopsis"
.Vb 3
\&  use Apache2::Module ();
\&  use Apache2::Command ();
\&  my $module = Apache2::Module::find_linked_module(\*(Aqmod_perl.c\*(Aq);
\&  
\&  for (my $cmd = $module\->cmds; $cmd; $cmd = $cmd\->next) {
\&      $cmd\->args_how();
\&      $cmd\->errmsg();
\&      $cmd\->name();
\&      $cmd\->req_override();
\&  }
.Ve
.SH Description
.IX Header "Description"
\&\f(CW\*(C`Apache2::Command\*(C'\fR provides the Perl API for accessing Apache module
command information
.SH API
.IX Header "API"
\&\f(CW\*(C`Apache2::Command\*(C'\fR provides the following functions and/or methods:
.ie n .SS """args_how"""
.el .SS \f(CWargs_how\fP
.IX Subsection "args_how"
What the command expects as arguments:
.PP
.Vb 1
\&  $how = $cmd\->args_how();
.Ve
.ie n .IP "obj: $cmd ( ""Apache2::Command object"" )" 4
.el .IP "obj: \f(CW$cmd\fR ( \f(CWApache2::Command object\fR )" 4
.IX Item "obj: $cmd ( Apache2::Command object )"
.PD 0
.ie n .IP "ret: $how ( ""Apache2::Const :cmd_how constant"" )" 4
.el .IP "ret: \f(CW$how\fR ( \f(CWApache2::Const :cmd_how constant\fR )" 4
.IX Item "ret: $how ( Apache2::Const :cmd_how constant )"
.PD
The flag value representing the type of this command
(i.e. \f(CW\*(C`Apache2::Const::ITERATE\*(C'\fR, \f(CW\*(C`Apache2::Const::TAKE2\*(C'\fR).
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.ie n .SS """errmsg"""
.el .SS \f(CWerrmsg\fP
.IX Subsection "errmsg"
Get \fIusage\fR message for that command, in case of syntax errors:
.PP
.Vb 1
\&  $error = $cmd\->errmsg();
.Ve
.ie n .IP "obj: $cmd ( ""Apache2::Command object"" )" 4
.el .IP "obj: \f(CW$cmd\fR ( \f(CWApache2::Command object\fR )" 4
.IX Item "obj: $cmd ( Apache2::Command object )"
.PD 0
.ie n .IP "ret: $error ( string )" 4
.el .IP "ret: \f(CW$error\fR ( string )" 4
.IX Item "ret: $error ( string )"
.PD
The error message
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.ie n .SS """name"""
.el .SS \f(CWname\fP
.IX Subsection "name"
Get the name of this command:
.PP
.Vb 1
\&  $name = $cmd\->name();
.Ve
.ie n .IP "obj: $cmd ( ""Apache2::Command object"" )" 4
.el .IP "obj: \f(CW$cmd\fR ( \f(CWApache2::Command object\fR )" 4
.IX Item "obj: $cmd ( Apache2::Command object )"
.PD 0
.ie n .IP "ret: $name ( string )" 4
.el .IP "ret: \f(CW$name\fR ( string )" 4
.IX Item "ret: $name ( string )"
.PD
The command name
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.ie n .SS """next"""
.el .SS \f(CWnext\fP
.IX Subsection "next"
Get the next command in the chain of commands for this module:
.PP
.Vb 1
\&  $next = $cmd\->next();
.Ve
.ie n .IP "obj: $cmd ( ""Apache2::Command object"" )" 4
.el .IP "obj: \f(CW$cmd\fR ( \f(CWApache2::Command object\fR )" 4
.IX Item "obj: $cmd ( Apache2::Command object )"
.PD 0
.ie n .IP "ret: $next ( ""Apache2::Command object"" )" 4
.el .IP "ret: \f(CW$next\fR ( \f(CWApache2::Command object\fR )" 4
.IX Item "ret: $next ( Apache2::Command object )"
.PD
Returns the next command in the chain for this module, \f(CW\*(C`undef\*(C'\fR for
the last command.
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.ie n .SS """req_override"""
.el .SS \f(CWreq_override\fP
.IX Subsection "req_override"
What overrides need to be allowed to enable this command:
.PP
.Vb 1
\&  $override = $cmd\->req_override
.Ve
.ie n .IP "obj: $cmd ( ""Apache2::Command object"" )" 4
.el .IP "obj: \f(CW$cmd\fR ( \f(CWApache2::Command object\fR )" 4
.IX Item "obj: $cmd ( Apache2::Command object )"
.PD 0
.ie n .IP "ret: $override ( ""Apache2::Const :override constant"" )" 4
.el .IP "ret: \f(CW$override\fR ( \f(CWApache2::Const :override constant\fR )" 4
.IX Item "ret: $override ( Apache2::Const :override constant )"
.PD
The bit mask representing the overrides this command is allowed in
(i.e \f(CW\*(C`Apache2::Const::OR_ALL\*(C'\fR/\f(CW\*(C`Apache2::Const::ACCESS_CONF\*(C'\fR).
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.PP
For example:
.PP
.Vb 3
\&  use Apache2::Const \-compile => qw(:override);
\&  $cmd\->req_override() & Apache2::Const::OR_AUTHCFG;
\&  $cmd\->req_override() & Apache2::Const::OR_LIMIT;
.Ve
.SH "See Also"
.IX Header "See Also"
mod_perl 2.0 documentation.
.SH Copyright
.IX Header "Copyright"
mod_perl 2.0 and its core modules are copyrighted under
The Apache Software License, Version 2.0.
.SH Authors
.IX Header "Authors"
The mod_perl development team and numerous
contributors.