Structure¶

Structure of the Config::Model must be very simple. Either:

• A single class with hash of leaves elements.
• 2 levels of classes. The top level has nodes elements. All other classes have only leaf elements.

new¶

Parameters: "( node => $node_obj, name => 'inifile' )"

Inherited from Config::Model::Backend::Any. The constructor is called by Config::Model::BackendMgr.

comment_delimiter¶

Change the character that starts comments in the INI file. Default is '"#"'.

Some Ini files allows comments to begin with several characters (e.g. "#" or ";"). In this case, set "comment_delimiter" to the possible characters (e.g ""#;""). The first character is used to write back comments. (In the example above, comment "; blah" is written back as "# blah".

store_class_in_hash¶

See "Arbitrary class name"

section_map¶

Is a kind of exception of the above rule. See also "Arbitrary class name"

force_lc_section¶

Boolean. When set, sections names are converted to lowercase.

force_lc_key¶

Idem for key name

force_lc_value¶

Idem for all values.

split_list_value¶

Some INI values are in fact a list of items separated by a space or a comma. This parameter specifies the regex to use to split the value into a list. This applies only to "list" elements.

join_list_value¶

Conversely, the list element split with "split_list_value" needs to be written back with a string to join them. Specify this string (usually ' ' or ', ') with "join_list_value".

split_check_list_value¶

Some INI values are in fact a check list of items separated by a space or a comma. This parameter specifies the regex to use to split the value read from the file into a list of items to check. This applies only to "check_list" elements.

join_check_list_value¶

Conversely, the check_list element split with "split_list_value" needs to be written back with a string to join them. Specify this string (usually ' ' or ', ') with "join_check_list_value".

write_boolean_as¶

Array ref. Reserved for boolean value. Specify how to write a boolean value. Default is "[0,1]" which may not be the most readable. "write_boolean_as" can be specified as "['false','true']" or "['no','yes']".

assign_char¶

Character used to assign value in INI file. Default is "=".

assign_with¶

String used write assignment in INI file. Default is "" = "".

quote_value¶

How to quote value in INI file. Currrently only "shell_style" is supported for "quote_value".

E.g. INI backend declaration can contain this parameter:

   quote_value => 'shell_style'

Here are some example of quoted values. The 3 columns shows the original value in file, how it's stored internally and how it's written back:

   # read    => shown   => write
   "foo"     => foo     => "foo"
   "foo bar" => foo bar => "foo bar"
   "20"x"4"  => 20x4    => "20x4"

Imposed class name¶

In this case, the class names must match what is expected by the application. The elements of each class can be different. For instance:

  foo = foo_v
  [ A ]
  bar = bar_v
  [ B ]
  baz = baz_v

In this case, class "A" and class "B" do not use the same configuration class.

The model has this structure:

 Root class 
 |- leaf element foo
 |- node element A of class_A
 |  \- leaf element bar
 \- node element B of class_B
    \-  leaf element baz

Arbitrary class name¶

In this case, the class names can be chosen by the end user. Each class has the same elements. For instance:

  foo = foo_v
  [ A ]
  bar = bar_v1
  [ B ]
  bar = bar_v2

In this case, class "A" and class "B" do not use the same configuration class. The model has this structure:

 Root class 
 |- leaf foo
 \- hash element my_class_holder
    |- key A (value is node of class_A)
    |  \- element-bar
    \- key B (value is node of class_A)
       \- element-bar

In this case, the "my_class_holder" name is specified in "rw_config" with "store_class_in_hash" parameter:

    rw_config  => {
      backend => 'IniFile',
      config_dir => '/tmp',
      file  => 'foo.ini',
      store_class_in_hash => 'my_class_holder',
    }

Of course they are exceptions. For instance, in "Multistrap", the "[General]" INI class must be mapped to a specific node object. This can be specified with the "section_map" parameter:

    rw_config  => }
       backend => 'IniFile',
       config_dir => '/tmp',
       file  => 'foo.ini',
       store_class_in_hash => 'my_class_holder',
       section_map => {
           General => 'general_node',
       }
    }

"section_map" can also map an INI class to the root node:

    rw_config => {
      backend => 'ini_file',
      store_class_in_hash => 'sections',
      section_map => {
          General => '!'
      },
    }

read¶

Of all parameters passed to this read call-back, only "file_path" is used. This parameter must be Path::Tiny object.

It can also be undef. In this case, "read" returns 0.

When a file is read, "read" returns 1.

write¶

Of all parameters passed to this write call-back, only "file_path" is used. This parameter must be a Path::Tiny object.

"write" returns 1.