Better explain the mandatory/convention location of some elements #6616
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 |
|---|---|---|
|
|
@@ -115,22 +115,23 @@ them under the ``cache/`` or ``log/`` directory of the host application. Tools | |
| can generate files in the bundle directory structure, but only if the generated | ||
| files are going to be part of the repository. | ||
|
|
||
| The following classes and files have specific emplacements (some are mandatory | ||
| and others are just conventions followed by most developers): | ||
|
|
||
| =============================== ============================= ================ | ||
| Type Directory Mandatory? | ||
| =============================== ============================= ================ | ||
| Commands ``Command/`` Yes | ||
| Controllers ``Controller/`` Yes | ||
|
There was a problem hiding this comment. I've just checked. This is not mandatory. |
||
| Service Container Extensions ``DependencyInjection/`` Yes | ||
| Event Listeners ``EventListener/`` No | ||
| Model classes [1] ``Model/`` No | ||
| Configuration ``Resources/config/`` Yes | ||
|
There was a problem hiding this comment. This is a bit tricky. Apparently Symfony doesn't mandate this dir ... but bundles such as DoctrineBundle assume that |
||
| Web Resources (CSS, JS, images) ``Resources/public/`` Yes | ||
| Translation files ``Resources/translations/`` Yes | ||
| Templates ``Resources/views/`` Yes | ||
|
|
||
| Unit and Functional Tests ``Tests/`` No | ||
| =============================== ============================= ================ | ||
|
|
||
| [1] See :doc:`/cookbook/doctrine/mapping_model_classes` for how to handle the | ||
| mapping with a compiler pass. | ||
|
|
||
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.
technically, not fully (mandatory only for auto-registration, but we have tag-based registration since 2.4)
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.
Yeah, that applies to about 99% of the mandatory elements in this table. That's why I started to dislike documenting these. But I think it'll help if we document the default way for beginners.
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.
I agree (see my comment above).
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.
What if we revert this change and add a short cookbook article explaining how to override all of these locations?
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.
Are we sure it's worth it? How often do you need to do that? And if you have the need, won't you probably experienced enough to figure that out yourself?
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.
I don't think it's that easy. For example: how do you put the translations in
<your-bundle>/translations/*instead of<your-bundle>/Resources/translations/or the templates in<your-bundle>/templates/*instead of<your-bundle>/Resources/views/*?