NAME

Apache::Config::Preproc::Expand - base class for preprocessor modules

DESCRIPTION

CONSTRUCTOR

    $obj = new($conf, ...)

The only required argument to the constructor is a reference to the Apache::Config::Preproc object which controls the preprocessing. The default constructor saves this reference in the object and makes it available via the conf method. Rest of arguments are specific for each particular expansion and are ignored by the default constructor.

METHODS

conf

Returns the Apache::Config::Preproc object which controls the preprocessing. The module can use it in order to inspect the configuration parse tree.

begin_section

    $obj->begin_section($section);

Invoked before running preprocessor expansions on a section. The section (an instance of Apache::Admin::Config::Tree or a derived class) is passed as the argument.

Default implementation is a no-op.

end_section

    $obj->end_section($section);

Invoked when all preprocessor expansions are finished for a section. The section (an instance of Apache::Admin::Config::Tree or a derived class) is passed as the argument.

Default implementation is a no-op.

expand

    $result = $obj->expand($node, \@items);

Expands the configuration tree node $node, places the resulting nodes to @items and returns true. Returns false if no expansion was done on the node.