Dominique Dumont > Config-Model > Config::Model::DumpAsData

Download:
Config-Model-0.640.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
Report a bug
Module Version: 1.0978   Source  

NAME ^

Config::Model::DumpAsData - Dump configuration content as a perl data structure

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 ;

 my $data =  $root->dump_as_data ;

DESCRIPTION ^

This module is used directly by Config::Model::Node to dump the content of a configuration tree in perl data structure.

The perl data structure is a hash of hash. Only CheckList content will be stored in an array ref.

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

CONSTRUCTOR ^

new ( )

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

Methods ^

dump_as_data(...)

Return a perl data structure

Parameters are:

node

Reference to a Config::Model::Node object. Mandatory

full_dump

Also dump default values in the data structure. Useful if the dumped configuration data will be used by the application. (default is yes)

skip_auto_write

Skip node that have a perl write capabality 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.

AUTHOR ^

Dominique Dumont, (ddumont at cpan dot org)

SEE ALSO ^

Config::Model,Config::Model::Node,Config::Model::ObjTreeScanner