Config::Model::DumpAsData man page on Pidora

Man page or keyword search:  
man Server   31170 pages
apropos Keyword Search (all sections)
Output format
Pidora logo
[printable version]

Config::Model::DumpAsDUser3Contributed Perl DocumeConfig::Model::DumpAsData(3)

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

VERSION
       version 1.235

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'
	     }

AUTHOR
       Dominique Dumont, (ddumont at cpan dot org)

SEE ALSO
       Config::Model,Config::Model::Node,Config::Model::ObjTreeScanner

perl v5.14.1			  2011-07-22	  Config::Model::DumpAsData(3)
[top]

List of man pages available for Pidora

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net