Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Config::Model::DumpAsDUser3Contributed Perl DocumeConfig::Model::DumpAsData(3)

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

VERSION
       version 2.140

SYNOPSIS
	use Config::Model ;
	use Data::Dumper ;

	# 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 $steps = 'baz:fr=bonjour baz:hr="dobar dan"';
	$root->load( steps => $steps ) ;

	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 is
       stored in an array ref.

       User can	pass a sub reference to	apply to values	of boolean type. This
       sub can be used to convert the value to an object representing a
       boolean like boolean. (since 2.129)

       Note that undefined values are skipped for list element.	I.e. if	a list
       element contains	"('a',undef,'b')", the data structure then contains
       '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 is	used by	the application. This
	   parameter is	deprecated in favor of mode parameter.

       mode
	   Note	that "mode" parameter is also accepted and overrides
	   "full_dump" parameter. See "fetch" in Config::Model::Value for
	   details on "mode".

       skip_auto_write
	   Skip	node that have a "perl write" capability in their model. See
	   Config::Model::BackendMgr.

	   This	option must be used when using DumpAsData: to write back
	   configuration data. When a configuration model contains several
	   backends (one at the	tree root and others in	tree nodes), setting
	   this	option ensure that the "root" configuration file does not
	   contain data	duplicated in configuration file of others tree	nodes.

       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:

	     my_hash =>	[ 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.:

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

       to_boolean
	   Sub reference to map	a value	of type	boolean	to a boolean class
	   (since 2.129). For instance:

	    to_boolean => sub {	boolean($_[0]);	}

	   Default is "sub { return $_[0] }"

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

       check_list
	   Yes,	no or skip

AUTHOR
       Dominique Dumont, (ddumont at cpan dot org)

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

AUTHOR
       Dominique Dumont

COPYRIGHT AND LICENSE
       This software is	Copyright (c) 2005-2020	by Dominique Dumont.

       This is free software, licensed under:

	 The GNU Lesser	General	Public License,	Version	2.1, February 1999

perl v5.32.0			  2020-08-28	  Config::Model::DumpAsData(3)

NAME | VERSION | SYNOPSIS | DESCRIPTION | CONSTRUCTOR | Methods | Methods | AUTHOR | SEE ALSO | AUTHOR | COPYRIGHT AND LICENSE

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Config::Model::DumpAsData&sektion=3&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help