Skip to content

Commit c0e5964

Browse files
committed
Adding the mapped type to the form type references
1 parent e24625b commit c0e5964

27 files changed

+125
-8
lines changed

reference/forms/types/birthday.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ option defaults to 120 years ago to the current year.
3232
| | - `invalid_message_parameters`_ |
3333
| | - `read_only`_ |
3434
| | - `disabled`_ |
35+
| | - `mapped`_ |
3536
| | - `virtual`_ |
3637
+----------------------+------------------------------------------------------------------------------------------------------------------------+
3738
| Parent type | :doc:`date</reference/forms/types/date>` |
@@ -81,4 +82,6 @@ These options inherit from the :doc:`date</reference/forms/types/field>` type:
8182

8283
These options inherit from the :doc:`date</reference/forms/types/form>` type:
8384

85+
.. include:: /reference/forms/types/options/mapped.rst.inc
86+
8487
.. include:: /reference/forms/types/options/virtual.rst.inc

reference/forms/types/checkbox.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ if the box is unchecked, the value will be set to false.
1818
| | - `read_only`_ |
1919
| | - `disabled`_ |
2020
| | - `error_bubbling`_ |
21+
| | - `mapped`_ |
2122
+-------------+------------------------------------------------------------------------+
2223
| Parent type | :doc:`field</reference/forms/types/field>` |
2324
+-------------+------------------------------------------------------------------------+
@@ -59,3 +60,7 @@ These options inherit from the :doc:`field</reference/forms/types/field>` type:
5960
.. include:: /reference/forms/types/options/disabled.rst.inc
6061

6162
.. include:: /reference/forms/types/options/error_bubbling.rst.inc
63+
64+
These options inherit from the :doc:`date</reference/forms/types/form>` type:
65+
66+
.. include:: /reference/forms/types/options/mapped.rst.inc

reference/forms/types/choice.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ option.
2727
| | - `read_only`_ |
2828
| | - `disabled`_ |
2929
| | - `error_bubbling`_ |
30+
| | - `mapped`_ |
3031
| | - `virtual`_ |
3132
+-------------+-----------------------------------------------------------------------------+
3233
| Parent type | :doc:`form</reference/forms/types/form>` (if expanded), ``field`` otherwise |
@@ -126,4 +127,6 @@ These options inherit from the :doc:`field</reference/forms/types/field>` type:
126127

127128
These options inherit from the :doc:`date</reference/forms/types/form>` type:
128129

130+
.. include:: /reference/forms/types/options/mapped.rst.inc
131+
129132
.. include:: /reference/forms/types/options/virtual.rst.inc

reference/forms/types/collection.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ forms, which is useful when creating forms that expose one-to-many relationships
2424
| options | - `error_bubbling`_ |
2525
| | - `by_reference`_ |
2626
| | - `empty_data`_ |
27+
| | - `mapped`_ |
2728
+-------------+-----------------------------------------------------------------------------+
2829
| Parent type | :doc:`form</reference/forms/types/form>` |
2930
+-------------+-----------------------------------------------------------------------------+
@@ -342,6 +343,8 @@ Not all options are listed here - only the most applicable to this type:
342343

343344
.. include:: /reference/forms/types/options/label.rst.inc
344345

346+
.. include:: /reference/forms/types/options/mapped.rst.inc
347+
345348
error_bubbling
346349
~~~~~~~~~~~~~~
347350

reference/forms/types/country.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ you should just use the ``choice`` type directly.
3131
| | - `label`_ |
3232
| | - `read_only`_ |
3333
| | - `disabled`_ |
34+
| | - `mapped`_ |
3435
+-------------+-----------------------------------------------------------------------+
3536
| Parent type | :doc:`choice</reference/forms/types/choice>` |
3637
+-------------+-----------------------------------------------------------------------+
@@ -60,4 +61,8 @@ These options inherit from the :doc:`field</reference/forms/types/field>` type:
6061

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

63-
.. include:: /reference/forms/types/options/disabled.rst.inc
64+
.. include:: /reference/forms/types/options/disabled.rst.inc
65+
66+
These options inherit from the :doc:`date</reference/forms/types/form>` type:
67+
68+
.. include:: /reference/forms/types/options/mapped.rst.inc

reference/forms/types/date.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ day, and year) or three select boxes (see the `widget_` option).
3333
| options | - `invalid_message_parameters`_ |
3434
| | - `read_only`_ |
3535
| | - `disabled`_ |
36+
| | - `mapped`_ |
3637
| | - `virtual`_ |
3738
+----------------------+-----------------------------------------------------------------------------+
3839
| Parent type | ``field`` (if text), ``form`` otherwise |
@@ -128,4 +129,6 @@ These options inherit from the :doc:`field</reference/forms/types/field>` type:
128129

129130
These options inherit from the :doc:`date</reference/forms/types/form>` type:
130131

132+
.. include:: /reference/forms/types/options/mapped.rst.inc
133+
131134
.. include:: /reference/forms/types/options/virtual.rst.inc

