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::ANNOTATION (3)

.ds Aq ’

NAME

Config::Model::Annotation - Read and write configuration annotations

CONTENTS

VERSION

version 2.082

SYNOPSIS



 use Config::Model ;

 # 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(baz)->fetch_with_id(en)->store(hello) ;

 # put annotation the hard way
 $root->fetch_element(foo)->annotation(english) ;
 $root->fetch_element(baz)->fetch_with_id(en)->annotation(also english) ;

 # put more data the easy way
 my $step = baz:fr=bonjour#french baz:hr="dobar dan"#croatian;
 $root->load( step => $step ) ;

 # dump resulting tree with annotations
 print $root->dump_tree;

 # save annotations
 my $annotate_saver = Config::Model::Annotation
  -> new (
          config_class_name => MyClass,
          instance => $inst ,
          root_dir => /tmp/, # for test
         ) ;
 $annotate_saver->save ;

 # now check content of /tmp/config-model/MyClass-note.pl



DESCRIPTION

This module provides an object that read and write annotations (a bit like comments) to and from a configuration tree and save them in a file (not configuration file)

Depending on the effective id of the process, the annotation will be saved in:
o /var/lib/config-model/<model_name>-note.yml for root (EUID == 0)
o ~/.config-model/<model_name>-note.yml for normal user (EUID > 0)

CONSTRUCTOR

Quite standard. The constructor is passed a Config::Model::Instance object.

METHODS

save()

Save annotations in a file (See DESCRIPTION)

load()

Loads annotations from a file (See DESCRIPTION)

AUTHOR

Dominique Dumont, (ddumont at cpan dot org)

SEE ALSO

Config::Model, Config::Model::Node, Config::Model::Loader, Config::Model::Searcher, Config::Model::Value,

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::ANNOTATION (3) 2016-04-03

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