Config::Model::DumpAsData(3pm)				User Contributed Perl Documentation			    Config::Model::DumpAsData(3pm)

NAME

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

VERSION

       version 2.021

SYNOPSIS

	use Config::Model ;
	use Log::Log4perl qw(:easy) ;
	use Data::Dumper ;

	Log::Log4perl->easy_init($WARN);

	# define configuration tree object
	my $model = Config::Model->new ;
	$model ->create_config_class (
	   name => "MyClass",
	   element => [
	       [qw/foo bar/] => {
		   type => 'leaf',
		   value_type => 'string'
	       },
	       baz => {
		   type => 'hash',
		   index_type => 'string' ,
		   cargo => {
		       type => 'leaf',
		       value_type => 'string',
		   },
	       },

	   ],
	) ;

	my $inst = $model->instance(root_class_name => 'MyClass' );

	my $root = $inst->config_root ;

	# put some data in config tree the hard way
	$root->fetch_element('foo')->store('yada') ;
	$root->fetch_element('bar')->store('bla bla') ;
	$root->fetch_element('baz')->fetch_with_id('en')->store('hello') ;

	# put more data the easy way
	my $step = 'baz:fr=bonjour baz:hr="dobar dan"';
	$root->load( step => $step ) ;

	print Dumper($root->dump_as_data);
	# $VAR1 = {
	#	  'bar' => 'bla bla',
	#	  'baz' => {
	#		     'en' => 'hello',
	#		     'fr' => 'bonjour',
	#		     'hr' => 'dobar dan'
	#		   },
	#	  'foo' => 'yada'
	#	};

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" capability 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.

       ordered_hash_as_list
	   By default, ordered hash (i.e. the order of the keys are important) are dumped as Perl list. This is the faster way to dump such hashed
	   while keeping the key order. But it's the less readable way.

	   When this parameter is 1 (default), the ordered hash is dumped as a list:

	     [ A => 'foo', B => 'bar', C => 'baz' ]

	   When this parameter is set as 0, the ordered hash is dumped with a special key that specifies the order of keys. E.g.:

	     { __order => [ 'A', 'B', 'C' ] ,
	       B => 'bar', A => 'foo', C => 'baz'
	     }

Methods
   dump_annotations_as_pod(...)
       Return a string formatted in pod (See perlpod) with the annotations.

       Parameters are:

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

       experience
	   master, advanced or beginner

       check_list
	   Yes, no or skip

AUTHOR

       Dominique Dumont, (ddumont at cpan dot org)

SEE ALSO

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

perl v5.14.2							    2012-11-09					    Config::Model::DumpAsData(3pm)