-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
new cookbook article on using empty data for form classes #2415
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.
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
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -11,3 +11,4 @@ Form | |
create_custom_field_type | ||
create_form_type_extension | ||
use_virtuals_forms | ||
use_empty_data | ||
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 |
---|---|---|
@@ -0,0 +1,47 @@ | ||
.. index:: | ||
single: Form; Empty data | ||
|
||
How to configure Empty Data for a Form Class | ||
============================================ | ||
|
||
The ``empty_data`` option allows you to specify an empty data set for your | ||
form class. This empty data set would be used if you bind your form, but | ||
haven't yet called ``setData()``. | ||
|
||
By default, ``empty_data`` is set to ``null``. Or, if you have specified | ||
a ``data_class`` option for your form class, it will default to a new instance | ||
of that class. That instance will be created by calling the constructor | ||
with no arguments. | ||
|
||
If you want to override this default behavior, there are two ways to do this. | ||
|
||
Option 1: Instantiate a new Class | ||
--------------------------------- | ||
|
||
One reason you might use this option is if you want to use a constructor | ||
that takes arguments. Remember, the default ``data_class`` option calls | ||
that constructor with no arguments:: | ||
|
||
public function getDefaultOptions() | ||
{ | ||
return array( | ||
'empty_data' => new User($this->someDependency), | ||
); | ||
} | ||
|
||
Option 2: Provide a Closure | ||
--------------------------- | ||
|
||
Using a closure is the preferred method, since it will only create the object | ||
if it is needed. | ||
|
||
The closure must accept a ``FormInterface`` instance as the first argument:: | ||
|
||
public function getDefaultOptions() | ||
{ | ||
return array( | ||
'empty_data' => function (FormInterface $form) { | ||
return new User($form->get('username')->getData()); | ||
}, | ||
); | ||
} |
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
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 add the newline at the end IMO to avoid extra diffs (and associated conflicts) when adding another line in the file