f7c13806bc734e4e838dfb98dbecd42596b4d9ad
[Packages/TYPO3.CMS.git] / typo3 / sysext / form / Documentation / Configuration / Rules / Between / Index.rst
1 .. include:: ../../../Includes.txt
2
3
4 .. _reference-rules-between:
5
6 =======
7 between
8 =======
9
10 Checks if the submitted value is between the given minimum and maximum
11 value. By default, minimum and maximum are excluded, but can be included in
12 the validation.
13
14
15 .. _reference-rules-between-breakonerror:
16
17 breakOnError
18 ============
19
20 :aspect:`Description:`
21     See general information for :ref:`reference-validation-attributes-breakonerror`.
22
23
24 .. _reference-rules-between-element:
25
26 element
27 =======
28
29 :aspect:`Description:`
30     See general information for :ref:`reference-validation-attributes-element`.
31
32
33 .. _reference-rules-between-error:
34
35 error
36 =====
37
38 :aspect:`Description:`
39     See general information for :ref:`reference-validation-attributes-error`.
40
41     For this specific rule the default error message consists of two parts,
42     the second one will only be added when **inclusive** is set. This
43     functionality is not possible when defining an own message as shown
44     below.
45     The markers %minimum and %maximum will be replaced with the values set
46     by TypoScript.
47
48 :aspect:`Default:`
49     *local language:*"The value is not between %minimum and %maximum(,
50     inclusively)"
51
52
53 .. _reference-rules-between-inclusive:
54
55 inclusive
56 =========
57
58 :aspect:`Property:`
59     inclusive
60
61 :aspect:`Data type:`
62     boolean
63
64 :aspect:`Description:`
65     If inclusive = 1, the minimum and maximum value are included in the
66     comparison.
67
68 :aspect:`Default:`
69     0
70
71
72 .. _reference-rules-between-message:
73
74 message
75 =======
76
77 :aspect:`Description:`
78     See general information for :ref:`reference-validation-attributes-message`.
79
80     For this specific rule the default message consists of two parts, the
81     second one will only be added when **inclusive** is set. This
82     functionality is not possible when defining an own message as shown
83     below.
84     The markers %minimum and %maximum will be replaced with the values set
85     by TypoScript.
86
87 :aspect:`Default:`
88     *local language:*"The value must be between %minimum and %maximum(,
89     inclusively)"
90
91
92 .. _reference-rules-between-maximum:
93
94 maximum
95 =======
96
97 :aspect:`Property:`
98     maximum
99
100 :aspect:`Data type:`
101     integer
102
103 :aspect:`Description:`
104     The maximum value of the comparison.
105
106
107 .. _reference-rules-between-minimum:
108
109 minimum
110 =======
111
112 :aspect:`Property:`
113     minimum
114
115 :aspect:`Data type:`
116     integer
117
118 :aspect:`Description:`
119     The minimum value of the comparison.
120
121
122 .. _reference-rules-between-showmessage:
123
124 showMessage
125 ===========
126
127 :aspect:`Description:`
128     See general information for :ref:`reference-validation-attributes-showmessage`.
129
130 [tsref:(cObject).FORM->rules.between]
131