The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Config::Model::Backend::IniFile - Read and write config as a INI file

VERSION

version 1.225

SYNOPSIS

  # model declaration
  name => 'FooConfig',

  read_config  => [
                    { backend => 'IniFile',
                      config_dir => '/etc/foo',
                      file  => 'foo.conf',      # optional
                      auto_create => 1,         # optional
                      comment_delimiter => ';', # optional, default is '#'
                    }
                  ],

   element => ...
  ) ;

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 delimeter. See the example in the SYNOPSIS that sets a semi-column as comment delimeter. By default the comment delimeter 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'.

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 alwritey 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,