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

1Config::Model::models::UIstesrelCfo:n:tCroiCnbofunitfgeiAdgc:cP:eeMprotld(e3Dl)o:c:ummoednetlast:i:oIntself::ConfigAccept(3)
2
3
4

NAME

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

DESCRIPTION

10       Configuration classes used by Config::Model
11

Elements

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

NAME

DESCRIPTION

Elements

SEE ALSO