Skip to content

clarify allowed property path value types #8635

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 1 commit into from
Nov 14, 2017
Merged

clarify allowed property path value types #8635

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 3 additions & 8 deletions reference/forms/types/options/property_path.rst.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,12 @@
property_path
~~~~~~~~~~~~~

**type**: ``any`` **default**: ``the field's name``
**type**: ``PropertyPathInterface|string|null`` **default**: ``null``

Fields display a property value of the form's domain object by default.
When the form is submitted, the submitted value is written back into the
object.

If you want to override the property that a field reads from and writes
to, 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``, but using
``property_path`` for this purpose is deprecated, you should use the
``mapped`` option.
to, you can set the ``property_path`` option. Its default value (``null``)
will use the field's name as the property.