# PODNAME: Config::Model::models::Itself::ConfigRead
# ABSTRACT:  Configuration class Itself::ConfigRead

=encoding utf8

=head1 NAME

Config::Model::models::Itself::ConfigRead - Configuration class Itself::ConfigRead

=head1 DESCRIPTION

Configuration classes used by L<Config::Model>

=head1 Elements

=head2 backend

specifies the backend to store permanently configuration data. I< Optional. Type enum. choice: 'cds_file', 'perl_file', 'custom'.  > 

Here are some explanations on the possible values:

=over

=item 'IniFile'

Ini file format. Beware that the structure of your model must match the limitations of the INI file format, i.e only a 2 levels hierarchy. Configuration filename is made with instance name

=item 'cds_file'

file with config data string. This is Config::Model own serialisation format, designed to be compact and readable. Configuration filename is made with instance name

=item 'custom'

deprecated

=item 'perl_file'

file with a perl data structure. Configuration filename is made with instance name

=back



=head2 config_dir

I< Optional. Type uniline.  > 

=head2 os_config_dir - configuration file directory for specific OS

Specify and alternate location of a configuration directory depending on the OS (as returned by C<$^O> or C<$Config{'osname'}>, see L<perlport/PLATFORMS>) Common values for C<$^O> are 'linux', 'MSWin32', 'darwin' I< Optional. Type hash of uniline.  > 

=head2 file - target configuration file name

specify the configuration file name. This parameter may not be applicable depending on your application. It may also be hardcoded in a custom backend. If not specified, the instance name is used as base name for your configuration file. The configuration file namecan be specified with &index keyword when a backend is associated to a node contained in a hash. See L<backend specifications|http://search.cpan.org/dist/Config-Model/lib/Config/Model/BackendMgr.pm#Backend_specification>. I< Optional. Type uniline.  > 

=head2 auto_create - Creates configuration files as needed

I< Optional. Type boolean.  > 

=over 4

=item upstream_default value :

0

=back



=head2 yaml_class

Specify the YAML class that is used to load and dump YAML files. Defaults to L<YAML::Tiny>. See L<yaml_class doc|Config::Model::Backend::Yaml/yaml_class> for details on  why another YAML class can suit your configuration file needs. I< Optional. Type uniline.  > 

=over 4

=item upstream_default value :

YAML::Tiny

=back



=head2 file_mode - configuration file mode

specify the configuration file mode. C<file_mode> parameter can be used to set the mode of the written file. C<file_mode> value can be in any form supported by L<Path::Tiny/chmod>. I< Optional. Type uniline.  > 

=head2 default_layer - How to find default values in a global config file

Specifies where to find a global configuration file that specifies default values. For instance, this is used by OpenSSH to specify a global configuration file (C</etc/ssh/ssh_config>) that is overridden by user's file. I< Optional. Type node of class L<Itself::ConfigReadWrite::DefaultLayer|Config::Model::models::Itself::ConfigReadWrite::DefaultLayer> .  > 

=head2 class

I< Optional. Type uniline.  > 

=head2 store_class_in_hash

Specify element hash name that contains all INI classes. See L<Config::Model::Backend::IniFile/"Arbitrary class name"> I< Optional. Type uniline.  > 

=head2 section_map

Specify element name that contains one INI class. E.g. to store INI class [foo] in element Foo, specify { foo => "Foo" } I< Optional. Type hash of uniline.  > 

=head2 split_list_value

Regexp to split the value read from ini file. Usually "\s+" or "[,\s]" I< Optional. Type uniline.  > 

=head2 split_check_list_value

Regexp to split the value read from ini file. Usually "\s+" or "[,\s]" I< Optional. Type uniline.  > 

=head2 assign_char

Character used to assign value in INI file. Default is C<=>. See L<details|Config::Model::Backend::IniFile/"Handle key value files"> I< Optional. Type uniline.  > 

=over 4

=item upstream_default value :

#

=back



=head2 assign_with

String used write assignment in INI file. Default is "C< = >". See L<details|Config::Model::Backend::IniFile/"Handle key value files"> I< Optional. Type uniline.  > 

=over 4

=item upstream_default value :

#

=back



=head2 join_list_value

string to join list values before writing the entry in ini file. Usually " " or ", " I< Optional. Type uniline.  > 

=head2 join_check_list_value

string to join checked items names before writing the entry in the ini file. Usually " " or ", " I< Optional. Type uniline.  > 

=head2 write_boolean_as

Specify how to write a boolean value in config file. Suggested values are "no","yes". I< Optional. Type list of uniline.  > 

=head2 force_lc_section

force section to be lowercase. I< Optional. Type boolean.  > 

=over 4

=item upstream_default value :

0

=back



=head2 force_lc_key

force key names to be lowercase. I< Optional. Type boolean.  > 

=over 4

=item upstream_default value :

0

=back



=head2 force_lc_value

force values to be lowercase. I< Optional. Type boolean.  > 

=over 4

=item upstream_default value :

0

=back



=head2 full_dump

Also dump default values in the data structure. Useful if the dumped configuration data will be used by the application. (default is yes) I< Optional. Type boolean.  > 

=over 4

=item upstream_default value :

1

=back



=head2 comment_delimiter

list of characters that start a comment. When more that one character is used. the first one is used to write back comment. For instance, value "#;" indicate that a comments can start with "#" or ";" and that all comments are written back with "#". I< Optional. Type uniline.  > 

=over 4

=item upstream_default value :

#

=back



=head2 auto_delete - Delete empty configuration file

Delete configuration files when no information is left in there. This may happen when data is removed by user. This is mostly useful when the  configuration of an application is made of several files. I< Optional. Type boolean.  > 

=over 4

=item upstream_default value :

0

=back



=head2 function

I< Optional. Type uniline.  > 

=head1 SEE ALSO

=over

=item *

L<cme>

=item *

L<Config::Model::models::Itself::ConfigReadWrite::DefaultLayer>

=back

=cut

