Config::Model::Report(3pm)

1Config::Model::Report(3U)ser Contributed Perl DocumentatiCoonnfig::Model::Report(3)
2
3
4

NAME

6       Config::Model::Report - Reports data from config tree
7

VERSION

9       version 1.205
10

SYNOPSIS

12        use Config::Model ;
13
14        # create your config model
15        my $model = Config::Model -> new ;
16        $model->create_config_class( ... ) ;
17
18        # create instance
19        my $inst = $model->instance (root_class_name => 'FooBar',
20                                     instance_name => 'test1');
21
22        # create root of config
23        my $root = $inst -> config_root ;
24
25        # put some data in config tree
26        my $step = 'std_id:ab X=Bv - std_id:bc X=Av - a_string="toto tata"';
27        $root->walk( step => $step ) ;
28
29        # report only customized data (audit mode)
30        print $root->audit;
31
32        # report all data including default values
33        print $root->report ;
34

DESCRIPTION

36       This module is used directly by Config::Model::Node to provide a human
37       readable report of the configuration. This report includes the
38       configuration values and (if provided by the model) the description of
39       the configuration item and their effect.
40
41       A "report" will show "all" configuration items. An "audit" will show
42       only configuration items which are different from their default value.
43

CONSTRUCTOR

45   new ( )
46       No parameter. The constructor should be used only by
47       Config::Model::Node.
48

Methods

50   report
51       Returns a string containing the configuration values and (if provided
52       by the model) the description of the configuration item and their
53       effect.
54
55       Parameters are:
56
57       audit
58           Set to 1 to report only configuration data different from default
59           values. Default is 0.
60
61       node
62           Reference to the Config::Model::Node object that is dumped. All
63           nodes and leaves attached to this node are also dumped.
64

AUTHOR

66       Dominique Dumont, (ddumont at cpan dot org)
67