stas 2004/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 Changes Path
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 -0000 1.4
+++ CmdParms.pod 10 Aug 2004 03:15:52 -0000 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<info>
+
+
+=head2 C<cmd>
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<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)
+=item obj: C<$obj>
+( C<L<Apache::CmdParms object|docs::2.0::api::Apache::CmdParms>> )
-=item arg1: C<$newval> (XXX)
+=item arg1: C<$newval>
+( C<L<Apache::Command object|docs::2.0::api::Apache::Command>> )
=item ret: no return value
+=item since: 1.99_12
+
=back
-=head2 C<override>
+=head2 C<config_file>
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<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)
+=item obj: C<$obj>
+( C<L<Apache::CmdParms object|docs::2.0::api::Apache::CmdParms>> )
-=item arg1: C<$newval> (integer)
+=item arg1: C<$newval>
+( C<L<Apache::ConfigFile object|docs::2.0::api::Apache::ConfigFile>> )
=item ret: no return value
-=back
+=item since: 1.99_12
+
+=back
-=head2 C<limited>
+=head2 C<context>
META: Autogenerated - needs to be reviewed/completed
-Which methods are E<lt>LimitE<gt>ed
+per_dir_config vector passed to handle_command
- $obj->limited($newval);
+ $obj->context($newval);
=over 4
-=item obj: C<$obj> (C<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)
+=item obj: C<$obj>
+( C<L<Apache::CmdParms object|docs::2.0::api::Apache::CmdParms>> )
-=item arg1: C<$newval> (number)
+=item arg1: C<$newval>
+( C<L<Apache::ConfVector object|docs::2.0::api::Apache::ConfVector>> )
=item ret: no return value
+=item since: 1.99_12
=back
-
-=head2 C<limited_xmethods>
+=head2 C<directive>
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<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)
+=item obj: C<$obj>
+( C<L<Apache::CmdParms object|docs::2.0::api::Apache::CmdParms>> )
-=item arg1: C<$newval>
(C<L<APR::ArrayHeader|docs::2.0::api::APR::ArrayHeader>>)
+=item arg1: C<$newval>
+( C<L<Apache::Directive object|docs::2.0::api::Apache::Directive>> )
=item ret: no return value
+=item since: 1.99_12
=back
@@ -118,44 +140,50 @@
-=head2 C<xlimited>
+
+=head2 C<err_directive>
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<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)
+=item obj: C<$obj>
+( C<L<Apache::CmdParms object|docs::2.0::api::Apache::CmdParms>> )
-=item arg1: C<$newval>
(C<L<Apache::MethodList|docs::2.0::api::Apache::MethodList>>)
+=item arg1: C<$newval>
+( C<L<Apache::Directive object|docs::2.0::api::Apache::Directive>> )
=item ret: no return value
-=back
-
+=item since: 1.99_12
+=back
-=head2 C<config_file>
+=head2 C<info>
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<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)
+=item obj: C<$obj>
+( C<L<Apache::CmdParms object|docs::2.0::api::Apache::CmdParms>> )
-=item arg1: C<$newval>
(C<L<Apache::ConfigFile|docs::2.0::api::Apache::ConfigFile>>)
+=item arg1: C<$newval>
+(XXX)
=item ret: no return value
+=item since: 1.99_12
=back
@@ -163,67 +191,77 @@
-=head2 C<directive>
+
+=head2 C<limited>
META: Autogenerated - needs to be reviewed/completed
-the directive specifying this command
+Which methods are E<lt>LimitE<gt>ed
- $obj->directive($newval);
+ $obj->limited($newval);
=over 4
-=item obj: C<$obj> (C<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)
+=item obj: C<$obj>
+( C<L<Apache::CmdParms object|docs::2.0::api::Apache::CmdParms>> )
-=item arg1: C<$newval>
(C<L<Apache::Directive|docs::2.0::api::Apache::Directive>>)
+=item arg1: C<$newval>
+(number)
=item ret: no return value
+=item since: 1.99_12
+
=back
-=head2 C<pool>
+=head2 C<limited_xmethods>
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<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)
+=item obj: C<$obj>
+( C<L<Apache::CmdParms object|docs::2.0::api::Apache::CmdParms>> )
-=item arg1: C<$newval> (C<L<APR::Pool|docs::2.0::api::APR::Pool>>)
+=item arg1: C<$newval>
+(C<L<APR::ArrayHeader|docs::2.0::api::APR::ArrayHeader>>)
=item ret: no return value
-=back
+=item since: 1.99_12
+=back
-=head2 C<temp_pool>
+=head2 C<override>
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
- $obj->temp_pool($p);
+ $obj->override($newval);
=over 4
-=item obj: C<$obj> (C<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)
+=item obj: C<$obj>
+( C<L<Apache::CmdParms object|docs::2.0::api::Apache::CmdParms>> )
-=item arg1: C<$p> (C<L<APR::Pool|docs::2.0::api::APR::Pool>>)
+=item arg1: C<$newval>
+(integer)
=item ret: no return value
+=item since: 1.99_12
=back
@@ -231,116 +269,136 @@
-=head2 C<server>
+=head2 C<path>
META: Autogenerated - needs to be reviewed/completed
-server_rec being configured for
+If configuring for a directory, pathname of that directory. NOPE!
+That's what it meant previous to the existance of E<lt>FilesE<gt>,
+E<lt>LocationE<gt> and regex matching. Now the only usefulness that
+can be derived from this field is whether a command is being called in
+a server context (path == NULL) or being called in a dir context (path
+!= NULL).
- $obj->server($s);
+ $obj->path($newval);
=over 4
-=item obj: C<$obj> (C<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)
+=item obj: C<$obj>
+( C<L<Apache::CmdParms object|docs::2.0::api::Apache::CmdParms>> )
-=item arg1: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::ServerRec>>)
+=item arg1: C<$newval>
+(string)
=item ret: no return value
-=back
-
+=item since: 1.99_12
+=back
-=head2 C<path>
+=head2 C<pool>
META: Autogenerated - needs to be reviewed/completed
-If configuring for a directory, pathname of that directory. NOPE!
-That's what it meant previous to the existance of E<lt>FilesE<gt>,
-E<lt>LocationE<gt> and regex matching. Now the only usefulness that
-can be derived from this field is whether a command is being called in
-a server context (path == NULL) or being called in a dir context (path
-!= NULL).
+Pool to allocate new storage in
- $obj->path($newval);
+ $obj->pool($newval);
=over 4
-=item obj: C<$obj> (C<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)
+=item obj: C<$obj>
+( C<L<Apache::CmdParms object|docs::2.0::api::Apache::CmdParms>> )
-=item arg1: C<$newval> (string)
+=item arg1: C<$newval>
+(C<L<APR::Pool|docs::2.0::api::APR::Pool>>)
=item ret: no return value
+=item since: 1.99_12
+
=back
-=head2 C<cmd>
+
+=head2 C<server>
META: Autogenerated - needs to be reviewed/completed
-configuration command
+server_rec being configured for
- $obj->cmd($newval);
+ $obj->server($s);
=over 4
-=item obj: C<$obj> (C<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)
+=item obj: C<$obj>
+( C<L<Apache::CmdParms object|docs::2.0::api::Apache::CmdParms>> )
-=item arg1: C<$newval>
(C<L<Apache::Command|docs::2.0::api::Apache::Command>>)
+=item arg1: C<$s> (C<L<Apache::Server|docs::2.0::api::Apache::ServerRec>>)
=item ret: no return value
+=item since: 1.99_12
+
=back
-=head2 C<context>
+
+=head2 C<temp_pool>
META: Autogenerated - needs to be reviewed/completed
-per_dir_config vector passed to handle_command
+Pool for scratch memory; persists during configuration, but
+wiped before the first request is served...
- $obj->context($newval);
+ $obj->temp_pool($p);
=over 4
-=item obj: C<$obj> (C<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)
+=item obj: C<$obj>
+( C<L<Apache::CmdParms object|docs::2.0::api::Apache::CmdParms>> )
-=item arg1: C<$newval>
(C<L<Apache::ConfVector|docs::2.0::api::Apache::ConfVector>>)
+=item arg1: C<$p> (C<L<APR::Pool|docs::2.0::api::APR::Pool>>)
=item ret: no return value
+=item since: 1.99_12
+
=back
-=head2 C<err_directive>
+=head2 C<xlimited>
META: Autogenerated - needs to be reviewed/completed
-directive with syntax error
+methods which are xlimited
- $obj->err_directive($newval);
+ $obj->xlimited($newval);
=over 4
-=item obj: C<$obj> (C<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)
+=item obj: C<$obj>
+( C<L<Apache::CmdParms object|docs::2.0::api::Apache::CmdParms>> )
-=item arg1: C<$newval>
(C<L<Apache::Directive|docs::2.0::api::Apache::Directive>>)
+=item arg1: C<$newval>
+(C<L<Apache::MethodList|docs::2.0::api::Apache::MethodList>>)
=item ret: no return value
+=item since: 1.99_12
+
=back
+
1.4 +107 -52 modperl-docs/src/docs/2.0/api/Apache/Command.pod
Index: Command.pod
===================================================================
RCS file: /home/cvs/modperl-docs/src/docs/2.0/api/Apache/Command.pod,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -u -r1.3 -r1.4
--- Command.pod 22 May 2004 02:03:27 -0000 1.3
+++ Command.pod 10 Aug 2004 03:15:52 -0000 1.4
@@ -27,18 +27,63 @@
+Comments for Philippe:
+
+ should the elements of ap_command_t elements be writable? if not
+ set those to readonly, e.g to set func to read-only change
+ xs/maps/apache_structures.map and add '<' at the beginning of the
+ line:
+
+ <command_rec>
+ name
+ < func
+ cmd_data
+ ...
+ </command_rec>
+
+ in either case make sure to adjust the docs whether each method is
+ readonly or read/write.
+
+
+
-=head2 C<check_cmd_context>
+
+
+=head2 C<args_how>
META: Autogenerated - needs to be reviewed/completed
+What the command expects as arguments
+
+ $obj->args_how($newval);
+
+=over 4
+
+=item obj: C<$obj>
+( C<L<Apache::Command object|docs::2.0::api::Apache::Command>> )
+
+=item arg1: C<$newval> (integer)
+
+=item ret: no return value
+
+=item since: 1.99_12
+
+=back
+
+
+
+=head2 C<check_cmd_context>
+
+META: Autogenerated - needs to be reviewed/completed
+
$ret = $cmd->check_cmd_context($forbidden);
=over 4
-=item obj: C<$cmd> (C<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)
+=item obj: C<$cmd>
+(C<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)
The command to check
@@ -46,58 +91,65 @@
Where the command is forbidden.
-=item ret: C<$ret> (string)
+=item ret: C<$ret> ( string )
Error string on error, NULL on success
+=item since: 1.99_12
+
=back
-=head2 C<soak_end_container>
+=head2 C<cmd_data>
META: Autogenerated - needs to be reviewed/completed
-Read all data between the current E<lt>fooE<gt> and the matching
-E<lt>/fooE<gt>. All of this data is forgotten immediately.
+Extra data, for functions which implement multiple commands...
- $ret = $cmd->soak_end_container($directive);
+ $cmd_data = $obj->cmd_data();
+ $prev_cmd_data = $obj->cmd_data($new_cmd_data);
=over 4
-=item obj: C<$cmd> (C<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)
+=item obj: C<$obj>
+( C<L<Apache::Command object|docs::2.0::api::Apache::Command>> )
-The cmd_parms to pass to the directives inside the container
+=item opt arg1: C<$new_cmd_data> (XXX)
-=item arg1: C<$directive> (string)
+=item ret: no return value
-The directive name to read until
+=item since: 1.99_12
-=item ret: C<$ret> (string)
+=back
-Error string on failure, NULL on success
-=back
-=head2 C<next>
-META: Autogenerated - needs to be reviewed/completed
+=head2 C<errmsg>
+META: Autogenerated - needs to be reviewed/completed
+'usage' message, in case of syntax errors
- $ret = $cmd->next();
+ $obj->errmsg($newval);
=over 4
-=item obj: C<$cmd> (C<L<Apache::Command|docs::2.0::api::Apache::Command>>)
+=item obj: C<$obj>
+( C<L<Apache::Command object|docs::2.0::api::Apache::Command>> )
+
+=item arg1: C<$newval> ( string )
+
+=item ret: no return value
-=item ret: C<$ret> (C<L<Apache::Command|docs::2.0::api::Apache::Command>>)
+=item since: 1.99_12
=back
@@ -105,43 +157,49 @@
+
+
=head2 C<name>
META: Autogenerated - needs to be reviewed/completed
Name of this command
- $obj->name($newval);
+ $name = $obj->name();
+ $prev_name = $obj->name($new_name);
=over 4
-=item obj: C<$obj> (C<L<Apache::Command|docs::2.0::api::Apache::Command>>)
+=item obj: C<$obj>
+( C<L<Apache::Command object|docs::2.0::api::Apache::Command>> )
-=item arg1: C<$newval> (string)
+=item opt arg1: C<$new_name> ( string )
=item ret: no return value
+=item since: 1.99_12
+
=back
-=head2 C<cmd_data>
+=head2 C<next>
META: Autogenerated - needs to be reviewed/completed
-Extra data, for functions which implement multiple commands...
-
- $obj->cmd_data($newval);
+ $ret = $cmd->next();
=over 4
-=item obj: C<$obj> (C<L<Apache::Command|docs::2.0::api::Apache::Command>>)
+=item obj: C<$cmd>
+( C<L<Apache::Command object|docs::2.0::api::Apache::Command>> )
-=item arg1: C<$newval> (XXX)
+=item ret: C<$ret>
+( C<L<Apache::Command object|docs::2.0::api::Apache::Command>> )
-=item ret: no return value
+=item since: 1.99_12
=back
@@ -149,6 +207,9 @@
+
+
+
=head2 C<req_override>
META: Autogenerated - needs to be reviewed/completed
@@ -159,57 +220,51 @@
=over 4
-=item obj: C<$obj> (C<L<Apache::Command|docs::2.0::api::Apache::Command>>)
+=item obj: C<$obj>
+( C<L<Apache::Command object|docs::2.0::api::Apache::Command>> )
=item arg1: C<$newval> (integer)
=item ret: no return value
+=item since: 1.99_12
+
=back
-=head2 C<args_how>
+=head2 C<soak_end_container>
META: Autogenerated - needs to be reviewed/completed
-What the command expects as arguments
+Read all data between the current E<lt>fooE<gt> and the matching
+E<lt>/fooE<gt>. All of this data is forgotten immediately.
- $obj->args_how($newval);
+ $ret = $cmd->soak_end_container($directive);
=over 4
-=item obj: C<$obj> (C<L<Apache::Command|docs::2.0::api::Apache::Command>>)
-
-=item arg1: C<$newval> (integer)
-
-=item ret: no return value
-
-=back
-
-
-
+=item obj: C<$cmd>
+( C<L<Apache::CmdParms object|docs::2.0::api::Apache::CmdParms>> )
+The cmd_parms to pass to the directives inside the container
-=head2 C<errmsg>
+=item arg1: C<$directive> ( string )
-META: Autogenerated - needs to be reviewed/completed
+The directive name to read until
-'usage' message, in case of syntax errors
+=item ret: C<$ret> ( string )
- $obj->errmsg($newval);
+Error string on failure, NULL on success
-=over 4
+=item since: 1.99_12
-=item obj: C<$obj> (C<L<Apache::Command|docs::2.0::api::Apache::Command>>)
+=back
-=item arg1: C<$newval> (string)
-=item ret: no return value
-=back
1.6 +203 -105 modperl-docs/src/docs/2.0/api/Apache/Directive.pod
Index: Directive.pod
===================================================================
RCS file: /home/cvs/modperl-docs/src/docs/2.0/api/Apache/Directive.pod,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -u -r1.5 -r1.6
--- Directive.pod 22 May 2004 02:03:27 -0000 1.5
+++ Directive.pod 10 Aug 2004 03:15:52 -0000 1.6
@@ -56,30 +56,72 @@
first child (if any), and to its next sibling.
-=head1 Class Methods
-=head2 C<conftree()>
-Returns the root of the configuration tree.
- $tree = Apache::Directive->conftree();
+
+
+=head1 API
+
+C<Apache::Directive> provides the following functions and/or methods:
+
+
+
+
+
+Comments for Philippe:
+
+ should the elements of ap_directive_t elements be writable? if not
+ set those to readonly, e.g to set args to read only change
+ xs/maps/apache_structures.map and add '<' at the beginning of the
+ line:
+
+ <ap_directive_t>
+ directive
+ < args
+ next
+ ...
+ </ap_directive_t>
+
+ in either case make sure to adjust the docs whether each method is
+ readonly or read/write.
+
+
+
+
+
+
+
+=head2 C<args>
+
+META: Autogenerated - needs to be reviewed/completed
+
+The arguments for the current directive, stored as a space separated
+list
+
+ $args = $node->args();
+ $prev_args = $node->args($new_val);
=over 4
-=item obj: C<Apache::Directive> (class name)
+=item obj: C<$node>
+( C<L<Apache::Directive object|docs::2.0::api::Apache::Directive>> )
-=item ret: C<$tree>
(C<L<Apache::Directive|docs::2.0::api::Apache::Directive>>)
+=item opt arg1: C<$new_val>) ( string )
-=back
+XXX
+=item ret: C<$args> ( string )
+=item since: 1.99_12
+=back
-=head1 Object Methods
+=head2 C<as_hash>
-=head2 C<as_hash()>
+META: Autogenerated - needs to be reviewed/completed
Returns a hash representation of the configuration tree, in a format
suitable for inclusion in the E<lt>PerlE<gt> sections.
@@ -88,222 +130,272 @@
=over 4
-=item obj: C<$conftree>
(C<L<Apache::Directive|docs::2.0::api::Apache::Directive>>)
+=item obj: C<$conftree>
+( C<L<Apache::Directive object|docs::2.0::api::Apache::Directive>> )
The config tree to stringify
=item ret: C<$config_hash> (HASH)
+=item since: 1.99_12
+
=back
-=head2 C<as_string()>
+
+
+=head2 C<as_string>
+
+META: Autogenerated - needs to be reviewed/completed
Returns a string representation of the configuration tree, in
-httpd.conf format.
+F<httpd.conf> format.
$string = $conftree->as_string();
=over 4
-=item obj: C<$conftree>
(C<L<Apache::Directive|docs::2.0::api::Apache::Directive>>)
+=item obj: C<$conftree>
+( C<L<Apache::Directive object|docs::2.0::api::Apache::Directive>> )
The config tree to stringify
-=item ret: C<$string> (string)
+=item ret: C<$string> ( string )
+
+=item since: 1.99_12
=back
-=head2 C<lookup()>
+=head2 C<conftree>
-Returns node(s) matching a certain value.
+META: Autogenerated - needs to be reviewed/completed
- $node = $conftree->lookup($directive, $args);
- @nodes = $conftree->lookup($directive, $args);
+Returns the root of the configuration tree.
-=over 4
+ $tree = Apache::Directive->conftree();
-=item obj: C<$conftree>
(C<L<Apache::Directive|docs::2.0::api::Apache::Directive>>)
+=over 4
-The config tree to stringify
+=item obj: C<Apache::Directive> (class name)
-=item arg1: C<$directive> (string)
+=item ret: C<$tree> ( C<L<Apache::Directive
object|docs::2.0::api::Apache::Directive>> )
-=item opt arg3: C<args> (string)
+=item since: 1.99_12
-=item ret: C<$string> (string)
+=back
-In list context, it will return all matching nodes.
-In scalar context, it will return only the first matching node.
-If called with only C<$directive> value, this will return all nodes
-from that directive. For example:
- @Alias = $conftree->lookup('Alias');
-would return all nodes for Alias directives.
+=head2 C<data>
-If called with an extra C<$args> argument, this will return only nodes
-where both the directive and the args matched. For example:
+META: Autogenerated - needs to be reviewed/completed
- $VHost = $tree->lookup('VirtualHost', '_default_:8000');
+directive's module can store add'l data here
+ $ret = $conftree->data($newval);
-=back
+=over 4
+=item obj: C<$conftree>
+( C<L<Apache::Directive object|docs::2.0::api::Apache::Directive>> )
+=item arg1: C<$newval> XXX
+=item ret: XXX
-If called with only one C<$directive> value, this will return all
-nodes from that directive:
+=item since: 1.99_12
- @Alias = $tree->lookup('Alias');
+=back
-Would return all nodes for Alias directives.
-If called with an extra C<$args> argument, this will return only nodes
-where both the directive and the args matched:
- $VHost = $tree->lookup('VirtualHosts', '_default_:8000');
-=head2 C<walk_config>
+=head2 C<directive>
META: Autogenerated - needs to be reviewed/completed
-Walk a config tree and setup the server's internal structures
+Returns the name of the directive in C<$node>.
- $ret = $conftree->walk_config($cmdparms, $section_vector);
+ $name = $node->directive();
=over 4
-=item obj: C<$conftree>
(C<L<Apache::Directive|docs::2.0::api::Apache::Directive>>)
+=item obj: C<$node>
+( C<L<Apache::Directive object|docs::2.0::api::Apache::Directive>> )
-The config tree to walk
+=item ret: C<$directive> ( string )
-=item arg1: C<$cmdparms>
(C<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)
+=item since: 1.99_12
-The cmd_parms to pass to all functions
+=back
-=item arg2: C<$section_vector>
(C<L<Apache::ConfVector|docs::2.0::api::Apache::ConfVector>>)
-The per-section config vector.
-=item ret: C<$ret> (string)
-Error string on error, C<undef> otherwise
-=back
+=head2 C<filename>
+META: Autogenerated - needs to be reviewed/completed
+Returns the filename the configuration node was created from
+ $filename = $node->filename();
+=over 4
+=item obj: C<$node>
+( C<L<Apache::Directive object|docs::2.0::api::Apache::Directive>> )
+=item ret: C<$filename> ( string )
+=item since: 1.99_12
+=back
-=head2 C<directive>
-Returns the name of the directive in C<$node>.
- $name = $node->directive();
+=head2 C<first_child>
+
+META: Autogenerated - needs to be reviewed/completed
+
+The first child node of this directive
+
+ $subtree = $node->first_child;
=over 4
-=item obj: C<$node>
(C<L<Apache::Directive|docs::2.0::api::Apache::Directive>>)
+=item obj: C<$node>
+( C<L<Apache::Directive object|docs::2.0::api::Apache::Directive>> )
+
+=item ret: C<$child_node>
+( C<L<Apache::Directive object|docs::2.0::api::Apache::Directive>> )
+
+Returns the first child node of C<$node>, C<undef> if there is none
-=item ret: C<$directive> (string)
+=item since: 1.99_12
=back
+=head2 C<line_num>
-=head2 C<args>
+META: Autogenerated - needs to be reviewed/completed
-The arguments for the current directive, stored as a space
-separated list
+Returns the line number in C<filename> this node was created from
- $args = $node->args();
+ $lineno = $node->line_num();
=over 4
-=item obj: C<$node>
(C<L<Apache::Directive|docs::2.0::api::Apache::Directive>>)
+=item obj: C<$node>
+( C<L<Apache::Directive object|docs::2.0::api::Apache::Directive>> )
+
+=item arg1: C<$lineno> (integer)
-=item ret: C<$args> (string)
+=item since: 1.99_12
=back
+=head2 C<lookup>
-=head2 C<next>
+META: Autogenerated - needs to be reviewed/completed
-The next directive node in the tree
+Returns node(s) matching a certain value.
- $next_node = $node->next();
+ $node = $conftree->lookup($directive, $args);
+ @nodes = $conftree->lookup($directive, $args);
=over 4
-=item obj: C<$node>
(C<L<Apache::Directive|docs::2.0::api::Apache::Directive>>)
+=item obj: C<$conftree>
+( C<L<Apache::Directive object|docs::2.0::api::Apache::Directive>> )
+
+The config tree to stringify
-=item ret: C<$next_node>
(C<L<Apache::Directive|docs::2.0::api::Apache::Directive>>)
+=item arg1: C<$directive> ( string )
-Returns the next sibling of C<$node>, C<undef> if there is none
+=item opt arg2: C<args> ( string )
+
+=item ret: C<$string> ( string )
+
+In list context, it will return all matching nodes.
+
+In scalar context, it will return only the first matching node.
+
+If called with only C<$directive> value, this will return all nodes
+from that directive. For example:
+
+ @Alias = $conftree->lookup('Alias');
+
+would return all nodes for Alias directives.
+
+If called with an extra C<$args> argument, this will return only nodes
+where both the directive and the args matched. For example:
+
+ $VHost = $tree->lookup('VirtualHost', '_default_:8000');
+
+=item since: 1.99_12
=back
+If called with only one C<$directive> value, this will return all
+nodes from that directive:
+ @Alias = $tree->lookup('Alias');
+Would return all nodes for Alias directives.
+If called with an extra C<$args> argument, this will return only nodes
+where both the directive and the args matched:
-=head2 C<first_child>
+ $VHost = $tree->lookup('VirtualHosts', '_default_:8000');
-The first child node of this directive
- $subtree = $node->first_child;
-=over 4
-=item obj: C<$node>
(C<L<Apache::Directive|docs::2.0::api::Apache::Directive>>)
-=item ret: C<$child_node>
(C<L<Apache::Directive|docs::2.0::api::Apache::Directive>>)
-Returns the first child node of C<$node>, C<undef> if there is none
-=back
-=head2 C<parent>
+=head2 C<next>
META: Autogenerated - needs to be reviewed/completed
-The parent node of this directive
+The next directive node in the tree
- $parent_node = $node->parent();
+ $next_node = $node->next();
=over 4
-=item obj: C<$node>
(C<L<Apache::Directive|docs::2.0::api::Apache::Directive>>)
+=item obj: C<$node>
+( C<L<Apache::Directive object|docs::2.0::api::Apache::Directive>> )
-=item ret: C<parent_node>
(C<L<Apache::Directive|docs::2.0::api::Apache::Directive>>)
+=item ret: C<$next_node>
+( C<L<Apache::Directive object|docs::2.0::api::Apache::Directive>> )
-Returns the parent of C<$node>, C<undef> if this node is the root node
+Returns the next sibling of C<$node>, C<undef> if there is none
+
+=item since: 1.99_12
=back
@@ -311,59 +403,65 @@
-=head2 C<data>
+
+=head2 C<parent>
META: Autogenerated - needs to be reviewed/completed
-directive's module can store add'l data here
+The parent node of this directive
- $ret = $conftree->data($newval);
+ $parent_node = $node->parent();
=over 4
-=item obj: C<$conftree>
(C<L<Apache::Directive|docs::2.0::api::Apache::Directive>>)
+=item obj: C<$node> ( C<L<Apache::Directive
object|docs::2.0::api::Apache::Directive>> )
-=item arg1: C<$newval> XXX
+=item ret: C<parent_node>
+( C<L<Apache::Directive object|docs::2.0::api::Apache::Directive>> )
-=item ret: XXX
+Returns the parent of C<$node>, C<undef> if this node is the root node
+
+=item since: 1.99_12
=back
+=head2 C<walk_config>
-=head2 C<filename>
+META: Autogenerated - needs to be reviewed/completed
-Returns the filename the configuration node was created from
+Walk a config tree and setup the server's internal structures
- $filename = $node->filename();
+ $ret = $conftree->walk_config($cmdparms, $section_vector);
=over 4
-=item obj: C<$node>
(C<L<Apache::Directive|docs::2.0::api::Apache::Directive>>)
-
-=item ret: C<$filename> (string)
-
-=back
+=item obj: C<$conftree>
+( C<L<Apache::Directive object|docs::2.0::api::Apache::Directive>> )
+The config tree to walk
+=item arg1: C<$cmdparms>
+(C<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>>)
+The cmd_parms to pass to all functions
+=item arg2: C<$section_vector>
+(C<L<Apache::ConfVector|docs::2.0::api::Apache::ConfVector>>)
-=head2 C<line_num>
+The per-section config vector.
-Returns the line number in C<filename> this node was created from
+=item ret: C<$ret> ( string )
- $lineno = $node->line_num();
+Error string on error, C<undef> otherwise
-=over 4
+=item since: 1.99_12
-=item obj: C<$node>
(C<L<Apache::Directive|docs::2.0::api::Apache::Directive>>)
+=back
-=item arg1: C<$lineno> (integer)
-=back
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
