config::model::listid(3pm) [debian man page]

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

NAME

       Config::Model::ListId - Handle list element for configuration model

VERSION

       version 2.021

SYNOPSIS

       See "SYNOPSIS" in Config::Model::AnyId

DESCRIPTION

       This class provides list elements for a Config::Model::Node.

CONSTRUCTOR

       ListId object should not be created directly.

List model declaration
       See model declaration section from Config::Model::AnyId.

Methods
   get_type
       Returns "list".

   fetch_size
       Returns the number of elements of the list.

   load(string, [ check => 'no' ] )
       Store a set of values passed as a comma separated list of values.  Values can be quoted strings. (i.e ""a,a",b" will yield "('a,a', 'b')"
       list).

       "check" can be yes, no or skip

   store_set( ... )
       Store a set of values (passed as list)

       If tinkering with check is required, use the following way :

	store_set ( @v , check => 'skip' );

   move ( from_index, to_index, [ check => 'no' )
       Move an element within the list. "check" can be 'yes' 'no' 'skip'

   push( value1, [ value2 ... ] )
       push some values at the end of the list.

   push_x ( values => [ v1','v2', ...] , [ ... ] )
       Like push with extended options. Options are:

       check
	   Check value validaty. Either "yes" (default), "no", "skip"

       values
	   Values to push (array_ref)

       value
	   Single value to push

       annotation

   store
       Equivalent to push_x. This method is provided to help write configuration parser, so the call is the same when dealing with leaf or list
       values. Prefer "push_x" when practical.

       check
	   "yes", "no" or "skip"

       annotation
	   list ref of annotation to store with the list values

       Example:

	$elt->push_x (
	   values => [ v1','v2' ] ,
	   annotation => [ 'v1 comment', 'v2 comment' ],
	   check => ''skip'
	);

   swap ( "ida" , "idb" )
       Swap 2 elements within the array

   remove ( "idx" )
       Remove an element from the list. Equivalent to "splice @list,$idx,1"

   load_data ( array_ref | data )
       Clear and load list from data contained in the array ref. If a scalar or a hash ref is passed, the list is cleared and the data is stored
       in the first element of the list.

AUTHOR

       Dominique Dumont, (ddumont at cpan dot org)

SEE ALSO

       Config::Model::Model, Config::Model::Instance, Config::Model::AnyId, Config::Model::HashId, Config::Model::Value

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

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

NAME

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

VERSION

       version 2.021

SYNOPSIS

	use Config::Model ;
	use Log::Log4perl qw(:easy) ;
	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 ) ;

	# dump only customized data
	print $root->dump_tree;

DESCRIPTION

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

       The serialization 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

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