![]() |
Home / Documentation / 2.0 / API / | ![]() |
||
![]() ![]() ![]() |
||||
Apache::Directive - Perl API for manipulating Apache configuration tree | ||||
![]() ![]() |
|
||
use Apache::Directive (); my $tree = Apache::Directive->conftree; my $documentroot = $tree->lookup('DocumentRoot'); my $vhost = $tree->lookup('VirtualHost', 'localhost:8000'); my $servername = $vhost->{'ServerName'}; print $tree->as_string; use Data::Dumper; print Dumper($tree->as_hash); my $node = $tree; while ($node) { #do something with $node if (my $kid = $node->first_child) { $node = $kid; } elsif (my $next = $node->next) { $node = $next; } else { if (my $parent = $node->parent) { $node = $parent->next; } else { $node = undef; } } }
Apache::Directive
allows its users to search and navigate the
internal Apache configuration.
Internally, this information is stored in a tree structure. Each node in the tree has a reference to its parent (if it's not the root), its first child (if any), and to its next sibling.
conftree()
Returns the root of the configuration tree.
$tree = Apache::Directive->conftree();
Apache::Directive
(class name)
$tree
(Apache::Directive
)
as_hash()
Returns a hash representation of the configuration tree, in a format suitable for inclusion in the <Perl> sections.
$config_hash = $conftree->as_hash();
$conftree
(Apache::Directive
)
The config tree to stringify
$config_hash
(HASH)
as_string()
Returns a string representation of the configuration tree, in httpd.conf format.
$string = $conftree->as_string();
$conftree
(Apache::Directive
)
The config tree to stringify
$string
(string)
lookup()
Returns node(s) matching a certain value.
$node = $conftree->lookup($directive, $args); @nodes = $conftree->lookup($directive, $args);
$conftree
(Apache::Directive
)
The config tree to stringify
$directive
(string)
args
(string)
$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 $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 $args
argument, this will return only nodes
where both the directive and the args matched. For example:
$VHost = $tree->lookup('VirtualHost', '_default_:8000');
If called with only one $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 $args
argument, this will return only nodes
where both the directive and the args matched:
$VHost = $tree->lookup('VirtualHosts', '_default_:8000');
walk_config
META: Autogenerated - needs to be reviewed/completed
Walk a config tree and setup the server's internal structures
$ret = $conftree->walk_config($cmdparms, $section_vector);
$conftree
(Apache::Directive
)
The config tree to walk
$cmdparms
(Apache::CmdParms
)
The cmd_parms to pass to all functions
$section_vector
(Apache::ConfVector
)
The per-section config vector.
$ret
(string)
Error string on error, undef
otherwise
directive
Returns the name of the directive in $node
.
$name = $node->directive();
$node
(Apache::Directive
)
$directive
(string)
args
The arguments for the current directive, stored as a space separated list
$args = $node->args();
$node
(Apache::Directive
)
$args
(string)
next
The next directive node in the tree
$next_node = $node->next();
$node
(Apache::Directive
)
$next_node
(Apache::Directive
)
Returns the next sibling of $node
, undef
if there is none
first_child
The first child node of this directive
$subtree = $node->first_child;
$node
(Apache::Directive
)
$child_node
(Apache::Directive
)
Returns the first child node of $node
, undef
if there is none
parent
META: Autogenerated - needs to be reviewed/completed
The parent node of this directive
$parent_node = $node->parent();
$node
(Apache::Directive
)
parent_node
(Apache::Directive
)
Returns the parent of $node
, undef
if this node is the root node
data
META: Autogenerated - needs to be reviewed/completed
directive's module can store add'l data here
$ret = $conftree->data($newval);
$conftree
(Apache::Directive
)
$newval
XXX
filename
Returns the filename the configuration node was created from
$filename = $node->filename();
$node
(Apache::Directive
)
$filename
(string)
line_num
Returns the line number in filename
this node was created from
$lineno = $node->line_num();
$node
(Apache::Directive
)
$lineno
(integer)
mod_perl 2.0 and its core modules are copyrighted under The Apache Software License, Version 1.1.
|
![]() |
![]() ![]() ![]() |