Skip to content

[WIP] [2.7+] explicit differences between 'data' & 'empty_data' options in FormType #6265

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

Closed
wants to merge 5 commits into from
Closed

[WIP] [2.7+] explicit differences between 'data' & 'empty_data' options in FormType #6265

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
77a5fbb
explicit differences between 'data' & 'empty_data' in FormType
HeahDude Feb 12, 2016
8fa74d9
fix typo
HeahDude Feb 12, 2016
f5f9c1e
improved accuracy
HeahDude Apr 25, 2016
60c8893
Addressed @stof's comment
HeahDude May 21, 2016
133a77c
Updated the example add added a caution
HeahDude May 21, 2016
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
14 changes: 7 additions & 7 deletions reference/forms/types/options/data.rst.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
data
~~~~

**type**: ``mixed`` **default**: Defaults to field of the underlying object (if there is one)
**type**: ``mixed`` **default**: Defaults to field of the underlying structure.

When you create a form, each field initially displays the value of the
corresponding property of the form's domain object (if an object is bound
to the form). If you want to override the initial value for the form or
just an individual field, you can set it in the data option::
When you attach a form type to a form, it becomes a field that initially maps
the value of the corresponding property or key of the form's domain data. If
you want to override the initial value which will be rendered in the view for
the form or any field, you can set it in the data option::

$builder->add('token', 'hidden', array(
'data' => 'abcdef',
Expand All @@ -15,5 +15,5 @@ just an individual field, you can set it in the data option::
.. note::

The default values for form fields are taken directly from the underlying
data structure (e.g. an entity or an array). The ``data`` option overrides
this default value.
data structure matching the field name with a property of an object or a
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried to centralize structure references in the note.

key of an array. The ``data`` option overrides this default value.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should make it clearer than overriding the default value like this will cause issues if you are using the form to edit an object rather than to create it, as the form value will still be filled from data even if the underlying data structure also has a value for it

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for this heads-up!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@stof done in the sentence below

9 changes: 5 additions & 4 deletions reference/forms/types/options/empty_data.rst.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,12 @@ empty_data
DEFAULT_PLACEHOLDER

This option determines what value the field will return when the submitted
value is empty.
value is empty. It does not set an initial value if none is provided when
the form is rendered in a view (see `Data` or `Placeholder` options).

But you can customize this to your needs. For example, if you want the
``gender`` choice field to be explicitly set to ``null`` when no value is
selected, you can do it like this::
It helps you handling form submission and you can customize this to your needs.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could maybe remove "customize" as this is the point of an option.
It could be "It helps you handling form submission, for example, [...]"

For example, if you want the ``gender`` choice field to be explicitly set to ``null``
when no value is selected, you can do it like this::

$builder->add('gender', 'choice', array(
'choices' => array(
Copy link
Contributor Author

@HeahDude HeahDude May 10, 2016 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This example also needs to be changed (ref silexphp/Silex#1300 (comment)).

And it makes no sense to use ChoiceType which is the most complicated example.

We should override it for this type to make it even clearer as it is on its own the most confusing and principal cause of issues.

Expand Down