NAME

VERSION

SYNOPSIS

 use Config::Model;
 use File::Path ;

 # setup a dummy popcon conf file
 my $wr_dir = '/tmp/etc/';
 my $conf_file = "$wr_dir/popularity-contest.conf" ;

 unless (-d $wr_dir) {
     mkpath($wr_dir, { mode => 0755 }) 
       || die "can't mkpath $wr_dir: $!";
 }
 open(my $conf,"> $conf_file" ) || die "can't open $conf_file: $!";
 $conf->print( qq!MY_HOSTID="aaaaaaaaaaaaaaaaaaaa"\n!,
   qq!PARTICIPATE="yes"\n!,
   qq!USEHTTP="yes" # always http\n!,
   qq!DAY="6"\n!);
 $conf->close ;

 my $model = Config::Model->new;

 # PopCon model is provided. Create a new Config::Model::Instance object
 my $inst = $model->instance (root_class_name   => 'PopCon',
                              root_dir          => '/tmp',
                             );
 my $root = $inst -> config_root ;

 print $root->describe;

DESCRIPTION

CONSTRUCTOR

 my $inst = $model->instance (
   # run 'cme list' to get list of applications
   application => 'foo',
   # optional
   instance_name => 'test1'
 );

 my $inst = $model->instance (
   root_class_name => 'SomeRootClass',
   instance_name => 'test1'
 );

The directory (or directories) holding configuration files is specified within the configuration model. For test purpose you can change the "root" directory with "root_dir" parameter.

Constructor parameters are:

root_dir

Pseudo root directory where to read and write configuration files (Path::Tiny object or string). Configuration directory specified in model or with "config_dir" option is appended to this root directory

root_path

Path::Tiny object created with "root_dir" value or with current directory if "root_dir" is empty.

config_dir

Directory to read or write configuration file. This parameter must be supplied if not provided by the configuration model. (string)

backend

Specify which backend to use. See "write_back" for details

backend_arg

Specify a backend argument that may be retrieved by some backend. Instance is used as a relay and does not use this data.

check

Specify whether to check value while reading config files. Either:

canonical

When true: write config data back using model order. By default, write items back using the order found in the configuration file. This feature is experimental and not supported by all backends.

on_change_cb

Call back this function whenever "notify_change" is called. Called with arguments: "name => <root node element name>, index => <index_value>"

on_message_cb

Call back this function when show_message is called. By default, messages are displayed on STDOUT.

error_paths

Returns a list of tree items that currently have an error.

error_messages

Returns a list of error messages from the tree content.

Note that the root directory specified within the configuration model is overridden by "root_dir" parameter.

If you need to load configuration data that are not correct, you can use "force_load => 1". Then, wrong data are discarded (equivalent to "check => 'no'" ).

METHODS

Internal methods

  $instance->data(foo => 'bar');

  my $foo = $instance->data('foo'); # $foo contains 'bar'

Read and write backend features

This feature enables you to declare with the model a way to load configuration data (and to write it back). See Config::Model::BackendMgr for details.

AUTHOR

SEE ALSO

AUTHOR

COPYRIGHT AND LICENSE

This is free software, licensed under:

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