8390e3e259af63f0ed785933c67c273cc32d2185
[Packages/TYPO3.CMS.git] / typo3 / sysext / form / Documentation / Configuration / Rules / Equals / Index.rst
1 .. include:: ../../../Includes.txt
2
3
4 .. _reference-rules-equals:
5
6 ======
7 equals
8 ======
9
10 Compares the submitted data of two FORM objects. If they are not equal, the
11 rule does not validate.
12
13 The rule and error messages will be put in the label of the object the rule
14 is attached with by the property "element".
15
16
17 .. _reference-rules-equals-breakonerror:
18
19 breakOnError
20 ============
21
22 :aspect:`Description:`
23     See general information for :ref:`reference-validation-attributes-breakonerror`.
24
25
26 .. _reference-rules-equals-element:
27
28 element
29 =======
30
31 :aspect:`Description:`
32     See general information for :ref:`reference-validation-attributes-element`.
33
34
35 .. _reference-rules-equals-error:
36
37 error
38 =====
39
40 :aspect:`Description:`
41     See general information for :ref:`reference-validation-attributes-error`.
42
43     The %field marker will be replaces with the property "field".
44
45 :aspect:`Default:`
46     *local language:*"The value does not equal the value in field '%field'"
47
48
49 .. _reference-rules-equals-field:
50
51 field
52 =====
53
54 :aspect:`Property:`
55     field
56
57 :aspect:`Data type:`
58     string
59
60 :aspect:`Description:`
61     The name of the object to compare with.
62
63     See explanation of "element" property.
64
65
66 .. _reference-rules-equals-message:
67
68 message
69 =======
70
71 :aspect:`Description:`
72     See general information for :ref:`reference-validation-attributes-message`.
73
74     The %field marker will be replaces with the property "field".
75
76 :aspect:`Default:`
77     *local language:*"This field must be equal to '%field'"
78
79
80 .. _reference-rules-equals-showmessage:
81
82 showMessage
83 ===========
84
85 :aspect:`Description:`
86     See general information for :ref:`reference-validation-attributes-showmessage`.
87
88 [tsref:(cObject).FORM->rules.equals]
89