Skip to content

Document the mapped form type option #1973

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Nov 28, 2012
Merged

Document the mapped form type option #1973

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c70479a
Document the mapped formType option
Nov 26, 2012
930d9ea
whitespace
Nov 26, 2012
e58d132
fix copy paste mistake
Nov 26, 2012
0ac65bb
Point out what is deprecated
Nov 27, 2012
9faeb49
Sentences should end with a dot.
Nov 27, 2012
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion reference/forms/types/form.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,10 @@ on all fields.

.. include:: /reference/forms/types/options/trim.rst.inc

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

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

.. include:: /reference/forms/types/options/attr.rst.inc

.. include:: /reference/forms/types/options/translation_domain.rst.inc
.. include:: /reference/forms/types/options/translation_domain.rst.inc
7 changes: 7 additions & 0 deletions reference/forms/types/options/mapped.rst.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
mapped
~~~~~~

**type**: ``boolean``

If you wish the field to be ignored when reading or writing to the object, you
can set the ``mapped`` option to ``false``
7 changes: 6 additions & 1 deletion reference/forms/types/options/property_path.rst.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,9 @@ you can set the ``property_path`` option. Its default value is the field's
name.

If you wish the field to be ignored when reading or writing to the object
you can set the ``property_path`` option to ``false``
you can set the ``property_path`` option to ``false``, but using
``property_path`` for this purpose is deprecated, you should do it the way
described below:

.. versionadded:: 2.1
Since 2.1, the ``mapped`` option has been added for this use-case.