GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  CONFIG::MODEL::BACKEND::YAML (3)

.ds Aq ’

NAME

Config::Model::Backend::Yaml - Read and write config as a YAML data structure

CONTENTS

VERSION

version 2.082

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,
            },
        },
    ],
  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:
o Undefined values are skipped for list element. I.e. if a list element contains (a,undef,b), the data structure will contain a,b.
o YAML file is not created (and may be deleted) when no data is to be written.

    Class with only one hash element

If the root node contains a single hash or list element, only the content of this hash will be written in YAML file.

For example, if a class contains:



      element => [
        baz => {
            type => hash,
            index_type => string ,
            cargo => {
                type => leaf,
                value_type => string,
            },
        },



If the configuration is loaded with:



 $root->load("baz:one=un baz:two=deux")



Then the written YAML file will <B>notB> show baz:



 ---
 one: un
 two: deux



Likewise, a YAML file for a class with a single list baz element would be written with:



 ---
 - un
 - deux



CONSTRUCTOR

new ( node => CW$node_obj, name => ’yaml’ ) ;

Inherited from Config::Model::Backend::Any. The constructor will be called by Config::Model::BackendMgr.

    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::BackendMgr, Config::Model::Backend::Any,

AUTHOR

Dominique Dumont

COPYRIGHT AND LICENSE

This software is Copyright (c) 2005-2016 by Dominique Dumont.

This is free software, licensed under:



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



Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 CONFIG::MODEL::BACKEND::YAML (3) 2016-04-03

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.