view release on metacpan or  search on metacpan

lib/Config/Model/models/Itself/Element.pod  view on Meta::CPAN

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

=encoding utf8

=head1 NAME

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

=head1 DESCRIPTION

Configuration classes used by L<Config::Model>

=head1 Elements

=head2 type

specify the type of the configuration element.Leaf is used for plain value. I< Mandatory. Type enum. choice: 'node', 'warped_node', 'hash', 'list', 'leaf', 'check_list'.  > 

=head2 value_type

I< Optional. Type enum. choice: 'boolean', 'enum', 'integer', 'reference', 'number', 'uniline', 'string', 'file', 'dir'.  > 

Here are some explanations on the possible values:

=over

=item 'integer'

positive or negative integer

=item 'uniline'

string with no embedded newline

=back



=head2 class - Override implementation of element

Perl class name used to override the implementation of the configuration element. This override Perl class must inherit a Config::Model class that matches the element type, i.e. Config::Model::Value, Config::Model::HashId or Config::Model::ListId. Us...

=head2 morph

When set, a recurse copy of the value from the old object to the new object is attempted. Old values are dropped when  a copy is not possible (usually because of mismatching types). I< Optional. Type boolean.  > 

=head2 refer_to

points to an array or hash element in the configuration tree using L<grab syntax|Config::Model::Role::Grab>. The available choice of this reference value (or check list)is made from the available keys of the pointed hash element or the values of the ...

=head2 computed_refer_to

points to an array or hash element in the configuration tree using a path computed with value from several other elements in the configuration tree. The available choice of this reference value (or check list) is made from the available keys of the p...

=head2 replace_follow

Path specifying a hash of value element in the configuration tree. The hash if used in a way similar to the replace parameter. In this case, the replacement is not coded in the model but specified by the configuration. I< Optional. Type uniline.  > 

=head2 compute

compute the default value according to a formula and value from other elements in the configuration tree. I< Optional. Type warped_node.  > 

=head2 migrate_from

Specify an upgrade path from an old value and compute the value to store in the new element. I< Optional. Type warped_node.  > 

=head2 write_as

Specify how to write a boolean value. Example 'no' 'yes'. I< Optional. Type list of uniline.  > 

=head2 migrate_values_from

Specifies that the values of the hash or list are copied from another hash or list in the configuration tree once configuration data are loaded. I< Optional. Type uniline.  > 

=head2 migrate_keys_from

Specifies that the keys of the hash are copied from another hash in the configuration tree only when the hash is created. I< Optional. Type uniline.  > 

=head2 write_empty_value

By default, hash entries without data are not saved in configuration files. Set this parameter to 1 if a key must be saved in the configuration file even if the hash contains no value for that key. I< Optional. Type boolean.  > 

=over 4

=item upstream_default value :

0

=back



=head2 mandatory

I< Optional. Type boolean.  > 

=head2 config_class_name

I< Optional. Type reference.  > 

=head2 choice

Specify the possible values of an enum. This can also be used in a reference element so the possible enum value will be the combination of the specified choice and the referred to values. I< Optional. Type list of uniline.  > 

=head2 min

minimum value. I< Optional. Type number.  > 

=head2 max

maximum value. I< Optional. Type number.  > 

=head2 min_index

minimum number of keys. I< Optional. Type integer.  > 

=head2 max_index

maximum number of keys. I< Optional. Type integer.  > 

=head2 update