debian man page for config::model::backend::yaml

Config::Model::Backend::Yaml(3pm)			User Contributed Perl Documentation			 Config::Model::Backend::Yaml(3pm)

NAME
       Config::Model::Backend::Yaml - Read and write config as a YAML 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',
		   },
	       },
	   ],
	 read_config  => [
			   { backend => 'yaml' ,
			     config_dir => '/tmp',
			     file  => 'foo.yml',
			     auto_create => 1,
			   }
			 ],
	) ;

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

	my $root = $inst->config_root ;

	my $step = 'foo=yada bar="bla bla" baz:en=hello
		    baz:fr=bonjour baz:hr="dobar dan"';
	$root->load( step => $step ) ;
	$inst->write_back ;

       Now, "/tmp/foo.yml" contains:

	---
	bar: bla bla
	baz:
	  en: hello
	  fr: bonjour
	  hr: dobar dan
	foo: yada

DESCRIPTION
       This module is used directly by Config::Model to read or write the content of a configuration tree written with YAML syntax in
       "Config::Model" configuration tree.

       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 ( node => $node_obj, name => 'yaml' ) ;
       Inherited from Config::Model::Backend::Any. The constructor will be called by Config::Model::AutoRead.

   read ( io_handle => ... )
       Of all parameters passed to this read call-back, only "io_handle" is used. This parameter must be IO::File object already opened for read.

       It can also be undef. In this case, "read()" will return 0.

       When a file is read,  "read()" will return 1.

   write ( io_handle => ... )
       Of all parameters passed to this write call-back, only "io_handle" is used. This parameter must be IO::File object already opened for
       write.

       "write()" will return 1.

AUTHOR
       Dominique Dumont, (ddumont at cpan dot org)

SEE ALSO
       Config::Model, Config::Model::AutoRead, Config::Model::Backend::Any,

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