Updated the Best Practices for Symfony 4 and Flex #8599
Merged
Conversation
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
yceruto
reviewed
Nov 7, 2017
best_practices/tests.rst
Outdated
| yield ['/post/fixture-post-1']; | ||
| yield ['/blog/category/fixture-category']; | ||
| yield ['/archives']; | ||
| yield [.]; |
javiereguiluz
changed the title
|
This is now ready for review. Here is the list of added/removed/changed best practices: Added
Removed
Changed-Use the Symfony Installer to create new Symfony-based projects.
+Use Composer and Symfony Flex to create and manage Symfony applications.-Make your controller extend the FrameworkBundle base controller...
+Make your controller extend the ``AbstractController`` base controller...-Store the translation files in the ``app/Resources/translations/`` directory.
+Store the translation files in the ``translations/`` directory at the root of your project.-Store all your application's templates in ``app/Resources/views/`` directory.
+Store the application templates in the ``templates/`` directory at the root of your project.-Define your Twig extensions in the ``AppBundle/Twig/`` directory.
+Define your Twig extensions in the ``src/Twig/`` directory.-Store your assets in the ``public/`` directory.
+Store your assets in the ``assets/`` directory at the root of your project.-Use Assetic to compile, combine and minimize web assets, unless you're
-comfortable with frontend tools like GruntJS.
+Use `Webpack Encore`_ to compile, combine and minimize web assets.-For fine-grained restrictions, define a custom security voter;
-For restricting access to *any* object by *any* user via an admin
-interface, use the Symfony ACL.
+Define a custom security voter to implement fine-grained restrictions. |
yceruto
approved these changes
Nov 8, 2017
fabpot
reviewed
Nov 8, 2017
best_practices/business-logic.rst
Outdated
| :doc:`Service autowiring </service_container/autowiring>` is a feature provided | ||
| by Symfony's Service Container to manage services with minimal configuration. | ||
| It reads the type-hints on your constructor (or other methods) and automatically | ||
| passes you the correct services. It can also add :doc:`service tags </service_container/tags>` |
There was a problem hiding this comment.
It passes the correct services to the methods, not 'you'.
best_practices/business-logic.rst
Outdated
| the class is auto-registered as a service. | ||
| If you're using the :ref:`default services.yaml configuration <service-container-services-load-example>`, | ||
| this class is auto-registered as a service whose ID is ``App\Utils\Slugger`` (or | ||
| simply ``Slugger::class`` if the class is already imported in your code). | ||
|
|
||
| Traditionally, the naming convention for a service was a short, but unique | ||
| snake case key - e.g. ``app.utils.slugger``. But for most services, you should now |
| Use Composer and Symfony Flex to create and manage Symfony applications. | ||
|
|
||
| `Composer`_ is the package manager used by modern PHP application to manage their | ||
| dependencies. `Symfony Flex`_ is a Composer plugin designed to automatize some |
| `public checksums repository`_ and follow `these steps`_ to verify the | ||
| signatures. | ||
| The technical requirements to run Symfony are simple. If you want to check | ||
| if your system meets those requirements, read :doc:`/reference/requirements`. |
There was a problem hiding this comment.
What about recommending using the req-checker for that?
There was a problem hiding this comment.
Agree! The linked article (https://symfony.com/doc/master/reference/requirements.html) was revamped recently to remove everything and just explain how to use req-checker.
weaverryan
added a commit
that referenced
this pull request
Nov 10, 2017
This PR was merged into the 3.3 branch. Discussion ---------- Minor reword in autowiring introduction I used this in the reword of the Best Practices docs and Fabien [added this comment](#8599 (comment)) because he didn't like a phrase of this paragraph. This PR changes that too here. Commits ------- c84cff8 Minor reword in autowiring introduction
javiereguiluz
force-pushed
the
update_best_practices
branch
from
936bd11 to
335e461
Compare
|
This is huge work Javier. THANK YOU!!! |
weaverryan
added a commit
that referenced
this pull request
Nov 12, 2017
…ereguiluz) This PR was squashed before being merged into the master branch (closes #8599). Discussion ---------- Updated the Best Practices for Symfony 4 and Flex Still WIP. Some controllers have not been reviewed yet. Commits ------- 335e461 Fixed after Fabien's review 68b7a18 Fixed some missing references 9794c0b Updated more contents b997c1e Updated the Best Practices for Symfony 4 and Flex
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Still WIP. Some chapters have not been reviewed yet.