NAME
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. Type enum. 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_dir
Optional. Type uniline.
os_config_dir - configuration file directory for specific OS
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. Type hash of uniline.
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() or &element function. See backend specifications and Config::Model::Role::ComputeFunction. Optional. Type uniline.
function
Deprecated Optional. Type uniline.
auto_create - Creates configuration files as needed
Optional. Type boolean.
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. Type uniline.
file_mode - configuration file mode
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. Type uniline.
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 (/etc/ssh/ssh_config) that is overridden by user's file. Optional. Type node of class Itself::ConfigReadWrite::DefaultLayer .
class
Optional. Type uniline.
store_class_in_hash
Specify element hash name that contains all INI classes. See "Arbitrary class name" in Config::Model::Backend::IniFile Optional. Type uniline.
section_map
Specify element name that contains one INI class. E.g. to store INI class [foo] in element Foo, specify { foo => "Foo" } Optional. Type hash of uniline.
split_list_value
Regexp to split the value read from ini file. Usually "\s+" or "[,\s]" Optional. Type uniline.
split_check_list_value
Regexp to split the value read from ini file. Usually "\s+" or "[,\s]" Optional. Type uniline.
assign_char
Character used to assign value in INI file. Default is =. See details Optional. Type uniline.
assign_with
String used write assignment in INI file. Default is " = ". See details Optional. Type uniline.
join_list_value
string to join list values before writing the entry in ini file. Usually " " or ", " Optional. Type uniline.
join_check_list_value
string to join checked items names before writing the entry in the ini file. Usually " " or ", " Optional. Type uniline.
write_boolean_as
Specify how to write a boolean value in config file. Suggested values are "no","yes". Optional. Type list of uniline.
force_lc_section
force section to be lowercase. Optional. Type boolean.
force_lc_key
force key names to be lowercase. Optional. Type boolean.
force_lc_value
force values to be lowercase. Optional. Type boolean.
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. Type boolean.
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. Type uniline.
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. Type enum. choice: 'shell_style'.
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. Optional. Type boolean.