reference/forms/types/datetime.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ data can be a ``DateTime`` object, a string, a timestamp or an array.
3333
| options | - `invalid_message_parameters`_ |
3434
| | - `read_only`_ |
3535
| | - `disabled`_ |
36+
| | - `mapped`_ |
3637
| | - `virtual`_ |
3738
+----------------------+-----------------------------------------------------------------------------+
3839
| Parent type | :doc:`form</reference/forms/types/form>` |
@@ -115,4 +116,6 @@ These options inherit from the :doc:`field</reference/forms/types/field>` type:
115116

116117
These options inherit from the :doc:`date</reference/forms/types/form>` type:
117118

119+
.. include:: /reference/forms/types/options/mapped.rst.inc
120+
118121
.. include:: /reference/forms/types/options/virtual.rst.inc

reference/forms/types/email.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ The ``email`` field is a text field that is rendered using the HTML5
1717
| | - `read_only`_ |
1818
| | - `disabled`_ |
1919
| | - `error_bubbling`_ |
20+
| | - `mapped`_ |
2021
+-------------+---------------------------------------------------------------------+
2122
| Parent type | :doc:`field</reference/forms/types/field>` |
2223
+-------------+---------------------------------------------------------------------+
@@ -40,4 +41,8 @@ These options inherit from the :doc:`field</reference/forms/types/field>` type:
4041

4142
.. include:: /reference/forms/types/options/disabled.rst.inc
4243

43-
.. include:: /reference/forms/types/options/error_bubbling.rst.inc
44+
.. include:: /reference/forms/types/options/error_bubbling.rst.inc
45+
46+
These options inherit from the :doc:`date</reference/forms/types/form>` type:
47+
48+
.. include:: /reference/forms/types/options/mapped.rst.inc

reference/forms/types/entity.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ objects from the database.
2727
| | - `read_only`_ |
2828
| | - `disabled`_ |
2929
| | - `error_bubbling`_ |
30+
| | - `mapped`_ |
3031
+-------------+------------------------------------------------------------------+
3132
| Parent type | :doc:`choice</reference/forms/types/choice>` |
3233
+-------------+------------------------------------------------------------------+
@@ -152,3 +153,7 @@ These options inherit from the :doc:`field</reference/forms/types/field>` type:
152153
.. include:: /reference/forms/types/options/disabled.rst.inc
153154

154155
.. include:: /reference/forms/types/options/error_bubbling.rst.inc
156+
157+
These options inherit from the :doc:`date</reference/forms/types/form>` type:
158+
159+
.. include:: /reference/forms/types/options/mapped.rst.inc

reference/forms/types/file.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ The ``file`` type represents a file input in your form.
1414
| | - `read_only`_ |
1515
| | - `disabled`_ |
1616
| | - `error_bubbling`_ |
17+
| | - `mapped`_ |
1718
+-------------+---------------------------------------------------------------------+
1819
| Parent type | :doc:`form</reference/forms/types/form>` |
1920
+-------------+---------------------------------------------------------------------+
@@ -92,4 +93,8 @@ These options inherit from the :doc:`field</reference/forms/types/field>` type:
9293

9394
.. include:: /reference/forms/types/options/disabled.rst.inc
9495

95-
.. include:: /reference/forms/types/options/error_bubbling.rst.inc
96+
.. include:: /reference/forms/types/options/error_bubbling.rst.inc
97+
98+
These options inherit from the :doc:`date</reference/forms/types/form>` type:
99+
100+
.. include:: /reference/forms/types/options/mapped.rst.inc

reference/forms/types/hidden.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ The hidden type represents a hidden input field.
1111
+-------------+----------------------------------------------------------------------+
1212
| Inherited | - ``data`` |
1313
| options | - ``property_path`` |
14+
| | - `mapped`_ |
1415
+-------------+----------------------------------------------------------------------+
1516
| Parent type | :doc:`field</reference/forms/types/field>` |
1617
+-------------+----------------------------------------------------------------------+
@@ -24,4 +25,8 @@ These options inherit from the :doc:`field</reference/forms/types/field>` type:
2425

2526
.. include:: /reference/forms/types/options/data.rst.inc
2627

27-
.. include:: /reference/forms/types/options/property_path.rst.inc
28+
.. include:: /reference/forms/types/options/property_path.rst.inc
29+
30+
These options inherit from the :doc:`date</reference/forms/types/form>` type:
31+
32+
.. include:: /reference/forms/types/options/mapped.rst.inc

