Skip to content

Commit 2ca0306

Browse files
xabbuhxabbuh
committed
document the options inherited from the BaseType class
1 parent 911cc70 commit 2ca0306

File tree

2 files changed

+67
-47
lines changed

2 files changed

+67
-47
lines changed

‎reference/forms/types/button.rst

+10-4
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ A simple, non-responsive button.
1212
+----------------------+----------------------------------------------------------------------+
1313
| Rendered as | ``button`` tag |
1414
+----------------------+----------------------------------------------------------------------+
15-
| Options | - `attr`_ |
16-
| | - `disabled`_ |
15+
| Inherited | - `attr`_ |
16+
| options | - `disabled`_ |
1717
| | - `label`_ |
1818
| | - `translation_domain`_ |
1919
+----------------------+----------------------------------------------------------------------+
@@ -24,8 +24,14 @@ A simple, non-responsive button.
2424
| Class | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\ButtonType` |
2525
+----------------------+----------------------------------------------------------------------+
2626

27-
Options
28-
-------
27+
Inherited options
28+
-----------------
29+
30+
The following options are defined in the
31+
:class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\BaseType` class.
32+
The ``BaseType`` class is the parent class for both the ``button`` type and
33+
the :doc:`form type </reference/forms/types/form>`, but it is not part of
34+
the form type tree (i.e. it can not be used as a form type on its own).
2935

3036
.. include:: /reference/forms/types/options/button_attr.rst.inc
3137

‎reference/forms/types/form.rst

+57-43
Original file line numberDiff line numberDiff line change
@@ -7,39 +7,40 @@ form Field Type
77
The ``form`` type predefines a couple of options that are then available
88
on all types for which ``form`` is the parent type.
99

10-
+---------+--------------------------------------------------------------------+
11-
| Options | - `compound`_ |
12-
| | - `data`_ |
13-
| | - `data_class`_ |
14-
| | - `empty_data`_ |
15-
| | - `required`_ |
16-
| | - `label`_ |
17-
| | - `label_attr`_ |
18-
| | - `constraints`_ |
19-
| | - `cascade_validation`_ |
20-
| | - `read_only`_ |
21-
| | - `disabled`_ |
22-
| | - `trim`_ |
23-
| | - `mapped`_ |
24-
| | - `property_path`_ |
25-
| | - `attr`_ |
26-
| | - `translation_domain`_ |
27-
| | - `block_name`_ |
28-
| | - `max_length`_ |
29-
| | - `by_reference`_ |
30-
| | - `error_bubbling`_ |
31-
| | - `inherit_data`_ |
32-
| | - `error_mapping`_ |
33-
| | - `invalid_message`_ |
34-
| | - `invalid_message_parameters`_ |
35-
| | - `extra_fields_message`_ |
36-
| | - `post_max_size_message`_ |
37-
| | - `pattern`_ |
38-
+---------+--------------------------------------------------------------------+
39-
| Parent | none |
40-
+---------+--------------------------------------------------------------------+
41-
| Class | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\FormType` |
42-
+---------+--------------------------------------------------------------------+
10+
+-----------+--------------------------------------------------------------------+
11+
| Options | - `compound`_ |
12+
| | - `data`_ |
13+
| | - `data_class`_ |
14+
| | - `empty_data`_ |
15+
| | - `required`_ |
16+
| | - `label_attr`_ |
17+
| | - `constraints`_ |
18+
| | - `cascade_validation`_ |
19+
| | - `read_only`_ |
20+
| | - `trim`_ |
21+
| | - `mapped`_ |
22+
| | - `property_path`_ |
23+
| | - `max_length`_ |
24+
| | - `by_reference`_ |
25+
| | - `error_bubbling`_ |
26+
| | - `inherit_data`_ |
27+
| | - `error_mapping`_ |
28+
| | - `invalid_message`_ |
29+
| | - `invalid_message_parameters`_ |
30+
| | - `extra_fields_message`_ |
31+
| | - `post_max_size_message`_ |
32+
| | - `pattern`_ |
33+
+-----------+--------------------------------------------------------------------+
34+
| Inherited | - `block_name`_ |
35+
| options | - `disabled`_ |
36+
| | - `label`_ |
37+
| | - `attr`_ |
38+
| | - `translation_domain`_ |
39+
+-----------+--------------------------------------------------------------------+
40+
| Parent | none |
41+
+-----------+--------------------------------------------------------------------+
42+
| Class | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\FormType` |
43+
+-----------+--------------------------------------------------------------------+
4344

4445
Options
4546
-------
@@ -60,8 +61,6 @@ Options
6061

6162
.. include:: /reference/forms/types/options/required.rst.inc
6263

63-
.. include:: /reference/forms/types/options/label.rst.inc
64-
6564
.. include:: /reference/forms/types/options/label_attr.rst.inc
6665

6766
.. include:: /reference/forms/types/options/constraints.rst.inc
@@ -70,20 +69,12 @@ Options
7069

7170
.. include:: /reference/forms/types/options/read_only.rst.inc
7271

73-
.. include:: /reference/forms/types/options/disabled.rst.inc
74-
7572
.. include:: /reference/forms/types/options/trim.rst.inc
7673

7774
.. include:: /reference/forms/types/options/mapped.rst.inc
7875

7976
.. include:: /reference/forms/types/options/property_path.rst.inc
8077

81-
.. include:: /reference/forms/types/options/attr.rst.inc
82-
83-
.. include:: /reference/forms/types/options/translation_domain.rst.inc
84-
85-
.. include:: /reference/forms/types/options/block_name.rst.inc
86-
8778
.. _reference-form-option-max_length:
8879

8980
.. include:: /reference/forms/types/options/max_length.rst.inc
@@ -107,3 +98,26 @@ Options
10798
.. _reference-form-option-pattern:
10899

109100
.. include:: /reference/forms/types/options/pattern.rst.inc
101+
102+
.. include:: /reference/forms/types/options/action.rst.inc
103+
104+
.. include:: /reference/forms/types/options/method.rst.inc
105+
106+
Inherited options
107+
-----------------
108+
109+
The following options are defined in the
110+
:class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\BaseType` class.
111+
The ``BaseType`` class is the parent class for both the ``form`` type and
112+
the :doc:`button type </reference/forms/types/button>`, but it is not part
113+
of the form type tree (i.e. it can not be used as a form type on its own).
114+
115+
.. include:: /reference/forms/types/options/block_name.rst.inc
116+
117+
.. include:: /reference/forms/types/options/disabled.rst.inc
118+
119+
.. include:: /reference/forms/types/options/label.rst.inc
120+
121+
.. include:: /reference/forms/types/options/attr.rst.inc
122+
123+
.. include:: /reference/forms/types/options/translation_domain.rst.inc

0 commit comments

Comments
 (0)