-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
Added a new best practices for custom form field types #5093
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 1 commit
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 |
---|---|---|
|
@@ -207,3 +207,21 @@ Second, we recommend using ``$form->isSubmitted()`` in the ``if`` statement | |
for clarity. This isn't technically needed, since ``isValid()`` first calls | ||
``isSubmitted()``. But without this, the flow doesn't read well as it *looks* | ||
like the form is *always* processed (even on the GET request). | ||
|
||
Custom Form Field Types | ||
----------------------- | ||
|
||
.. best-practice:: | ||
|
||
Add the ``app.`` prefix to your custom form field types to avoid collisions. | ||
|
||
Custom form field types extend from the ``AbstractType`` class, which defines the | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "extend the" or "inherit from" I guess. |
||
``getName()`` method to configure the name of that form type. These names must | ||
be unique in the application. | ||
|
||
If a custom form type uses the same name as any of the Symfony's built-in form | ||
types, it will override it. The same happens when the custom form type matches | ||
any of the types defined by the third-party bundles installed in you application. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. your |
||
|
||
Add the ``app.`` prefix to your custom form field types to avoid name collisions | ||
that can lead to hard to debug errors. |
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.
dots are forbidden in type names, so your suggestion is really bad. Recommend
app_
instead.for reference, type names are validated as
/^[a-z0-9_]*$/i