Config::Model::BackendUseriContributed Perl Config::Model::Backend::IniFile(3)NAMEConfig::Model::Backend::IniFile - Read and write config as a INI file
VERSION
version 1.235
SYNOPSIS
use Config::Model;
use Log::Log4perl qw(:easy);
Log::Log4perl->easy_init($WARN);
my $model = Config::Model->new;
$model->create_config_class (
name => "IniClass",
element => [
[qw/foo bar/] => {
type => 'list',
cargo => {qw/type leaf value_type string/}
}
]
);
# model for free INI class name and constrained class parameters
$model->create_config_class(
name => "MyClass",
element => [
'ini_class' => {
type => 'hash',
index_type => 'string',
cargo => {
type => 'node',
config_class_name => 'IniClass'
},
},
],
read_config => [
{
backend => 'IniFile',
config_dir => '/tmp',
file => 'foo.conf',
store_class_in_hash => 'ini_class',
auto_create => 1,
}
],
);
my $inst = $model->instance(root_class_name => 'MyClass' );
my $root = $inst->config_root ;
$root->load('ini_class:ONE foo=FOO1 bar=BAR1 -
ini_class:TWO foo=FOO2' );
$inst->write_back ;
Now "/tmp/foo.conf" will contain:
## file written by Config::Model
[ONE]
foo=FOO1
bar=BAR1
[TWO]
foo=FOO2
DESCRIPTION
This module is used directly by Config::Model to read or write the
content of a configuration tree written with INI syntax in
"Config::Model" configuration tree.
This INI file can have arbitrary comment delimiter. See the example in
the SYNOPSIS that sets a semi-column as comment delimiter. By default
the comment delimiter is '#' like in Shell or Perl.
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'.
Comments
This backend tries to read and write comments from configuration file.
The comments are stored as annotation within the configuration tree.
Bear in mind that comments extraction is based on best estimation as to
which parameter the comment may apply. Wrong estimations are possible.
CONSTRUCTOR
new ( node => $node_obj, name => 'shellvar' ) ;
Inherited from Config::Model::Backend::Any. The constructor will be
called by Config::Model::AutoRead.
The constructor will be passed the optional parameters declared in the
model:
comment_delimiter
Change the character that starts comments in the INI file. Default
is '"#"'.
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); Krzysztof Tyszecki,
(krzysztof.tyszecki at gmail dot com)
SEE ALSO
Config::Model, Config::Model::AutoRead, Config::Model::Backend::Any,
perl v5.14.12011-07-22Config::Model::Backend::IniFile(3)
