cvs commit: modperl-docs/src/docs/2.0/api/Apache CmdParms.pod
stas2004/09/13 15:17:03 Modified:src/docs/2.0/api/Apache CmdParms.pod Log: spel Revision ChangesPath 1.17 +3 -2 modperl-docs/src/docs/2.0/api/Apache/CmdParms.pod Index: CmdParms.pod === RCS file: /home/cvs/modperl-docs/src/docs/2.0/api/Apache/CmdParms.pod,v retrieving revision 1.16 retrieving revision 1.17 diff -u -u -r1.16 -r1.17 --- CmdParms.pod 13 Sep 2004 21:42:52 - 1.16 +++ CmdParms.pod 13 Sep 2004 22:17:03 - 1.17 @@ -231,8 +231,9 @@ my $info = $parms->info; } -In this example C<$info> will either be 'One' or 'Two' depending on -wether the directive was called as I or I +In this example C<$info> will either be C<'One'> or C<'Two'> depending +on whether the directive was called as I or +I. - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
cvs commit: modperl-docs/src/docs/2.0/api/Apache CmdParms.pod
gozer 2004/09/13 14:42:52 Modified:src/docs/2.0/api/Apache CmdParms.pod Log: Rewrite an unclear sentence Revision ChangesPath 1.16 +1 -1 modperl-docs/src/docs/2.0/api/Apache/CmdParms.pod Index: CmdParms.pod === RCS file: /home/cvs/modperl-docs/src/docs/2.0/api/Apache/CmdParms.pod,v retrieving revision 1.15 retrieving revision 1.16 diff -u -r1.15 -r1.16 --- CmdParms.pod 13 Sep 2004 21:38:23 - 1.15 +++ CmdParms.pod 13 Sep 2004 21:42:52 - 1.16 @@ -368,7 +368,7 @@ =head2 C -The server this command is appearing in +The (vhost) server this command was defined in F $s = $parms->server; - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
cvs commit: modperl-docs/src/docs/2.0/api/Apache CmdParms.pod
gozer 2004/09/13 14:38:23
Modified:src/docs/2.0/api/Apache CmdParms.pod
Log:
Add an example usage of $parms->info
Revision ChangesPath
1.15 +22 -0 modperl-docs/src/docs/2.0/api/Apache/CmdParms.pod
Index: CmdParms.pod
===
RCS file: /home/cvs/modperl-docs/src/docs/2.0/api/Apache/CmdParms.pod,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- CmdParms.pod 13 Sep 2004 21:18:56 - 1.14
+++ CmdParms.pod 13 Sep 2004 21:38:23 - 1.15
@@ -210,7 +210,29 @@
=back
+For example here is how to pass arbitrary information to a directive
+subroutine:
+ our @APACHE_MODULE_COMMANDS = (
+{
+ name => 'MyDirective1',
+ func => \&MyDirective,
+ cmd_data => 'One',
+},
+{
+ name => 'MyDirective2',
+ func => \&MyDirective,
+ cmd_data => 'Two',
+},
+ );
+
+ sub MyDirective {
+my($self, $parms, $args) = @_;
+my $info = $parms->info;
+ }
+
+In this example C<$info> will either be 'One' or 'Two' depending on
+wether the directive was called as I or I
-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
cvs commit: modperl-docs/src/docs/2.0/api/Apache CmdParms.pod
gozer 2004/09/13 14:18:56
Modified:src/docs/2.0/api/Apache CmdParms.pod
Log:
add a sample @APACHE_MODULE_COMMANDS to better illustrate info
Revision ChangesPath
1.14 +7 -0 modperl-docs/src/docs/2.0/api/Apache/CmdParms.pod
Index: CmdParms.pod
===
RCS file: /home/cvs/modperl-docs/src/docs/2.0/api/Apache/CmdParms.pod,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- CmdParms.pod 13 Sep 2004 21:07:09 - 1.13
+++ CmdParms.pod 13 Sep 2004 21:18:56 - 1.14
@@ -10,6 +10,13 @@
use Apache::CmdParms ();
use Apache::Const -compile => qw(NOT_IN_LOCATION);
+ our @APACHE_MODULE_COMMANDS = (
+{
+ name => 'MyDirective',
+ cmd_data => 'some extra data',
+},
+ );
+
sub MyDirective {
my($self, $parms, $args) = @_;
-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
cvs commit: modperl-docs/src/docs/2.0/api/Apache CmdParms.pod
stas2004/09/13 14:07:10 Modified:src/docs/2.0/api/Apache CmdParms.pod Log: better call temp pool, temp_pool :) Revision ChangesPath 1.13 +7 -3 modperl-docs/src/docs/2.0/api/Apache/CmdParms.pod Index: CmdParms.pod === RCS file: /home/cvs/modperl-docs/src/docs/2.0/api/Apache/CmdParms.pod,v retrieving revision 1.12 retrieving revision 1.13 diff -u -u -r1.12 -r1.13 --- CmdParms.pod 13 Sep 2004 21:02:00 - 1.12 +++ CmdParms.pod 13 Sep 2004 21:07:09 - 1.13 @@ -300,7 +300,7 @@ =back -For example for a container definition: +For example for a container block: ... @@ -310,6 +310,10 @@ + + + + =head2 C Pool associated with this command @@ -361,14 +365,14 @@ Pool for scratch memory; persists during configuration, but destroyed before the first request is served. - $p = $parms->temp_pool; + $temp_pool = $parms->temp_pool; =over 4 =item obj: C<$parms> ( C> ) -=item ret: C<$p> +=item ret: C<$temp_pool> ( C> ) =item since: 1.99_12 - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
cvs commit: modperl-docs/src/docs/2.0/api/Apache CmdParms.pod
stas2004/09/13 14:02:00
Modified:src/docs/2.0/api/Apache CmdParms.pod
Log:
minor tweaks
Revision ChangesPath
1.12 +12 -8 modperl-docs/src/docs/2.0/api/Apache/CmdParms.pod
Index: CmdParms.pod
===
RCS file: /home/cvs/modperl-docs/src/docs/2.0/api/Apache/CmdParms.pod,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -u -r1.11 -r1.12
--- CmdParms.pod 13 Sep 2004 20:43:33 - 1.11
+++ CmdParms.pod 13 Sep 2004 21:02:00 - 1.12
@@ -125,7 +125,7 @@
=back
For example here is how to check whether a command is allowed in the
-ELocationE container:
+CLocationE> container:
use Apache::Const -compile qw(NOT_IN_LOCATION);
if (my $error = $parms->check_cmd_context(Apache::NOT_IN_LOCATION)) {
@@ -169,7 +169,7 @@
=item obj: C<$parms>
( C> )
-=item ret: C<$newval>
+=item ret: C<$directive>
( C> )
The current directive node in the configuration tree
@@ -185,8 +185,8 @@
=head2 C
-The extra information passed thru C in
-C>
+The extra information passed through C in
+C>.
$info = $parms->info;
@@ -229,8 +229,8 @@
=back
-For example, to check if the C method is being ELimitEed
-in the current scope, do:
+For example, to check if the C method is being
+CLimitE>ed in the current scope, do:
if ($parms->method_is_limited('GET') {
die "...";
@@ -290,7 +290,7 @@
=item obj: C<$parms>
( C> )
-=item ret: C<$path> ( string / undef )
+=item ret: C<$path> ( string / C )
If configuring for a block like ELocationE,
ELocationMatchE, EDirectoryE, etc., the pathname part
@@ -300,9 +300,13 @@
=back
+For example for a container definition:
+
+ ...
+
-
+I<'/foo'> will be returned.
-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
cvs commit: modperl-docs/src/docs/2.0/api/Apache CmdParms.pod
stas2004/09/13 13:43:33
Modified:src/docs/2.0/api/Apache CmdParms.pod
Log:
fix order
Revision ChangesPath
1.11 +30 -29modperl-docs/src/docs/2.0/api/Apache/CmdParms.pod
Index: CmdParms.pod
===
RCS file: /home/cvs/modperl-docs/src/docs/2.0/api/Apache/CmdParms.pod,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -u -r1.10 -r1.11
--- CmdParms.pod 9 Sep 2004 22:39:13 - 1.10
+++ CmdParms.pod 13 Sep 2004 20:43:33 - 1.11
@@ -12,38 +12,38 @@
sub MyDirective {
my($self, $parms, $args) = @_;
-
+
# push config
$parms->add_config(['ServerTokens off']);
-
+
# this command's command object
$cmd = $parms->cmd;
-
+
# check the current command's context
$error = $parms->check_cmd_context(Apache::NOT_IN_LOCATION);
-
+
# this command's context
$context = $parms->context;
-
+
# this command's directive object
$directive = $parms->directive;
-
+
# the extra information passed thru cmd_data in
# @APACHE_MODULE_COMMANDS
$info = $parms->info;
-
+
# which methods are ed ?
$is_limited = $parms->method_is_limited('GET');
-
+
# which allow-override bits are set
$override = $parms->override;
-
+
# the path this command is being invoked in
$path = $parms->path;
-
+
# this command's pool
$p = $parms->pool;
-
+
# this command's configuration time pool
$p = $parms->temp_pool;
}
@@ -94,24 +94,6 @@
Cadd_config|docs::2.0::api::Apache::ServerUtil/C_add_config_>>,
Cadd_config|docs::2.0::api::Apache::RequestUtil/C_add_config_>>
-=head2 C
-
-This module's command information
-
- $cmd = $parms->cmd();
-
-=over 4
-
-=item obj: C<$parms>
-( C> )
-
-=item ret: C<$cmd>
-( C> )
-
-=item since: 1.99_17
-
-=back
-
@@ -151,6 +133,25 @@
}
+
+
+=head2 C
+
+This module's command information
+
+ $cmd = $parms->cmd();
+
+=over 4
+
+=item obj: C<$parms>
+( C> )
+
+=item ret: C<$cmd>
+( C> )
+
+=item since: 1.99_17
+
+=back
-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
cvs commit: modperl-docs/src/docs/2.0/api/Apache CmdParms.pod
gozer 2004/09/09 15:39:13
Modified:src/docs/2.0/api/Apache CmdParms.pod
Log:
Added Apache::CmdParms::add_config() to work around a memory
leak discovered with sections in .htaccess files
Revision ChangesPath
1.10 +30 -1 modperl-docs/src/docs/2.0/api/Apache/CmdParms.pod
Index: CmdParms.pod
===
RCS file: /home/cvs/modperl-docs/src/docs/2.0/api/Apache/CmdParms.pod,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- CmdParms.pod 17 Aug 2004 23:40:57 - 1.9
+++ CmdParms.pod 9 Sep 2004 22:39:13 - 1.10
@@ -13,6 +13,9 @@
sub MyDirective {
my($self, $parms, $args) = @_;
+ # push config
+ $parms->add_config(['ServerTokens off']);
+
# this command's command object
$cmd = $parms->cmd;
@@ -65,6 +68,32 @@
+=head2 C
+
+Dynamically add Apache configuration at request processing runtime:
+
+ $parms->add_config($lines);
+
+=over 4
+
+=item obj: C<$parms>
+( C> )
+
+=item arg1: C<$lines> (ARRAY ref)
+
+An ARRAY reference containing configuration lines per element, without
+the new line terminators.
+
+=item ret: no return value
+
+=item since: 1.99_17
+
+=back
+
+See also:
+Cadd_config|docs::2.0::api::Apache::ServerUtil/C_add_config_>>,
+Cadd_config|docs::2.0::api::Apache::RequestUtil/C_add_config_>>
+
=head2 C
This module's command information
@@ -79,7 +108,7 @@
=item ret: C<$cmd>
( C> )
-=item since: 1.99_12
+=item since: 1.99_17
=back
-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
cvs commit: modperl-docs/src/docs/2.0/api/Apache CmdParms.pod
gozer 2004/08/17 16:40:57
Modified:src/docs/2.0/api/Apache CmdParms.pod
Log:
Apache::CmdParms->limited member replaced by is_method_limited()
method
Revision ChangesPath
1.9 +16 -11modperl-docs/src/docs/2.0/api/Apache/CmdParms.pod
Index: CmdParms.pod
===
RCS file: /home/cvs/modperl-docs/src/docs/2.0/api/Apache/CmdParms.pod,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- CmdParms.pod 14 Aug 2004 04:15:25 - 1.8
+++ CmdParms.pod 17 Aug 2004 23:40:57 - 1.9
@@ -30,7 +30,7 @@
$info = $parms->info;
# which methods are ed ?
- $limit = $parms->limited;
+ $is_limited = $parms->method_is_limited('GET');
# which allow-override bits are set
$override = $parms->override;
@@ -178,28 +178,33 @@
-=head2 C
+=head2 C
-Which methods are currently ELimitEed
+Discover if a method is ELimitEed in the current scope
- $limit = $parms->limited;
+ $is_limited = $parms->method_is_limited($method);
=over 4
=item obj: C<$parms>
( C> )
-=item ret: C<$limit> ( integer )
+=item arg1: C<$method> (string)
-=item since: 1.99_12
+The name of the method to check for
+
+=item ret: C<$is_limited> ( boolean )
+
+=item since: 1.99_15
=back
- META: and how exactly is it supposed to be used, should this be
- tested against $r->method_number (e.g. Apache::M_POST) ? what's
- $limit? (notice that the test of this method isn't so good, it
- tests some hardcoded -1 value, how do you know that it does what you
- think it does?)
+For example, to check if the C method is being ELimitEed
+in the current scope, do:
+
+ if ($parms->method_is_limited('GET') {
+ die "...";
+ }
-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
Re: cvs commit: modperl-docs/src/docs/2.0/api/Apache CmdParms.pod Command.pod
Stas Bekman wrote: [EMAIL PROTECTED] wrote: gozer 2004/08/12 22:45:50 Modified:src/docs/2.0/api/Apache CmdParms.pod Command.pod Log: Apache::CmdParms is completed. Awaiting review by Stas please... I've committed some tweaks, including a missing argument check_cmd_context and some examples without which users won't know what to do with the methods. But please review my examples/notes. Thanks for looking over this stuff. there is one more things to do is to complete the entry: =head2 C the META tag in the body. Ack! -- Philippe M. Chiasson m/gozer\@(apache|cpan|ectoplasm)\.org/ GPG KeyID : 88C3A5A5 http://gozer.ectoplasm.org/ F9BF E0C2 480E 7680 1AE5 3631 CB32 A107 88C3A5A5 signature.asc Description: OpenPGP digital signature
cvs commit: modperl-docs/src/docs/2.0/api/Apache CmdParms.pod Const.pod
gozer 2004/08/13 21:15:25 Modified:src/docs/2.0/api/Apache CmdParms.pod Const.pod Log: Small version number confusion. 99.15 is the upcoming release, not 99.16. Revision ChangesPath 1.8 +1 -1 modperl-docs/src/docs/2.0/api/Apache/CmdParms.pod Index: CmdParms.pod === RCS file: /home/cvs/modperl-docs/src/docs/2.0/api/Apache/CmdParms.pod,v retrieving revision 1.7 retrieving revision 1.8 diff -u -r1.7 -r1.8 --- CmdParms.pod 13 Aug 2004 19:45:33 - 1.7 +++ CmdParms.pod 14 Aug 2004 04:15:25 - 1.8 @@ -109,7 +109,7 @@ of why it was forbidden. If the context is permitted, this method returns C. -=item since: 1.99_16 +=item since: 1.99_15 =back 1.19 +7 -7 modperl-docs/src/docs/2.0/api/Apache/Const.pod Index: Const.pod === RCS file: /home/cvs/modperl-docs/src/docs/2.0/api/Apache/Const.pod,v retrieving revision 1.18 retrieving revision 1.19 diff -u -r1.18 -r1.19 --- Const.pod 13 Aug 2004 04:13:32 - 1.18 +++ Const.pod 14 Aug 2004 04:15:25 - 1.19 @@ -432,7 +432,7 @@ =over -=item since: 1.99_16 +=item since: 1.99_15 =back @@ -444,7 +444,7 @@ =over -=item since: 1.99_16 +=item since: 1.99_15 =back @@ -459,7 +459,7 @@ =over -=item since: 1.99_16 +=item since: 1.99_15 =back @@ -474,7 +474,7 @@ =over -=item since: 1.99_16 +=item since: 1.99_15 =back @@ -489,7 +489,7 @@ =over -=item since: 1.99_16 +=item since: 1.99_15 =back @@ -507,7 +507,7 @@ =over -=item since: 1.99_16 +=item since: 1.99_15 =back @@ -522,7 +522,7 @@ =over -=item since: 1.99_16 +=item since: 1.99_15 =back - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: cvs commit: modperl-docs/src/docs/2.0/api/Apache CmdParms.pod Command.pod
[EMAIL PROTECTED] wrote: gozer 2004/08/12 22:45:50 Modified:src/docs/2.0/api/Apache CmdParms.pod Command.pod Log: Apache::CmdParms is completed. Awaiting review by Stas please... I've committed some tweaks, including a missing argument check_cmd_context and some examples without which users won't know what to do with the methods. But please review my examples/notes. there is one more things to do is to complete the entry: =head2 C the META tag in the body. -- __ Stas BekmanJAm_pH --> Just Another mod_perl Hacker http://stason.org/ mod_perl Guide ---> http://perl.apache.org mailto:[EMAIL PROTECTED] http://use.perl.org http://apacheweek.com http://modperlbook.org http://apache.org http://ticketmaster.com - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
cvs commit: modperl-docs/src/docs/2.0/api/Apache CmdParms.pod
stas2004/08/13 12:45:33
Modified:src/docs/2.0/api/Apache CmdParms.pod
Log:
polish
Revision ChangesPath
1.7 +112 -58 modperl-docs/src/docs/2.0/api/Apache/CmdParms.pod
Index: CmdParms.pod
===
RCS file: /home/cvs/modperl-docs/src/docs/2.0/api/Apache/CmdParms.pod,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -u -r1.6 -r1.7
--- CmdParms.pod 13 Aug 2004 05:45:49 - 1.6
+++ CmdParms.pod 13 Aug 2004 19:45:33 - 1.7
@@ -11,37 +11,38 @@
use Apache::Const -compile => qw(NOT_IN_LOCATION);
sub MyDirective {
-my ($self, $parms, $args) = @_;
-
-# this command's command object
-$cmd = $parms->cmd;
-
-# check the current command's context
-$error = $parms->check_cmd_context(Apache::NOT_IN_LOCATION);
-
-# this command's context
-$context = $parms->context;
-
-# this command's directive object
-$directive = $parms->directive;
-
-# the extra information passed thru cmd_data in @APACHE_MODULE_COMMANDS
-$info = $parms->info;
-
-# which methods are ed ?
-$limit = $parms->limited;
-
-# which allow-override bits are set
-$override = $parms->override;
-
-# the path this command is being invoked in
-$path = $parms->path;
-
-# this command's pool
-$p = $parms->pool;
-
-# this command's configuration time pool
-$p = $parms->temp_pool;
+ my($self, $parms, $args) = @_;
+
+ # this command's command object
+ $cmd = $parms->cmd;
+
+ # check the current command's context
+ $error = $parms->check_cmd_context(Apache::NOT_IN_LOCATION);
+
+ # this command's context
+ $context = $parms->context;
+
+ # this command's directive object
+ $directive = $parms->directive;
+
+ # the extra information passed thru cmd_data in
+ # @APACHE_MODULE_COMMANDS
+ $info = $parms->info;
+
+ # which methods are ed ?
+ $limit = $parms->limited;
+
+ # which allow-override bits are set
+ $override = $parms->override;
+
+ # the path this command is being invoked in
+ $path = $parms->path;
+
+ # this command's pool
+ $p = $parms->pool;
+
+ # this command's configuration time pool
+ $p = $parms->temp_pool;
}
@@ -72,7 +73,7 @@
=over 4
-=item parms: C<$parms>
+=item obj: C<$parms>
( C> )
=item ret: C<$cmd>
@@ -90,14 +91,19 @@
Check the current command against a context bitmask of forbidden contexts.
- $error = $parms->check_cmd_context(Apache::NOT_IN_LOCATION);
+ $error = $parms->check_cmd_context($check);
=over 4
-=item parms: C<$parms>
+=item obj: C<$parms>
( C> )
-=item ret: C<$error>
+=item arg1: C<$check> ( C> )
+
+the context to check against.
+
+=item ret: C<$error> ( string / undef )
If the context is forbidden, this method returns a textual description
of why it was forbidden. If the context is permitted, this method returns
@@ -107,6 +113,19 @@
=back
+For example here is how to check whether a command is allowed in the
+ELocationE container:
+
+ use Apache::Const -compile qw(NOT_IN_LOCATION);
+ if (my $error = $parms->check_cmd_context(Apache::NOT_IN_LOCATION)) {
+ die "directive ... not allowed in context"
+ }
+
+
+
+
+
+
=head2 C
@@ -117,7 +136,7 @@
=over 4
-=item parms: C<$parms>
+=item obj: C<$parms>
( C> )
=item ret: C<$newval>
@@ -136,17 +155,17 @@
=head2 C
-The extra information passed thru C in
+The extra information passed thru C in
C>
$info = $parms->info;
=over 4
-=item parms: C<$parms>
+=item obj: C<$parms>
( C> )
-=item ret: C<$info> (string)
+=item ret: C<$info> ( string )
The string passed in C
@@ -167,36 +186,60 @@
=over 4
-=item parms: C<$parms>
+=item obj: C<$parms>
( C> )
-=item ret: C<$limit> (integer)
+=item ret: C<$limit> ( integer )
=item since: 1.99_12
=back
+ META: and how exactly is it supposed to be used, should this be
+ tested against $r->method_number (e.g. Apache::M_POST) ? what's
+ $limit? (notice that the test of this method isn't so good, it
+ tests some hardcoded -1 value, how do you know that it does what you
+ think it does?)
+
+
+
=head2 C
-Which allow-override bits are set
+Which allow-override bits are set (C directive)
$override = $parms->override;
=over 4
-=item parms: C<$parms>
+=item obj: C<$parms>
( C> )
-=item ret: C<$override> (integer)
+=item ret: C<$over
cvs commit: modperl-docs/src/docs/2.0/api/Apache CmdParms.pod Command.pod
gozer 2004/08/12 22:45:50
Modified:src/docs/2.0/api/Apache CmdParms.pod Command.pod
Log:
Apache::CmdParms is completed.
Awaiting review by Stas please...
Revision ChangesPath
1.6 +109 -181 modperl-docs/src/docs/2.0/api/Apache/CmdParms.pod
Index: CmdParms.pod
===
RCS file: /home/cvs/modperl-docs/src/docs/2.0/api/Apache/CmdParms.pod,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- CmdParms.pod 10 Aug 2004 03:15:52 - 1.5
+++ CmdParms.pod 13 Aug 2004 05:45:49 - 1.6
@@ -1,6 +1,6 @@
=head1 NAME
-Apache::CmdParms - Perl API for XXX
+Apache::CmdParms - Perl API for Apache command parameters object
@@ -8,15 +8,50 @@
=head1 Synopsis
use Apache::CmdParms ();
+ use Apache::Const -compile => qw(NOT_IN_LOCATION);
+
+ sub MyDirective {
+my ($self, $parms, $args) = @_;
+
+# this command's command object
+$cmd = $parms->cmd;
+
+# check the current command's context
+$error = $parms->check_cmd_context(Apache::NOT_IN_LOCATION);
+
+# this command's context
+$context = $parms->context;
+
+# this command's directive object
+$directive = $parms->directive;
+
+# the extra information passed thru cmd_data in @APACHE_MODULE_COMMANDS
+$info = $parms->info;
+
+# which methods are ed ?
+$limit = $parms->limited;
+
+# which allow-override bits are set
+$override = $parms->override;
+
+# the path this command is being invoked in
+$path = $parms->path;
+
+# this command's pool
+$p = $parms->pool;
+
+# this command's configuration time pool
+$p = $parms->temp_pool;
+ }
-META: to be completed
=head1 Description
-META: to be completed
+C provides the Perl API for Apache command
+parameters object.
@@ -27,110 +62,68 @@
-Comments for Philippe:
-
- should the elements of ap_params_t elements be writable? see the
- comments in the API section of the Command.pod and Directive.pod. if
- unsure, make things read-only. we can always enable them back later.
-
-
-
=head2 C
-META: Autogenerated - needs to be reviewed/completed
-
-configuration command
+This module's command information
- $obj->cmd($newval);
+ $cmd = $parms->cmd();
=over 4
-=item obj: C<$obj>
+=item parms: C<$parms>
( C> )
-=item arg1: C<$newval>
+=item ret: C<$cmd>
( C> )
-=item ret: no return value
-
-=item since: 1.99_12
-
-=back
-
-
-
-
-
-=head2 C
-
-META: Autogenerated - needs to be reviewed/completed
-
-Config file structure.
-
- $obj->config_file($newval);
-
-=over 4
-
-=item obj: C<$obj>
-( C> )
-
-=item arg1: C<$newval>
-( C> )
-
-=item ret: no return value
-
=item since: 1.99_12
-
=back
-=head2 C
-META: Autogenerated - needs to be reviewed/completed
+=head2 C
-per_dir_config vector passed to handle_command
+Check the current command against a context bitmask of forbidden contexts.
- $obj->context($newval);
+ $error = $parms->check_cmd_context(Apache::NOT_IN_LOCATION);
=over 4
-=item obj: C<$obj>
+=item parms: C<$parms>
( C> )
-=item arg1: C<$newval>
-( C> )
+=item ret: C<$error>
-=item ret: no return value
+If the context is forbidden, this method returns a textual description
+of why it was forbidden. If the context is permitted, this method returns
+C.
-=item since: 1.99_12
+=item since: 1.99_16
=back
-
=head2 C
-META: Autogenerated - needs to be reviewed/completed
-
-the directive specifying this command
+This command's directive object in the configuration tree
- $obj->directive($newval);
+ $directive = $parms->directive;
=over 4
-=item obj: C<$obj>
+=item parms: C<$parms>
( C> )
-=item arg1: C<$newval>
+=item ret: C<$newval>
( C> )
-=item ret: no return value
+The current directive node in the configuration tree
=item since: 1.99_12
@@ -141,47 +134,21 @@
-=head2 C
-
-META: Autogenerated - needs to be reviewed/completed
-
-directive with syntax error
-
- $obj->err_directive($newval);
-
-=over 4
-
-=item obj: C<$obj>
-( C> )
-
-=item arg1: C<$newval>
-( C> )
-
-=item ret: no return value
-
-=item since: 1.99_12
-
-=back
-
-
-
=head2 C
-META: Autogenerated - needs to be reviewed/completed
-
-Argument to command from cmd_table
+The extra information passed thru C in
+C>
- $obj->info($newval);
+ $info = $parms->info;
=over 4
-=item obj: C<$obj>
+=item parms: C<$parms>
( C> )
cvs commit: modperl-docs/src/docs/2.0/api/Apache CmdParms.pod Command.pod Directive.pod
stas2004/08/09 20:15:52 Modified:src/docs/2.0/api/Apache CmdParms.pod Command.pod Directive.pod Log: some preparations before the filling work starts Revision ChangesPath 1.5 +141 -83 modperl-docs/src/docs/2.0/api/Apache/CmdParms.pod Index: CmdParms.pod === RCS file: /home/cvs/modperl-docs/src/docs/2.0/api/Apache/CmdParms.pod,v retrieving revision 1.4 retrieving revision 1.5 diff -u -u -r1.4 -r1.5 --- CmdParms.pod 12 Jul 2004 23:13:22 - 1.4 +++ CmdParms.pod 10 Aug 2004 03:15:52 - 1.5 @@ -27,90 +27,112 @@ +Comments for Philippe: + + should the elements of ap_params_t elements be writable? see the + comments in the API section of the Command.pod and Directive.pod. if + unsure, make things read-only. we can always enable them back later. + + -=head2 C + + +=head2 C META: Autogenerated - needs to be reviewed/completed -Argument to command from cmd_table +configuration command - $obj->info($newval); + $obj->cmd($newval); =over 4 -=item obj: C<$obj> (C>) +=item obj: C<$obj> +( C> ) -=item arg1: C<$newval> (XXX) +=item arg1: C<$newval> +( C> ) =item ret: no return value +=item since: 1.99_12 + =back -=head2 C +=head2 C META: Autogenerated - needs to be reviewed/completed -Which allow-override bits are set +Config file structure. - $obj->override($newval); + $obj->config_file($newval); =over 4 -=item obj: C<$obj> (C>) +=item obj: C<$obj> +( C> ) -=item arg1: C<$newval> (integer) +=item arg1: C<$newval> +( C> ) =item ret: no return value -=back +=item since: 1.99_12 + +=back -=head2 C +=head2 C META: Autogenerated - needs to be reviewed/completed -Which methods are ELimitEed +per_dir_config vector passed to handle_command - $obj->limited($newval); + $obj->context($newval); =over 4 -=item obj: C<$obj> (C>) +=item obj: C<$obj> +( C> ) -=item arg1: C<$newval> (number) +=item arg1: C<$newval> +( C> ) =item ret: no return value +=item since: 1.99_12 =back - -=head2 C +=head2 C META: Autogenerated - needs to be reviewed/completed -methods which are limited +the directive specifying this command - $obj->limited_xmethods($newval); + $obj->directive($newval); =over 4 -=item obj: C<$obj> (C>) +=item obj: C<$obj> +( C> ) -=item arg1: C<$newval> (C>) +=item arg1: C<$newval> +( C> ) =item ret: no return value +=item since: 1.99_12 =back @@ -118,44 +140,50 @@ -=head2 C + +=head2 C META: Autogenerated - needs to be reviewed/completed -methods which are xlimited +directive with syntax error - $obj->xlimited($newval); + $obj->err_directive($newval); =over 4 -=item obj: C<$obj> (C>) +=item obj: C<$obj> +( C> ) -=item arg1: C<$newval> (C>) +=item arg1: C<$newval> +( C> ) =item ret: no return value -=back - +=item since: 1.99_12 +=back -=head2 C +=head2 C META: Autogenerated - needs to be reviewed/completed -Config file structure. +Argument to command from cmd_table - $obj->config_file($newval); + $obj->info($newval); =over 4 -=item obj: C<$obj> (C>) +=item obj: C<$obj> +( C> ) -=item arg1: C<$newval> (C>) +=item arg1: C<$newval> +(XXX) =item ret: no return value +=item since: 1.99_12 =back @@ -163,67 +191,77 @@ -=head2 C + +=head2 C META: Autogenerated - needs to be reviewed/completed -the directive specifying this command +Which methods are ELimitEed - $obj->directive($newval); + $obj->limited($newval); =over 4 -=item obj: C<$obj> (C>) +=item obj: C<$obj> +( C> ) -=item arg1: C<$newval> (C>) +=item arg1: C<$newval> +(number) =item ret: no return value +=item since: 1.99_12 + =back -=head2 C +=head2 C META: Autogenerated - needs to be reviewed/completed -Pool to allocate new storage in +methods which are limited - $obj->pool($newval); + $obj->limited_xmethods($newval); =over 4 -=item obj: C<$obj> (C>) +=item obj: C<$obj> +( C> ) -=item arg1: C<$newval> (C>) +=item arg1: C<$newval> +(C>) =item ret: no return value -=back +=item since: 1.99_12 +=back -=head2 C +=head2 C META: Autogenerated - needs to be reviewed/completed -Pool for scratch memory; persists during configuration, but -wiped before the first request is served... +Which allow-override bits are set
cvs commit: modperl-docs/src/docs/2.0/api/Apache CmdParms.pod Command.pod Connection.pod HookRun.pod Module.pod Process.pod RequestIO.pod Response.pod Server.pod SubRequest.pod URI.pod Util.pod Access.pod Const.pod Directive.pod Filter.pod FilterRec.pod Log.pod PerlSections.pod Reload.pod RequestRec.pod RequestUtil.pod ServerUtil.pod Status.pod compat.pod porting.pod
stas2004/01/14 01:23:48 Modified:src/docs/2.0/api config.cfg src/docs/2.0/api/APR Const.pod src/docs/2.0/api/Apache Access.pod Const.pod Directive.pod Filter.pod FilterRec.pod Log.pod PerlSections.pod Reload.pod RequestRec.pod RequestUtil.pod ServerUtil.pod Status.pod compat.pod porting.pod Added: src/docs/2.0/api/Apache CmdParms.pod Command.pod Connection.pod HookRun.pod Module.pod Process.pod RequestIO.pod Response.pod Server.pod SubRequest.pod URI.pod Util.pod Log: more manpages, work in progress Revision ChangesPath 1.29 +13 -1 modperl-docs/src/docs/2.0/api/config.cfg http://cvs.apache.org/viewcvs/modperl-docs/src/docs/2.0/api/config.cfg.diff?r1=1.28&r2=1.29 1.7 +3 -1 modperl-docs/src/docs/2.0/api/APR/Const.pod http://cvs.apache.org/viewcvs/modperl-docs/src/docs/2.0/api/APR/Const.pod.diff?r1=1.6&r2=1.7 1.2 +226 -20 modperl-docs/src/docs/2.0/api/Apache/Access.pod http://cvs.apache.org/viewcvs/modperl-docs/src/docs/2.0/api/Apache/Access.pod.diff?r1=1.1&r2=1.2 1.5 +28 -2 modperl-docs/src/docs/2.0/api/Apache/Const.pod http://cvs.apache.org/viewcvs/modperl-docs/src/docs/2.0/api/Apache/Const.pod.diff?r1=1.4&r2=1.5 1.3 +289 -44 modperl-docs/src/docs/2.0/api/Apache/Directive.pod http://cvs.apache.org/viewcvs/modperl-docs/src/docs/2.0/api/Apache/Directive.pod.diff?r1=1.2&r2=1.3 1.7 +405 -43 modperl-docs/src/docs/2.0/api/Apache/Filter.pod http://cvs.apache.org/viewcvs/modperl-docs/src/docs/2.0/api/Apache/Filter.pod.diff?r1=1.6&r2=1.7 1.4 +69 -18modperl-docs/src/docs/2.0/api/Apache/FilterRec.pod http://cvs.apache.org/viewcvs/modperl-docs/src/docs/2.0/api/Apache/FilterRec.pod.diff?r1=1.3&r2=1.4 1.5 +252 -53 modperl-docs/src/docs/2.0/api/Apache/Log.pod http://cvs.apache.org/viewcvs/modperl-docs/src/docs/2.0/api/Apache/Log.pod.diff?r1=1.4&r2=1.5 1.7 +61 -2 modperl-docs/src/docs/2.0/api/Apache/PerlSections.pod http://cvs.apache.org/viewcvs/modperl-docs/src/docs/2.0/api/Apache/PerlSections.pod.diff?r1=1.6&r2=1.7 1.8 +12 -0 modperl-docs/src/docs/2.0/api/Apache/Reload.pod http://cvs.apache.org/viewcvs/modperl-docs/src/docs/2.0/api/Apache/Reload.pod.diff?r1=1.7&r2=1.8 1.5 +1036 -64 modperl-docs/src/docs/2.0/api/Apache/RequestRec.pod http://cvs.apache.org/viewcvs/modperl-docs/src/docs/2.0/api/Apache/RequestRec.pod.diff?r1=1.4&r2=1.5 1.6 +577 -39 modperl-docs/src/docs/2.0/api/Apache/RequestUtil.pod http://cvs.apache.org/viewcvs/modperl-docs/src/docs/2.0/api/Apache/RequestUtil.pod.diff?r1=1.5&r2=1.6 1.5 +190 -91 modperl-docs/src/docs/2.0/api/Apache/ServerUtil.pod http://cvs.apache.org/viewcvs/modperl-docs/src/docs/2.0/api/Apache/ServerUtil.pod.diff?r1=1.4&r2=1.5 1.2 +38 -8 modperl-docs/src/docs/2.0/api/Apache/Status.pod http://cvs.apache.org/viewcvs/modperl-docs/src/docs/2.0/api/Apache/Status.pod.diff?r1=1.1&r2=1.2 1.7 +23 -0 modperl-docs/src/docs/2.0/api/Apache/compat.pod http://cvs.apache.org/viewcvs/modperl-docs/src/docs/2.0/api/Apache/compat.pod.diff?r1=1.6&r2=1.7 1.3 +32 -0 modperl-docs/src/docs/2.0/api/Apache/porting.pod http://cvs.apache.org/viewcvs/modperl-docs/src/docs/2.0/api/Apache/porting.pod.diff?r1=1.2&r2=1.3 1.1 modperl-docs/src/docs/2.0/api/Apache/CmdParms.pod http://cvs.apache.org/viewcvs/modperl-docs/src/docs/2.0/api/Apache/CmdParms.pod?rev=1.1 1.1 modperl-docs/src/docs/2.0/api/Apache/Command.pod http://cvs.apache.org/viewcvs/modperl-docs/src/docs/2.0/api/Apache/Command.pod?rev=1.1 1.1 modperl-docs/src/docs/2.0/api/Apache/Connection.pod http://cvs.apache.org/viewcvs/modperl-docs/src/docs/2.0/api/Apache/Connection.pod?rev=1.1 1.1 modperl-docs/src/docs/2.0/api/Apache/HookRun.pod http://cvs.apache.org/viewcvs/modperl-docs/src/docs/2.0/api/Apache/HookRun.pod?rev=1.1 1.1 modperl-docs/src/docs/2.0/api/Apache/Module.pod http://cvs.apache.org/viewcvs/modperl-docs/src/docs/2.0/api/Apache/Module.pod?rev=1.1 1.1 modperl-docs/src/docs/2.0/api/Apache/Process.pod http://cvs.apache.org/viewcvs/modperl-docs/src/docs/2.0/api/Apache/Process.pod?rev=1.1 1.1 modperl-docs/src/docs/2.0/api/Apache/RequestIO.pod http://cvs.apache.org/viewcvs/modperl-docs/src/docs/2.0/api/Apache/RequestIO.pod?rev=1.1 1.1 modperl-docs/src/docs/2.0/api/Apache/Response.pod http://cvs.apache.org/viewcvs/modperl-docs/src/docs/2.0/api/Apache/Respo
