Config::Model::Dumper(3pm)

NAME
Config::Model::Dumper - Serialize data of config tree

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 ) ;

 # dump only customized data (audit mode)
 print $root->dump_tree;

 # dump all data including default values
 print $root->dump_tree( full_dump => 1 ) ;

DESCRIPTION
This module is used directly by Config::Model::Node to serialize configuration data in a compact (but readable) string.

The serialisation can be done in standard mode where only customized values are dumped in the string. I.e. only data modified by the user are dumped.

The other mode is "full_dump" mode where all all data, including default values, are dumped.

The serialized string can be used by Config::Model::Walker to store the data back into a configuration tree.

Note that undefined values are skipped for list element. I.e. if a list element contains "('a',undef,'b')", the dump will contain 'a','b'.

CONSTRUCTOR

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

Methods

  dump_tree
Return a string that contains a dump of the object tree with all the values. This string follows the convention defined by Config::Model::Walker.

The serialized string can be used by Config::Model::Walker to store the data back into a configuration tree.

Parameters are:

mode ( full | preset | custom )
    "full" will dump all configuration data including default values.

    "preset" will dump only value entered in preset mode.

    By default, the dump contains only data modified by the user (i.e. "custom" data that differ from default or preset values).

node
    Reference to the Config::Model::Node object that is dumped. All nodes and leaves attached to this node are also dumped.

skip_auto_write ( <backend_name> )
    Skip node that have a write capability matching "backend_name" in their model. See Config::Model::AutoRead.

auto_vivify
    Scan and create data for nodes elements even if no actual data was stored in them. This may be useful to trap missing mandatory values. (default: 0)

experience ( ... )
    Restrict dump to "beginner" or "intermediate" parameters. Default is to dump all parameters ("master" level)

check
    Check value before dumping. Valid check are 'yes', 'no' and 'skip'.

AUTHOR
Dominique Dumont, (ddumont at cpan dot org)

SEE ALSO
Config::Model,Config::Model::Node,Config::Model::Walker