[WIP] [2.7+] explicit differences between 'data' & 'empty_data' options in FormType #6265
improved accuracy
- Loading branch information
commit f5f9c1e370c6aee196b2d0eab505805a8a1e32e7
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,7 @@ | ||
| empty_data | ||
| ~~~~~~~~~~ | ||
|
|
||
| **type**: ``string`` or ``array`` when the form is compound | ||
|
|
||
| .. This file should only be included with start-after or end-before that's | ||
| set to this placeholder value. Its purpose is to let us include only | ||
|
|
@@ -14,19 +14,30 @@ 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). | ||
|
There was a problem hiding this comment. It would be nice to link the options There was a problem hiding this comment. Please can some one tell me how can I do it? |
||
|
|
||
| It helps you handling form submission and you can customize this to your needs. | ||
|
There was a problem hiding this comment. We could maybe remove "customize" as this is the point of an option. |
||
| For example, if you want the ``gender`` choice field to be explicitly set to ``Male`` | ||
| when no value is selected, you can do it like this:: | ||
|
|
||
| $builder->add('gender', 'choice', array( | ||
| 'choices' => array( | ||
|
There was a problem hiding this comment. This example also needs to be changed (ref silexphp/Silex#1300 (comment)). And it makes no sense to use 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. |
||
| 'm' => 'Male', | ||
| 'f' => 'Female', | ||
| ), | ||
| 'required' => false, | ||
| 'empty_value' => 'Choose your gender', | ||
| 'empty_data' => 'm', | ||
| )); | ||
|
|
||
| If a form is compound, you can set ``empty_data`` as an array with fields names | ||
| as keys and submitted values as string values (or arrays if nested fields are | ||
| also compound). | ||
|
|
||
| .. caution:: | ||
|
|
||
| In this example, the choice field is not set as ``multiple``. If it was | ||
| ``empty_data`` option should be an array of submitted string values:: | ||
|
|
||
| 'empty_data' => array('m'), | ||
|
|
||
| .. note:: | ||
|
|
||
| If you want to set the ``empty_data`` option for your entire form class, | ||
|
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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
dataeven if the underlying data structure also has a value for itThere was a problem hiding this comment.
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!
There was a problem hiding this comment.
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