logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

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

Description

       Configuration classes used by Config::Model

Elements

backend
       specifies the backend to store permanently configuration data.  Optional.Typeenum.choice:'cds_file','perl_file','custom'.

       Here are some explanations on the possible values:

       '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

       '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

       'custom'
           deprecated

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

   config_dirOptional.Typeuniline.os_config_dir-configurationfiledirectoryforspecificOS
       Specify  and  alternate  location of a configuration directory depending on the OS (as returned by $^O or
       $Config{'osname'}, see "PLATFORMS" in perlport) Common values for $^O are  'linux',  'MSWin32',  'darwin'
       Optional.Typehashofuniline.file-targetconfigurationfilename
       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() or &element
       function.         See         backend         specifications         <http://search.cpan.org/dist/Config-
       Model/lib/Config/Model/BackendMgr.pm#Backend_specification>   and   Config::Model::Role::ComputeFunction.
       Optional.Typeuniline.functionDeprecatedOptional.Typeuniline.auto_create-CreatesconfigurationfilesasneededOptional.Typeboolean.

       upstream_default value :
           0

   yaml_class
       Specify the YAML class that is used to load and dump YAML files. Defaults to YAML::Tiny.  See  yaml_class
       doc  for  details  on   why  another  YAML  class can suit your configuration file needs.  Optional.Typeuniline.

       upstream_default value :
           YAML::Tiny

   file_mode-configurationfilemode
       specify the configuration file mode. "file_mode" parameter can be used to set the  mode  of  the  written
       file. "file_mode" value can be in any form supported by "chmod" in Path::Tiny.  Optional.Typeuniline.default_layer-Howtofinddefaultvaluesinaglobalconfigfile
       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  ("/etc/ssh/ssh_config")  that  is  overridden  by
       user's file.  Optional.TypenodeofclassItself::ConfigReadWrite::DefaultLayer.classOptional.Typeuniline.store_class_in_hash
       Specify   element   hash   name   that   contains   all  INI  classes.  See  "Arbitrary  class  name"  in
       Config::Model::Backend::IniFile  Optional.Typeuniline.section_map
       Specify element name that contains one INI class. E.g. to store INI class [foo] in element Foo, specify {
       foo => "Foo" }  Optional.Typehashofuniline.split_list_value
       Regexp to split the value read from ini file. Usually "\s+" or "[,\s]"  Optional.Typeuniline.split_check_list_value
       Regexp to split the value read from ini file. Usually "\s+" or "[,\s]"  Optional.Typeuniline.assign_char
       Character used to assign value in INI file. Default is "=". See details  Optional.Typeuniline.

       upstream_default value :
           #

   assign_with
       String used write assignment in INI file. Default is "" = "". See details  Optional.Typeuniline.

       upstream_default value :
           #

   join_list_value
       string to join list values before writing the entry in ini file. Usually " "  or  ",  "   Optional.Typeuniline.join_check_list_value
       string  to  join  checked  items  names  before  writing  the  entry in the ini file. Usually " " or ", "
       Optional.Typeuniline.write_boolean_as
       Specify how to write a boolean value in config file. Suggested values  are  "no","yes".   Optional.Typelistofuniline.force_lc_section
       force section to be lowercase.  Optional.Typeboolean.

       upstream_default value :
           0

   force_lc_key
       force key names to be lowercase.  Optional.Typeboolean.

       upstream_default value :
           0

   force_lc_value
       force values to be lowercase.  Optional.Typeboolean.

       upstream_default value :
           0

   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)  Optional.Typeboolean.

       upstream_default value :
           1

   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 "#".  Optional.Typeuniline.

       upstream_default value :
           #

   quote_value
       Specify how to handle quoted values. By default, quoted values are left as is. With "shell_style",  value
       are  parsed  and unquoted like in a shell. Values containing a space are written back with double quotes.
       Optional.Typeenum.choice:'shell_style'.auto_delete-Deleteemptyconfigurationfile
       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.
       Optional.Typeboolean.

       upstream_default value :
           0

Name

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

See Also

       •   cme

       •   Config::Model::models::Itself::ConfigReadWrite::DefaultLayer

perl v5.40.1                                       2025-04-06             Config::Model::...ConfigReadWrite(3pm)

See Also