Config::Model::models::Itself::Element(3pm) User Contributed Perl Documentation Config::Model::models::Itself::Element(3pm)
NAME
Config::Model::models::Itself::Element - Configuration class Itself::Element
DESCRIPTION
Configuration classes used by Config::Model
Elements
type
specify the type of the configuration element.Leaf is used for plain value.Mandatory. Type enum. choice: 'node', 'warped_node', 'hash',
'list', 'leaf', 'check_list'.
value_type
Optional. Type enum.
class - Override Config::Model::Value:
Perl class name of a child of Config::Model::Value. Optional. Type uniline.
follow
Specifies the path to the value elements that drive the change of this node. Each key of the has is a variable name used in the 'rules'
parameter. The value of the hash is a path in the configuration tree. Optional. Type hash of uniline.
morph
When set, a recurse copy of the value from the old object to the new object will be attemped. When a copy is not possible, undef values
will be assigned.Optional. Type boolean.
refer_to
points to an array or hash element in the configuration tree using the path syntax. 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 pointed array element.Optional. Type uniline.
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 pointed hash
element or the values of the pointed array element.Optional. Type warped_node.
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.Optional. Type uniline.
compute
compute the default value according to a formula and value from other elements in the configuration tree.Optional. Type warped_node.
migrate_from
Specify an upgrade path from an old value and compute the value to store in the new element.Optional. Type warped_node.
write_as
Specify how to write a boolean value. Example 'no' 'yes'.Optional. Type list of uniline.
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.Optional. Type uniline.
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.Optional. Type
uniline.
mandatory
Optional. Type boolean.
config_class_name
Optional. Type reference.
choice
Specify the possible values. Optional. Type list of uniline.
min
minimum value. Optional. Type integer.
max
maximum value. Optional. Type integer.
min_index
minimum number of keys. Optional. Type integer.
max_index
maximum number of keys. Optional. Type integer.
default
Specify default value. This default value will be written in the configuration data. Optional. Type uniline.
upstream_default
Another way to specify a default value. But this default value is considered as "built_in" the application and is not written in the
configuration data (unless modified)Optional. Type uniline.
convert
Convert value or index to uppercase (uc) or lowercase (lc).Optional. Type enum.
match
Perl regular expression to assert the validity of the value.Optional. Type uniline.
assert
Raise an error if the test code snippet does returns false. Optional. Type hash of node.
warn_unless
Warn user if the tes code snippet does returns false. Optional. Type hash of node.
warn_if_match
Warn user if a defined value matches the regular expression. Optional. Type hash of node.
warn_unless_match
Warn user if defined value does not match the regular expression. Optional. Type hash of node.
warn
Unconditionally issue a warning with this string when this parameter is used. This should be used mostly with "accept"Optional. Type
string.
grammar
Feed this grammar to Parse::RecDescent to perform validation. Optional. Type string.
default_list
Specify items checked by default. Optional. Type check_list.
upstream_default_list
Specify items checked by default in the application. Optional. Type check_list.
allow_keys_from
this hash will allow keys from the keys of the hash pointed by the path string. Optional. Type uniline.
allow_keys_matching
Keys must match the specified regular expression.Optional. Type uniline.
follow_keys_from
this hash will contain the same keys as the hash pointed by the path string. Optional. Type uniline.
warn_if_key_match
Warn user if a key is created matching this regular expression. Optional. Type uniline.
warn_unless_key_match
Warn user if a key is created not matching this regular expression. Optional. Type uniline.
ordered
keep track of the order of the elements of this hash. Optional. Type boolean.
default_keys
default keys hashes.Optional. Type list of string.
auto_create_keys
always create a set of keys specified in this list. Optional. Type list of string.
allow_keys
specify a set of allowed keys. Optional. Type list of string.
auto_create_ids
always create the number of id specified in this integer. Optional. Type string.
default_with_init
specify a set of keys to create and initialization on some elements . E.g. ' foo => "X=Av Y=Bv", bar => "Y=Av Z=Cz"' Optional. Type hash of
string.
max_nb
Optional. Type integer.
replace
Used for enum to substitute one value with another. This parameter must be used to enable user to upgrade a configuration with obsolete
values. The old value is the key of the hash, the new one is the value of the hash. Optional. Type hash of string.
duplicates
Specify the policy regarding duplicated values stored in the list or as hash values (valid only when cargo type is "leaf"). The policy can
be "allow" (default), "suppress", "warn" (which offers the possibility to apply a fix), "forbid".Optional. Type enum. choice: 'allow',
'suppress', 'warn', 'forbid'. upstream_default: 'allow'.
help
Specify help string specific to possible values. E.g for "light" value, you could write " red => 'stop', green => 'walk' Optional. Type
hash of string.
status
Optional. Type enum. choice: 'obsolete', 'deprecated', 'standard'. upstream_default: 'standard'.
experience
Used to categorize configuration elements in several "required skills". Use this feature if you need to hide a parameter to novice users.
Optional. Type enum. choice: 'master', 'advanced', 'beginner'. upstream_default: 'beginner'.
level
Used to highlight important parameter or to hide others. Hidden parameter are mostly used to hide features that are unavailable at start
time. They can be made available later using warp mechanism. Optional. Type enum. choice: 'important', 'normal', 'hidden'.
upstream_default: 'normal'.
summary
enter short information regarding this element. Optional. Type uniline.
description
enter detailed help information regarding this element. Optional. Type string.
warp
change the properties (i.e. default value or its value_type) dynamically according to the value of another Value object locate elsewhere in
the configuration tree. Optional. Type warped_node.
rules
Each key of a hash is a boolean expression using variables declared in the 'follow' parameters. The value of the hash specifies the effects
on the node. Optional. Type hash of warped_node.
index_type
Specify the type of allowed index for the hash. "String" means no restriction.Optional. Type enum.
cargo
Specify the properties of the configuration element configuration in this hash or list. Optional. Type warped_node.
SEE ALSO
o cme
o Config::Model::models::Itself::CommonElement::Assert
o Config::Model::models::Itself::CommonElement::WarnIfMatch
perl v5.14.2 2012-06-22 Config::Model::models::Itself::Element(3pm)