NAME

Config::Model::Instance - Instance of configuration tree

SYNOPSIS

 my $model = Config::Model->new() ;
 $model ->create_config_class ( ... ) ;

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

DESCRIPTION

This module provides an object that holds a configuration tree.

CONSTRUCTOR

An instance object is created by calling instance method on an existing model:

 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 any of these parameters :

read_root_dir

Pseudo root directory where to read the configuration files

write_root_dir

Pseudo root directory where to write back the configuration files

root_dir

Pseudo root directory where to read and write configuration files

backend

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

Note that all directory specified within the configuration model will be overridden.

I.e with write_root_dir => '~/mytest/, data read from /etc/foo.conf will be written back in ~/mytest/etc/foo.conf.

If you need to load configuration data that are not correct, you can use force_load => 1. Then, wrong data will be discarded.

METHODS

name()

Returns the instance name.

config_root()

Returns the root object of the configuration tree.

reset_config

Destroy current configuration tree (with data) and returns a new tree with data loaded from disk.

config_model()

Returns the model of the configuration tree.

preset_start ()

All values stored in preset mode are shown to the user as default values. This feature is usefull to enter configuration data entered by an automatic process (like hardware scan)

preset_stop ()

Stop preset mode

preset ()

Get preset mode

push_no_value_check ( fetch | store | type , ... )

Tune Config::Model::Value to perform check on read (fetch) or write (store) or verify the value according to its value_type. The passed parameters are stacked. Parameters are :

store

Skip write check.

fetch

Skip read check.

type

Skip value_type check (See Config::Model::Value for details). I.e Config::Model::Value will not enforce type checking.

Note that these values are stacked. They can be read by get_value_check until the next push_no_value_check or pop_no_value_check call.

Example:

  $i->push_no_value_check('fetch') ;
  $i->push_no_value_check('fetch','type') ;

pop_no_value_check()

Pop off the check stack the last check set entered with push_no_value_check.

get_value_check ( fetch | store | type | fetch_or_store | fetch_and_store )

Read the check status. Returns 1 if a check is to be done. O if not. When used with the fetch_or_store parameter, returns a logical or or the check values, i.e. read_check || write_check

data( kind, [data] )

The data method provide a way to store some arbitrary data in the instance object.

load( "..." )

Load configuration tree with configuration data. See Config::Model::Loader for more details

searcher ( )

Returns an object dedicated to search an element in the configuration model (respecting privilege level).

This method returns a Config::Model::Searcher object. See Config::Model::Searcher for details on how to handle a search.

wizard_helper ( ... )

This method returns a Config::Model::WizardHelper object. See Config::Model::WizardHelper for details on how to create a wizard widget with this object.

wizard_helper arguments are explained in Config::Model::WizardHelper constructor arguments.

Auto read and write feature

Usually, a program based on config model must first create the configuration model, then load all configuration data.

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

read_root_dir()

Returns root directory where configuration data is read from.

backend()

Get the preferred backend method for this instance (as passed to the constructor).

write_root_dir()

Returns root directory where configuration data is written to.

register_write_back ( backend_name, sub_ref )

Register a sub ref (with the backend name) that will be called with write_back method.

write_back ( ... )

Try to run all subroutines registered with register_write_back to write the configuration informations until one succeeds (returns true). (See Config::Model::AutoRead for details).

You can specify here a pseudo root dir or another config dir to write configuration data back with root and config_dir parameters. This will override the model specifications.

You can force to use a backend by specifying backend => xxx. For instance, backend => 'augeas' or backend => 'custom'.

You can force to use all backend to write the files by specifying backend => 'all'.

AUTHOR

Dominique Dumont, (ddumont at cpan dot org)

SEE ALSO

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

cpanm Config::Model

perl -MCPAN -e shell
install Config::Model