reference/forms/types/integer.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ integers. By default, all non-integer values (e.g. 6.78) will round down (e.g. 6
2525
| | - `error_bubbling`_ |
2626
| | - `invalid_message`_ |
2727
| | - `invalid_message_parameters`_ |
28+
| | - `mapped`_ |
2829
+-------------+-----------------------------------------------------------------------+
2930
| Parent type | :doc:`field</reference/forms/types/field>` |
3031
+-------------+-----------------------------------------------------------------------+
@@ -75,3 +76,7 @@ These options inherit from the :doc:`field</reference/forms/types/field>` type:
7576
.. include:: /reference/forms/types/options/invalid_message.rst.inc
7677

7778
.. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc
79+
80+
These options inherit from the :doc:`date</reference/forms/types/form>` type:
81+
82+
.. include:: /reference/forms/types/options/mapped.rst.inc

reference/forms/types/language.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ you should just use the ``choice`` type directly.
3232
| | - `label`_ |
3333
| | - `read_only`_ |
3434
| | - `disabled`_ |
35+
| | - `mapped`_ |
3536
+-------------+------------------------------------------------------------------------+
3637
| Parent type | :doc:`choice</reference/forms/types/choice>` |
3738
+-------------+------------------------------------------------------------------------+
@@ -61,4 +62,8 @@ These options inherit from the :doc:`field</reference/forms/types/field>` type:
6162

6263
.. include:: /reference/forms/types/options/read_only.rst.inc
6364

64-
.. include:: /reference/forms/types/options/disabled.rst.inc
65+
.. include:: /reference/forms/types/options/disabled.rst.inc
66+
67+
These options inherit from the :doc:`date</reference/forms/types/form>` type:
68+
69+
.. include:: /reference/forms/types/options/mapped.rst.inc

reference/forms/types/locale.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ you should just use the ``choice`` type directly.
3333
| | - `label`_ |
3434
| | - `read_only`_ |
3535
| | - `disabled`_ |
36+
| | - `mapped`_ |
3637
+-------------+------------------------------------------------------------------------+
3738
| Parent type | :doc:`choice</reference/forms/types/choice>` |
3839
+-------------+------------------------------------------------------------------------+
@@ -62,4 +63,8 @@ These options inherit from the :doc:`field</reference/forms/types/field>` type:
6263

6364
.. include:: /reference/forms/types/options/read_only.rst.inc
6465

65-
.. include:: /reference/forms/types/options/disabled.rst.inc
66+
.. include:: /reference/forms/types/options/disabled.rst.inc
67+
68+
These options inherit from the :doc:`date</reference/forms/types/form>` type:
69+
70+
.. include:: /reference/forms/types/options/mapped.rst.inc

reference/forms/types/money.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ how the input and output of the data is handled.
2626
| | - `error_bubbling`_ |
2727
| | - `invalid_message`_ |
2828
| | - `invalid_message_parameters`_ |
29+
| | - `mapped`_ |
2930
+-------------+---------------------------------------------------------------------+
3031
| Parent type | :doc:`field</reference/forms/types/field>` |
3132
+-------------+---------------------------------------------------------------------+
@@ -97,4 +98,8 @@ These options inherit from the :doc:`field</reference/forms/types/field>` type:
9798

9899
.. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc
99100

101+
These options inherit from the :doc:`date</reference/forms/types/form>` type:
102+
103+
.. include:: /reference/forms/types/options/mapped.rst.inc
104+
100105
.. _`3 letter ISO 4217 code`: http://en.wikipedia.org/wiki/ISO_4217

reference/forms/types/number.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ you want to use for your number.
2222
| | - `error_bubbling`_ |
2323
| | - `invalid_message`_ |
2424
| | - `invalid_message_parameters`_ |
25+
| | - `mapped`_ |
2526
+-------------+----------------------------------------------------------------------+
2627
| Parent type | :doc:`field</reference/forms/types/field>` |
2728
+-------------+----------------------------------------------------------------------+
@@ -94,3 +95,7 @@ These options inherit from the :doc:`field</reference/forms/types/field>` type:
9495
.. include:: /reference/forms/types/options/invalid_message.rst.inc
9596

9697
.. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc
98+
99+
These options inherit from the :doc:`date</reference/forms/types/form>` type:
100+
101+
.. include:: /reference/forms/types/options/mapped.rst.inc

reference/forms/types/options/mapped.rst.inc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ mapped
44
**type**: ``boolean``
55

66
If you wish the field to be ignored when reading or writing to the object, you
7-
can set the ``mapped`` option to ``false``
7+
can set the ``mapped`` option to ``false``.

reference/forms/types/password.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ The ``password`` field renders an input password text box.
1818
| | - `read_only`_ |
1919
| | - `disabled`_ |
2020
| | - `error_bubbling`_ |
21+
| | - `mapped`_ |
2122
+-------------+------------------------------------------------------------------------+
2223
| Parent type | :doc:`text</reference/forms/types/text>` |
2324
+-------------+------------------------------------------------------------------------+
@@ -56,4 +57,8 @@ These options inherit from the :doc:`field</reference/forms/types/field>` type:
5657

5758
.. include:: /reference/forms/types/options/disabled.rst.inc
5859

59-
.. include:: /reference/forms/types/options/error_bubbling.rst.inc
60+
.. include:: /reference/forms/types/options/error_bubbling.rst.inc
61+
62+
These options inherit from the :doc:`date</reference/forms/types/form>` type:
63+
64+
.. include:: /reference/forms/types/options/mapped.rst.inc

0 commit comments

Comments
 (0)