[TASK] EXT:form - Update documentation
[Packages/TYPO3.CMS.git] / typo3 / sysext / form / Documentation / Configuration / Rules / Length / Index.rst
1 .. include:: ../../../Includes.txt
2
3
4 .. _reference-rules-length:
5
6 ======
7 length
8 ======
9
10 Checks if the submitted value is of a certain length. A minimum length can
11 be used or a minimum and a maximum length.
12
13
14 .. _reference-rules-length-element:
15
16 element
17 =======
18
19 :aspect:`Description:`
20     See general information for :ref:`reference-validation-attributes-element`.
21
22
23 .. _reference-rules-length-error:
24
25 error
26 =====
27
28 :aspect:`Description:`
29     See general information for :ref:`reference-validation-attributes-error`.
30
31     For this specific rule the default error message consists of two parts,
32     the second one will only be added when **maximum** is set. This
33     functionality is not possible when defining an own message as shown
34     below.
35     The markers %minimum and %maximum will be replaced with the values set
36     by TypoScript.
37
38 :aspect:`Default:`
39     *local language:*"The value is less than %minimum characters long
40     (, or longer than %maximum)"
41
42
43 .. _reference-rules-length-maximum:
44
45 maximum
46 =======
47
48 :aspect:`Property:`
49     maximum
50
51 :aspect:`Data type:`
52     integer
53
54 :aspect:`Description:`
55     The maximum length of the submitted value. Maximum can only be used in
56     combination with minimum.
57
58
59 .. _reference-rules-length-message:
60
61 message
62 =======
63
64 :aspect:`Description:`
65     See general information for :ref:`reference-validation-attributes-message`.
66
67     For this specific rule the default message consists of two parts, the
68     second one will only be added when **maximum** is set. This
69     functionality is not possible when defining an own message as shown
70     below.
71     The markers %minimum and %maximum will be replaced with the values set
72     by TypoScript.
73
74 :aspect:`Default:`
75     *local language:*"The length of the value must have a minimum of
76     %minimum characters(, and a maximum of %maximum)"
77
78
79 .. _reference-rules-length-minimum:
80
81 minimum
82 =======
83
84 :aspect:`Property:`
85     minimum
86
87 :aspect:`Data type:`
88     integer
89
90 :aspect:`Description:`
91     The minimum length of the submitted value.
92
93
94 .. _reference-rules-length-showmessage:
95
96 showMessage
97 ===========
98
99 :aspect:`Description:`
100     See general information for :ref:`reference-validation-attributes-showmessage`.
101
102 [tsref:(cObject).FORM->rules.length]
103