/usr/share/perl5/Config/Model/models/Itself/Element.pod is in libconfig-model-itself-perl 2.006-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 | # 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. Use with care. I<< Optional. Type uniline. >>
=head2 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. I<< Optional. Type boolean. >>
=head2 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. I<< Optional. Type uniline. >>
=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 pointed hash element or the values of the pointed array element. I<< Optional. Type warped_node. >>
=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 mandatory
I<< Optional. Type boolean. >>
=head2 config_class_name
I<< Optional. Type reference. >>
=head2 choice
Specify the possible 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 default
Specify default value. This default value will be written in the configuration data. I<< Optional. Type uniline. >>
=head2 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) I<< Optional. Type uniline. >>
=head2 convert
Convert value or index to uppercase (uc) or lowercase (lc). I<< Optional. Type enum. >>
=head2 match
Perl regular expression to assert the validity of the value. To check the whole value, use C<^> and C<$>. For instance C<^foo|bar$> will allow C<foo> or C<bar> but not C<foobar>. To be case insentive, use the C<(?i)> extended pattern. For instance, the regexp C<^(?i)foo|bar$> will also allow the values C<Foo> and C<Bar>. I<< Optional. Type uniline. >>
=head2 assert
Raise an error if the test code snippet does returns false. Note this snippet will also be run on undefined value, which may not be what you want. I<< Optional. Type hash of node of class L<Itself::CommonElement::Assert|Config::Model::models::Itself::CommonElement::Assert> . >>
=head2 warn_if
Warn user if the code snippet returns true. I<< Optional. Type hash of node of class L<Itself::CommonElement::Assert|Config::Model::models::Itself::CommonElement::Assert> . >>
=head2 warn_unless
Warn user if the code snippet returns false. I<< Optional. Type hash of node of class L<Itself::CommonElement::Assert|Config::Model::models::Itself::CommonElement::Assert> . >>
=head2 warn_if_match
Warn user if a I<defined> value matches the regular expression. I<< Optional. Type hash of node of class L<Itself::CommonElement::WarnIfMatch|Config::Model::models::Itself::CommonElement::WarnIfMatch> . >>
=head2 warn_unless_match
Warn user if I<defined> value does not match the regular expression. I<< Optional. Type hash of node of class L<Itself::CommonElement::WarnIfMatch|Config::Model::models::Itself::CommonElement::WarnIfMatch> . >>
=head2 warn
Unconditionally issue a warning with this string when this parameter is used. This should be used mostly with "accept" I<< Optional. Type string. >>
=head2 grammar
Feed this grammar to Parse::RecDescent to perform validation. I<< Optional. Type string. >>
=head2 default_list
Specify items checked by default. I<< Optional. Type check_list. >>
=head2 upstream_default_list
Specify items checked by default in the application. I<< Optional. Type check_list. >>
=head2 allow_keys_from
this hash will allow keys from the keys of the hash pointed by the path string. I<< Optional. Type uniline. >>
=head2 allow_keys_matching
Keys must match the specified regular expression. I<< Optional. Type uniline. >>
=head2 follow_keys_from
this hash will contain the same keys as the hash pointed by the path string. I<< Optional. Type uniline. >>
=head2 warn_if_key_match
Warn user if a key is created matching this regular expression. I<< Optional. Type uniline. >>
=head2 warn_unless_key_match
Warn user if a key is created not matching this regular expression. I<< Optional. Type uniline. >>
=head2 ordered
keep track of the order of the elements of this hash. I<< Optional. Type boolean. >>
=head2 default_keys
default keys hashes. I<< Optional. Type list of string. >>
=head2 auto_create_keys
always create a set of keys specified in this list. I<< Optional. Type list of string. >>
=head2 allow_keys
specify a set of allowed keys. I<< Optional. Type list of string. >>
=head2 auto_create_ids
always create the number of id specified in this integer. I<< Optional. Type string. >>
=head2 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"' I<< Optional. Type hash of string. >>
=head2 max_nb
I<< Optional. Type integer. >>
=head2 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. I<< Optional. Type hash of string. >>
=head2 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". I<< Optional. Type enum. choice: 'allow', 'suppress', 'warn', 'forbid'. upstream_default: 'allow'. >>
=head2 help
Specify help string specific to possible values. E.g for "light" value, you could write " red => 'stop', green => 'walk' I<< Optional. Type hash of string. >>
=head2 status
I<< Optional. Type enum. choice: 'obsolete', 'deprecated', 'standard'. upstream_default: 'standard'. >>
=head2 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. I<< Optional. Type enum. choice: 'important', 'normal', 'hidden'. upstream_default: 'normal'. >>
=head2 summary
enter short information regarding this element. I<< Optional. Type uniline. >>
=head2 description
enter detailed help information regarding this element. I<< Optional. Type string. >>
=head2 warp
change the properties (i.e. default value or its value_type) dynamically according to the value of another Value object located elsewhere in the configuration tree. I<< Optional. Type warped_node of class L<Itself::WarpValue|Config::Model::models::Itself::WarpValue> . >>
=head2 index_type
Specify the type of allowed index for the hash. "String" means no restriction. I<< Optional. Type enum. >>
=head2 cargo
Specify the properties of the configuration element configuration in this hash or list. I<< Optional. Type warped_node. >>
=head1 SEE ALSO
=over
=item *
L<cme>
=item *
L<Config::Model::models::Itself::CommonElement::Assert>
=item *
L<Config::Model::models::Itself::CommonElement::WarnIfMatch>
=item *
L<Config::Model::models::Itself::WarpValue>
=back
=cut
|