NAME
Config::Model::Report - Reports data from config tree
VERSION
version 1.228
SYNOPSIS
use Config::Model ;
# create your config model
my $model = Config::Model -> new ;
$model->create_config_class( ... ) ;
# create instance
my $inst = $model->instance (root_class_name => 'FooBar',
instance_name => 'test1');
# create root of config
my $root = $inst -> config_root ;
# put some data in config tree
my $step = 'std_id:ab X=Bv - std_id:bc X=Av - a_string="toto tata"';
$root->walk( step => $step ) ;
# report only customized data (audit mode)
print $root->audit;
# report all data including default values
print $root->report ;DESCRIPTION
This module is used directly by Config::Model::Node to provide a human readable report of the configuration. This report includes the configuration values and (if provided by the model) the description of the configuration item and their effect.
A report will show all configuration items. An audit will show only configuration items which are different from their default value.
CONSTRUCTOR
new ( )
No parameter. The constructor should be used only by Config::Model::Node.
Methods
report
Returns a string containing the configuration values and (if provided by the model) the description of the configuration item and their effect.
Parameters are:
- audit
-
Set to 1 to report only configuration data different from default values. Default is 0.
- node
-
Reference to the Config::Model::Node object that is dumped. All nodes and leaves attached to this node are also dumped.
AUTHOR
Dominique Dumont, (ddumont at cpan dot org)