Config::Model::models::Itself::Element(3pm)

1Config::Model::models::UIstesrelCfo:n:tErliebmuetnetdC(o3Pn)efrilg:D:oMcoudmeeln:t:amtoidoenls::Itself::Element(3)
2
3
4

NAME

6       Config::Model::models::Itself::Element - Configuration class
7       Itself::Element
8

DESCRIPTION

10       Configuration classes used by Config::Model
11

Elements

13   type
14       specify the type of the configuration element.Leaf is used for plain
15       value.  Mandatory. Type enum. choice: 'node', 'warped_node', 'hash',
16       'list', 'leaf', 'check_list'.
17
18   value_type
19        Optional. Type enum. choice: 'boolean', 'enum', 'integer',
20       'reference', 'number', 'uniline', 'string', 'file', 'dir'.
21
22       Here are some explanations on the possible values:
23
24       'integer'
25           positive or negative integer
26
27       'uniline'
28           string with no embedded newline
29
30   class - Override implementation of element
31       Perl class name used to override the implementation of the
32       configuration element. This override Perl class must inherit a
33       Config::Model class that matches the element type, i.e.
34       Config::Model::Value, Config::Model::HashId or Config::Model::ListId.
35       Use with care.  Optional. Type uniline.
36
37   morph
38       When set, a recurse copy of the value from the old object to the new
39       object is attempted. Old values are dropped when  a copy is not
40       possible (usually because of mismatching types).  Optional. Type
41       boolean.
42
43   refer_to
44       points to an array or hash element in the configuration tree using grab
45       syntax. The available choice of this reference value (or check list)is
46       made from the available keys of the pointed hash element or the values
47       of the pointed array element.  Optional. Type uniline.
48
49   computed_refer_to
50       points to an array or hash element in the configuration tree using a
51       path computed with value from several other elements in the
52       configuration tree. The available choice of this reference value (or
53       check list) is made from the available keys of the pointed hash element
54       or the values of the pointed array element. The keys of several hashes
55       (or lists) can be combined by using the '+' operator in the formula.
56       For instance, '! host:$a lan + ! host:foobar lan'. See
57       Config::Model::IdElementReference for more details.  Optional. Type
58       warped_node.
59
60   replace_follow
61       Path specifying a hash of value element in the configuration tree. The
62       hash if used in a way similar to the replace parameter. In this case,
63       the replacement is not coded in the model but specified by the
64       configuration.  Optional. Type uniline.
65
66   compute
67       compute the default value according to a formula and value from other
68       elements in the configuration tree.  Optional. Type warped_node.
69
70   migrate_from
71       Specify an upgrade path from an old value and compute the value to
72       store in the new element.  Optional. Type warped_node.
73
74   write_as
75       Specify how to write a boolean value. Example 'no' 'yes'.  Optional.
76       Type list of uniline.
77
78   migrate_values_from
79       Specifies that the values of the hash or list are copied from another
80       hash or list in the configuration tree once configuration data are
81       loaded.  Optional. Type uniline.
82
83   migrate_keys_from
84       Specifies that the keys of the hash are copied from another hash in the
85       configuration tree only when the hash is created.  Optional. Type
86       uniline.
87
88   write_empty_value
89       By default, hash entries without data are not saved in configuration
90       files. Set this parameter to 1 if a key must be saved in the
91       configuration file even if the hash contains no value for that key.
92       Optional. Type boolean.
93
94       upstream_default value :
95           0
96
97   mandatory
98        Optional. Type boolean.
99
100   config_class_name
101        Optional. Type reference.
102
103   choice
104       Specify the possible values of an enum. This can also be used in a
105       reference element so the possible enum value will be the combination of
106       the specified choice and the referred to values.  Optional. Type list
107       of uniline.
108
109   min
110       minimum value.  Optional. Type number.
111
112   max
113       maximum value.  Optional. Type number.
114
115   min_index
116       minimum number of keys.  Optional. Type integer.
117
118   max_index
119       maximum number of keys.  Optional. Type integer.
120
121   default
122       Specify default value. This default value is written in the
123       configuration data.  Optional. Type string.
124
125   upstream_default
126       Another way to specify a default value. But this default value is
127       considered as "built_in" the application and is not written in the
128       configuration data (unless modified)  Optional. Type string.
129
130   convert
131       Convert value or index to uppercase (uc) or lowercase (lc).  Optional.
132       Type enum.
133
134   match
135       Perl regular expression to assert the validity of the value. To check
136       the whole value, use "^" and "$". For instance "^foo|bar$" allows "foo"
137       or "bar" but not "foobar". To be case insentive, use the "(?i)"
138       extended pattern. For instance, the regexp "^(?i)foo|bar$" also allows
139       the values "Foo" and "Bar".  Optional. Type uniline.
140
141   assert
142       Raise an error if the test code snippet does returns false. Note this
143       snippet is also run on undefined value, which may not be what you want.
144       Optional. Type hash of node of class Itself::CommonElement::Assert .
145
146   warn_if
147       Warn user if the code snippet returns true.  Optional. Type hash of
148       node of class Itself::CommonElement::Assert .
149
150   warn_unless
151       Warn user if the code snippet returns false.  Optional. Type hash of
152       node of class Itself::CommonElement::Assert .
153
154   warn_if_match
155       Warn user if a defined value matches the regular expression.  Optional.
156       Type hash of node of class Itself::CommonElement::WarnIfMatch .
157
158   warn_unless_match
159       Warn user if defined value does not match the regular expression.
160       Optional. Type hash of node of class Itself::CommonElement::WarnIfMatch
161       .
162
163   warn
164       Unconditionally issue a warning with this string when this parameter is
165       used. This should be used mostly with "accept"  Optional. Type string.
166
167   grammar
168       Feed this grammar to Parse::RecDescent to perform validation.
169       Optional. Type string.
170
171   default_list
172       Specify items checked by default.  Optional. Type check_list.
173
174   upstream_default_list
175       Specify items checked by default in the application.  Optional. Type
176       check_list.
177
178   allow_keys_from
179       this hash allows keys from the keys of the hash pointed by the path
180       string.  Optional. Type uniline.
181
182   allow_keys_matching
183       Keys must match the specified regular expression.  Optional. Type
184       uniline.
185
186   follow_keys_from
187       this hash contains the same keys as the hash pointed by the path
188       string.  Optional. Type uniline.
189
190   warn_if_key_match
191       Warn user if a key is created matching this regular expression.
192       Optional. Type uniline.
193
194   warn_unless_key_match
195       Warn user if a key is created not matching this regular expression.
196       Optional. Type uniline.
197
198   ordered
199       keep track of the order of the elements of this hash.  Optional. Type
200       boolean.
201
202   default_keys
203       default keys hashes.  Optional. Type list of string.
204
205   auto_create_keys
206       always create a set of keys specified in this list.  Optional. Type
207       list of string.
208
209   allow_keys
210       specify a set of allowed keys.  Optional. Type list of string.
211
212   auto_create_ids
213       always create the number of id specified in this integer.  Optional.
214       Type string.
215
216   default_with_init
217       specify a set of keys to create and initialization on some elements .
218       E.g. ' foo => "X=Av Y=Bv", bar => "Y=Av Z=Cz"'  Optional. Type hash of
219       string.
220
221   max_nb
222        Optional. Type integer.
223
224   replace
225       Used for enum to substitute one value with another. This parameter must
226       be used to enable user to upgrade a configuration with obsolete values.
227       The old value is the key of the hash, the new one is the value of the
228       hash.  Optional. Type hash of string.
229
230   duplicates
231       Specify the policy regarding duplicated values stored in the list or as
232       hash values (valid only when cargo type is "leaf"). The policy can be
233       "allow" (default), "suppress", "warn" (which offers the possibility to
234       apply a fix), "forbid".  Optional. Type enum. choice: 'allow',
235       'suppress', 'warn', 'forbid'.
236
237       upstream_default value :
238           allow
239
240   help
241       Specify help string applicable to values. The keys are regexp matched
242       to the beginning of the value. See "help" parameter of "DESCRIPTION" in
243       Config::Model::Value for more possibilities.  Optional. Type hash of
244       string.
245
246   status
247        Optional. Type enum. choice: 'obsolete', 'deprecated', 'standard'.
248
249       upstream_default value :
250           standard
251
252   level
253       Used to highlight important parameter or to hide others. Hidden
254       parameter are mostly used to hide features that are unavailable at
255       start time. They can be made available later using warp mechanism.
256       Optional. Type enum. choice: 'important', 'normal', 'hidden'.
257
258       upstream_default value :
259           normal
260
261   summary
262       enter short information regarding this element.  Optional. Type
263       uniline.
264
265   description
266       enter detailed help information regarding this element.  Optional. Type
267       string.
268
269   warp
270       change the properties (i.e. default value or its value_type)
271       dynamically according to the value of another Value object located
272       elsewhere in the configuration tree.  Optional. Type warped_node of
273       class Itself::WarpValue .
274
275   index_type
276       Specify the type of allowed index for the hash. "String" means no
277       restriction.  Optional. Type enum.
278
279   cargo
280       Specify the properties of the configuration element configuration in
281       this hash or list.  Optional. Type warped_node.
282

NAME

DESCRIPTION

Elements

SEE ALSO